{"openapi":"3.1.0","jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","info":{"title":"ShopFast API","version":"1.0.0","description":"The ShopFast REST API. Server-to-server calls use `Authorization: Bearer sk_…` with a key from Settings → Developers (or an OAuth access token, `sfo_…`). A key belongs to one store, so store endpoints live under /v1/store/… and the store comes from the key; each also has an explicit form under /v1/stores/{storeId}/… (`x-store-explicit-path`), which dashboard sessions use. Each key reaches only its own store and the areas in its scopes (`x-api-key-scope`), and acts as the teammate who created it. Errors are RFC 9457 problem documents."},"servers":[{"url":"https://api.shopfa.st"}],"tags":[{"name":"abuse-reports"},{"name":"access"},{"name":"admin abuse-reports"},{"name":"admin activity"},{"name":"admin admins"},{"name":"admin ai-usage"},{"name":"admin announcements"},{"name":"admin audit"},{"name":"admin auth"},{"name":"admin auto-renew"},{"name":"admin blog"},{"name":"admin community"},{"name":"admin desk"},{"name":"admin domains"},{"name":"admin economy"},{"name":"admin errors"},{"name":"admin feature-flags"},{"name":"admin fraud"},{"name":"admin gateway-health"},{"name":"admin gateways"},{"name":"admin impersonations"},{"name":"admin invites"},{"name":"admin me"},{"name":"admin overview"},{"name":"admin payment-limits"},{"name":"admin payouts"},{"name":"admin plan-invoices"},{"name":"admin plan-vouchers"},{"name":"admin plans"},{"name":"admin schedules"},{"name":"admin settings"},{"name":"admin shopfast-pay"},{"name":"admin step-up"},{"name":"admin stores"},{"name":"admin support"},{"name":"admin tax-reviews"},{"name":"admin template-developers"},{"name":"admin template-events"},{"name":"admin template-invites"},{"name":"admin template-order"},{"name":"admin template-releases"},{"name":"admin template-team"},{"name":"admin templates"},{"name":"admin users"},{"name":"admin view-sessions"},{"name":"affiliate-program"},{"name":"affiliates"},{"name":"ai"},{"name":"ai-builder"},{"name":"ai-credits"},{"name":"ai-data"},{"name":"ai-usage"},{"name":"analytics"},{"name":"announcements"},{"name":"api-keys"},{"name":"apps"},{"name":"assistant"},{"name":"audit-log"},{"name":"auth"},{"name":"balance"},{"name":"billing"},{"name":"broadcasts"},{"name":"bundles"},{"name":"categories"},{"name":"chargeback-shield"},{"name":"checkout"},{"name":"checkout-boost"},{"name":"checkouts"},{"name":"client-errors"},{"name":"collections"},{"name":"community"},{"name":"crypto"},{"name":"customers"},{"name":"dev"},{"name":"discord"},{"name":"discount-stacking"},{"name":"discounts"},{"name":"dispute-settings"},{"name":"disputes"},{"name":"domains"},{"name":"email-versions"},{"name":"emails"},{"name":"embeds"},{"name":"fees"},{"name":"financials"},{"name":"fraud"},{"name":"gateways"},{"name":"gift-cards"},{"name":"gift-code-reviews"},{"name":"headless"},{"name":"imports"},{"name":"inventory"},{"name":"invites"},{"name":"invoice-exports"},{"name":"invoices"},{"name":"invoicing"},{"name":"leak-trace"},{"name":"licenses"},{"name":"mail"},{"name":"marketing"},{"name":"me"},{"name":"media"},{"name":"notifications"},{"name":"oauth"},{"name":"oauth-apps"},{"name":"oauth-connections"},{"name":"offers"},{"name":"onboarding"},{"name":"openapi.json"},{"name":"orders"},{"name":"pages"},{"name":"payment-model"},{"name":"payments"},{"name":"payout-wallet"},{"name":"payouts"},{"name":"pending-actions"},{"name":"plan"},{"name":"plan-vouchers"},{"name":"plugins"},{"name":"popups"},{"name":"prices-include-tax"},{"name":"product-presets"},{"name":"product-slugs"},{"name":"product-statuses"},{"name":"products"},{"name":"promotions"},{"name":"push"},{"name":"referrals"},{"name":"refunds"},{"name":"replacements"},{"name":"rescue-imports"},{"name":"resell-partners"},{"name":"reseller-orders"},{"name":"reseller-program"},{"name":"reseller-tiers"},{"name":"resellers"},{"name":"review-settings"},{"name":"reviews"},{"name":"sales-pauses"},{"name":"sandbox"},{"name":"search"},{"name":"security"},{"name":"seo"},{"name":"settings"},{"name":"shopfast-invoices"},{"name":"statements"},{"name":"status"},{"name":"status-components"},{"name":"status-incidents"},{"name":"status-labels"},{"name":"status-pages"},{"name":"status-subscribers"},{"name":"stock-themes"},{"name":"store"},{"name":"store-reviews"},{"name":"storefront"},{"name":"stores"},{"name":"studio"},{"name":"subscriptions"},{"name":"support"},{"name":"team"},{"name":"telegram"},{"name":"telegram-access"},{"name":"templates"},{"name":"test-sale"},{"name":"theme-drafts"},{"name":"theme-imports"},{"name":"themes"},{"name":"tutorials"},{"name":"uploads"},{"name":"webhooks"},{"name":"wholesale"}],"paths":{"/v1/auth/signup":{"post":{"operationId":"signup","summary":"Create an account and its first store","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"password":{"type":"string","minLength":10,"maxLength":200},"storeName":{"type":"string","minLength":1,"maxLength":80},"storeHandle":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},"currency":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"timezone":{"default":null,"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"category":{"default":null,"anyOf":[{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]},{"type":"null"}]}},"required":["name","email","password","storeName","storeHandle","currency","country"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/login":{"post":{"operationId":"login","summary":"Sign in; sets the session cookie","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"password":{"type":"string","minLength":1,"maxLength":200}},"required":["email","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/logout":{"post":{"operationId":"logout","summary":"End the session","tags":["auth"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me":{"get":{"operationId":"me","summary":"Current user and their stores","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store":{"get":{"operationId":"getStore","summary":"Store settings","tags":["store"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}.","x-store-explicit-path":"/v1/stores/{storeId}"},"patch":{"operationId":"updateStore","summary":"Update store settings","tags":["store"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"tagline":{"type":"string","maxLength":160},"supportEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"category":{"anyOf":[{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}.","x-store-explicit-path":"/v1/stores/{storeId}"}},"/v1/stores/{storeId}":{"get":{"operationId":"getStoreWithStoreId","summary":"Store settings","tags":["store"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:read","description":"The explicit form of GET /v1/store, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store"},"patch":{"operationId":"updateStoreWithStoreId","summary":"Update store settings","tags":["store"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"tagline":{"type":"string","maxLength":160},"supportEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"category":{"anyOf":[{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:write","description":"The explicit form of PATCH /v1/store, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store"}},"/v1/store/onboarding":{"get":{"operationId":"getOnboarding","summary":"Get started checklist","tags":["onboarding"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/onboarding.","x-store-explicit-path":"/v1/stores/{storeId}/onboarding"}},"/v1/stores/{storeId}/onboarding":{"get":{"operationId":"getOnboardingWithStoreId","summary":"Get started checklist","tags":["onboarding"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:read","description":"The explicit form of GET /v1/store/onboarding, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/onboarding"}},"/v1/store/fees":{"get":{"operationId":"getStoreFees","summary":"The store's plan, effective fees after any override, settlement rules and processor estimate (set by ShopFast)","tags":["fees"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFees"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/fees.","x-store-explicit-path":"/v1/stores/{storeId}/fees"}},"/v1/stores/{storeId}/fees":{"get":{"operationId":"getStoreFeesWithStoreId","summary":"The store's plan, effective fees after any override, settlement rules and processor estimate (set by ShopFast)","tags":["fees"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFees"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:read","description":"The explicit form of GET /v1/store/fees, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/fees"}},"/v1/store/payment-model":{"put":{"operationId":"setPaymentModel","summary":"Choose merchant of record or own gateway (must be allowed by the plan)","tags":["payment-model"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paymentModel":{"type":"string","enum":["merchant_of_record","seller_gateway"]}},"required":["paymentModel"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/payment-model.","x-store-explicit-path":"/v1/stores/{storeId}/payment-model"}},"/v1/stores/{storeId}/payment-model":{"put":{"operationId":"setPaymentModelWithStoreId","summary":"Choose merchant of record or own gateway (must be allowed by the plan)","tags":["payment-model"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paymentModel":{"type":"string","enum":["merchant_of_record","seller_gateway"]}},"required":["paymentModel"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"store:write","description":"The explicit form of PUT /v1/store/payment-model, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payment-model"}},"/v1/stores/{storeId}/prices-include-tax":{"put":{"operationId":"setPricesIncludeTax","summary":"Whether the store's prices include tax under ShopFast Pay (the buyer pays the listed price) or tax is added on top","tags":["prices-include-tax"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pricesIncludeTax":{"type":"boolean"}},"required":["pricesIncludeTax"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFees"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/products":{"get":{"operationId":"listProducts","summary":"Products with tab counts","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","draft","archived","low_stock","files","keys_and_serials","memberships","services","bundles"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"type","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},{"type":"null"}]}},{"name":"ids","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":2000,"pattern":"^[a-z0-9_,]*$"},{"type":"null"}]}},{"name":"category","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"collection","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","name","type","price","stock","sold","revenue","status","updated","manual"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products.","x-store-explicit-path":"/v1/stores/{storeId}/products"},"post":{"operationId":"createProduct","summary":"Create a product","tags":["products"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"type":"string","maxLength":5000},"delivers":{"type":"string","maxLength":200},"status":{"type":"string","enum":["active","draft","archived"]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","type","priceMinor","compareAtMinor","description","delivers","status","lowStockThreshold"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products.","x-store-explicit-path":"/v1/stores/{storeId}/products"}},"/v1/stores/{storeId}/products":{"get":{"operationId":"listProductsWithStoreId","summary":"Products with tab counts","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","draft","archived","low_stock","files","keys_and_serials","memberships","services","bundles"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"type","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},{"type":"null"}]}},{"name":"ids","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":2000,"pattern":"^[a-z0-9_,]*$"},{"type":"null"}]}},{"name":"category","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"collection","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","name","type","price","stock","sold","revenue","status","updated","manual"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products"},"post":{"operationId":"createProductWithStoreId","summary":"Create a product","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"type":"string","maxLength":5000},"delivers":{"type":"string","maxLength":200},"status":{"type":"string","enum":["active","draft","archived"]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","type","priceMinor","compareAtMinor","description","delivers","status","lowStockThreshold"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products"}},"/v1/store/products/{productId}":{"get":{"operationId":"getProduct","summary":"One product","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}"},"patch":{"operationId":"updateProduct","summary":"Update a product","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"type":"string","maxLength":5000},"delivers":{"type":"string","maxLength":200},"status":{"type":"string","enum":["active","draft","archived"]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":9007199254740991}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/products/{productId}.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}"},"delete":{"operationId":"deleteProduct","summary":"Delete a product (soft: orders keep it, it can be restored, its slug is freed)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/products/{productId}.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}"}},"/v1/stores/{storeId}/products/{productId}":{"get":{"operationId":"getProductWithStoreId","summary":"One product","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}"},"patch":{"operationId":"updateProductWithStoreId","summary":"Update a product","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"type":"string","maxLength":5000},"delivers":{"type":"string","maxLength":200},"status":{"type":"string","enum":["active","draft","archived"]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":9007199254740991}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of PATCH /v1/store/products/{productId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}"},"delete":{"operationId":"deleteProductWithStoreId","summary":"Delete a product (soft: orders keep it, it can be restored, its slug is freed)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of DELETE /v1/store/products/{productId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}"}},"/v1/store/products/{productId}/keys":{"post":{"operationId":"addLicenseKeys","summary":"Add license keys or serials to a product pool (duplicates are skipped)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["keys"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddLicenseKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/keys.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/keys"},"get":{"operationId":"listKeys","summary":"Keys in the pool, with who each assigned key went to","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["available","assigned","all"]}},{"name":"variantId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"added","type":"string","enum":["added","option","status","order"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/keys.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/keys"}},"/v1/stores/{storeId}/products/{productId}/keys":{"post":{"operationId":"addLicenseKeysWithStoreId","summary":"Add license keys or serials to a product pool (duplicates are skipped)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["keys"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddLicenseKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/keys, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/keys"},"get":{"operationId":"listKeysWithStoreId","summary":"Keys in the pool, with who each assigned key went to","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["available","assigned","all"]}},{"name":"variantId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"added","type":"string","enum":["added","option","status","order"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/keys, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/keys"}},"/v1/store/orders":{"get":{"operationId":"listOrders","summary":"Orders with tab counts","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","pending","paid","fulfilled","refunded","disputed","failed","partially_refunded"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"method","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},{"type":"null"}]}},{"name":"provider","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},{"type":"null"}]}},{"name":"statuses","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200,"pattern":"^[a-z_]+(?:,[a-z_]+)*$"},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"minTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"maxTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"discordId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},{"name":"key","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},{"name":"paymentId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","number","customer","product","amount","method","country","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrdersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/orders.","x-store-explicit-path":"/v1/stores/{storeId}/orders"}},"/v1/stores/{storeId}/orders":{"get":{"operationId":"listOrdersWithStoreId","summary":"Orders with tab counts","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","pending","paid","fulfilled","refunded","disputed","failed","partially_refunded"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"method","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},{"type":"null"}]}},{"name":"provider","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},{"type":"null"}]}},{"name":"statuses","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200,"pattern":"^[a-z_]+(?:,[a-z_]+)*$"},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"minTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"maxTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"discordId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},{"name":"key","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},{"name":"paymentId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","number","customer","product","amount","method","country","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrdersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/orders, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders"}},"/v1/store/orders/{orderId}":{"get":{"operationId":"getOrder","summary":"Order with fee breakdown and fulfillment timeline","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/orders/{orderId}.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}"}},"/v1/stores/{storeId}/orders/{orderId}":{"get":{"operationId":"getOrderWithStoreId","summary":"Order with fee breakdown and fulfillment timeline","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/orders/{orderId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}"}},"/v1/store/orders/{orderId}/refund":{"post":{"operationId":"refundOrder","summary":"Refund in full","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/refund.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/refund"}},"/v1/stores/{storeId}/orders/{orderId}/refund":{"post":{"operationId":"refundOrderWithStoreId","summary":"Refund in full","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/refund, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/refund"}},"/v1/store/analytics":{"get":{"operationId":"getAnalytics","summary":"KPIs, daily series, top products, methods, countries, funnel","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics.","x-store-explicit-path":"/v1/stores/{storeId}/analytics"}},"/v1/stores/{storeId}/analytics":{"get":{"operationId":"getAnalyticsWithStoreId","summary":"KPIs, daily series, top products, methods, countries, funnel","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics"}},"/v1/store/balance":{"get":{"operationId":"getBalance","summary":"Available, pending, reserve and payouts","tags":["balance"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"balance:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/balance.","x-store-explicit-path":"/v1/stores/{storeId}/balance"}},"/v1/stores/{storeId}/balance":{"get":{"operationId":"getBalanceWithStoreId","summary":"Available, pending, reserve and payouts","tags":["balance"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"balance:read","description":"The explicit form of GET /v1/store/balance, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/balance"}},"/v1/store/gateways":{"get":{"operationId":"listGateways","summary":"Seller's own connected gateways","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGatewaysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"payments:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/gateways.","x-store-explicit-path":"/v1/stores/{storeId}/gateways"},"post":{"operationId":"connectGateway","summary":"Connect an own gateway (sandbox connects instantly; real providers return an onboarding URL). Calling it again resumes onboarding or picks up a finished one. Provider shopfast_pay sets up the account ShopFast pays merchant-of-record payouts to. A store set to ShopFast Pay that ShopFast Pay cannot serve moves to its own gateways once the connection can take payments.","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}},"required":["provider"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectGatewayResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gateways.","x-store-explicit-path":"/v1/stores/{storeId}/gateways"}},"/v1/stores/{storeId}/gateways":{"get":{"operationId":"listGatewaysWithStoreId","summary":"Seller's own connected gateways","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGatewaysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"payments:read","description":"The explicit form of GET /v1/store/gateways, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways"},"post":{"operationId":"connectGatewayWithStoreId","summary":"Connect an own gateway (sandbox connects instantly; real providers return an onboarding URL). Calling it again resumes onboarding or picks up a finished one. Provider shopfast_pay sets up the account ShopFast pays merchant-of-record payouts to. A store set to ShopFast Pay that ShopFast Pay cannot serve moves to its own gateways once the connection can take payments.","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}},"required":["provider"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectGatewayResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/gateways, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways"}},"/v1/stores/{storeId}/checkout":{"post":{"operationId":"createCheckout","summary":"Start a checkout for a buyer (paid checkouts for buyers in the EU, the EEA and the UK need withdrawalWaiver: true, else 422)","tags":["checkout"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"quantity":{"type":"integer","minimum":1,"maximum":100},"variantId":{"default":null,"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"amountMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["productId","quantity"]}},"buyerEmail":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"buyerName":{"type":"string","minLength":1,"maxLength":120},"buyerCountry":{"type":"string","pattern":"^[A-Z]{2}$"},"withdrawalWaiver":{"default":false,"description":"Required (true) for a paid checkout whose buyerCountry is in the EU, the EEA or the UK, else 422 on this field. Collect the buyer's express consent and acknowledgement first: show \"Deliver my order right away. I understand that I lose my 14-day right to cancel once delivery has started.\" with an unticked box and send true only once they tick it.","type":"boolean"}},"required":["items","buyerEmail","buyerName","buyerCountry"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSession"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/sandbox/checkout/{sessionId}/pay":{"post":{"operationId":"sandboxPay","summary":"Sandbox gateway: approve the payment and send the signed webhook (dev and test sales only)","tags":["sandbox"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto"]},"testCard":{"default":"success","type":"string","enum":["success","declined","authentication_required","expired_card"]}},"required":["method"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxPayResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/test-sale":{"post":{"operationId":"simulateTestSale","summary":"Get started: run a full test order through checkout, webhook, fulfillment and ledger","tags":["test-sale"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/test-sale.","x-store-explicit-path":"/v1/stores/{storeId}/test-sale"}},"/v1/stores/{storeId}/test-sale":{"post":{"operationId":"simulateTestSaleWithStoreId","summary":"Get started: run a full test order through checkout, webhook, fulfillment and ledger","tags":["test-sale"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/test-sale, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/test-sale"}},"/v1/admin/auth/login":{"post":{"operationId":"adminLogin","summary":"Platform admin sign in (separate session)","tags":["admin auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"password":{"type":"string","minLength":1,"maxLength":200}},"required":["email","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLoginResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/auth/logout":{"post":{"operationId":"adminLogout","summary":"End the admin session","tags":["admin auth"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/me":{"get":{"operationId":"adminMe","summary":"Current admin","tags":["admin me"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMeResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/overview":{"get":{"operationId":"adminOverview","summary":"GMV, platform revenue, tax, pending payouts","tags":["admin overview"],"security":[{"adminSession":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/plans":{"get":{"operationId":"adminListPlans","summary":"Plans and their fee schedules","tags":["admin plans"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListPlansResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"adminCreatePlan","summary":"Create a plan","tags":["admin plans"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"monthlyPriceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"fees":{"type":"object","properties":{"commissionBps":{"type":"integer","minimum":0,"maximum":10000},"fixedFeeMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"morSurchargeBps":{"type":"integer","minimum":0,"maximum":10000},"payoutFeeMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["commissionBps","fixedFeeMinor","morSurchargeBps","payoutFeeMinor"]},"isDefault":{"type":"boolean"},"allowedModels":{"minItems":1,"type":"array","items":{"type":"string","enum":["merchant_of_record","seller_gateway"]}},"selectable":{"type":"boolean"},"mediaQuota":{"type":"object","properties":{"storageBytes":{"type":"integer","minimum":0,"maximum":10995116277760},"fileCount":{"type":"integer","minimum":0,"maximum":10000000},"maxFileBytes":{"type":"integer","minimum":1,"maximum":2147483647}},"required":["storageBytes","fileCount","maxFileBytes"]},"limits":{"type":"object","properties":{"products":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"ordersPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000000},{"type":"null"}]},"teamMembers":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"customDomains":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000},{"type":"null"}]},"removeBranding":{"type":"boolean"},"developerTools":{"type":"boolean"},"themeCode":{"type":"boolean"},"shopfastPay":{"type":"boolean"},"addOns":{"maxItems":3,"type":"array","items":{"type":"string","enum":["licensing","email_marketing","leak_tracer"]}}},"required":["products","ordersPerMonth","teamMembers","customDomains","removeBranding","developerTools","themeCode","shopfastPay","addOns"]},"trialDays":{"type":"integer","minimum":0,"maximum":365}},"required":["name","monthlyPriceMinor","currency","fees","isDefault","allowedModels"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/plans/{planId}":{"put":{"operationId":"adminUpdatePlan","summary":"Update a plan. New fees apply to new orders only.","tags":["admin plans"],"security":[{"adminSession":[]}],"parameters":[{"name":"planId","in":"path","required":true,"schema":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"monthlyPriceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"fees":{"type":"object","properties":{"commissionBps":{"type":"integer","minimum":0,"maximum":10000},"fixedFeeMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"morSurchargeBps":{"type":"integer","minimum":0,"maximum":10000},"payoutFeeMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["commissionBps","fixedFeeMinor","morSurchargeBps","payoutFeeMinor"]},"isDefault":{"type":"boolean"},"allowedModels":{"minItems":1,"type":"array","items":{"type":"string","enum":["merchant_of_record","seller_gateway"]}},"selectable":{"type":"boolean"},"mediaQuota":{"type":"object","properties":{"storageBytes":{"type":"integer","minimum":0,"maximum":10995116277760},"fileCount":{"type":"integer","minimum":0,"maximum":10000000},"maxFileBytes":{"type":"integer","minimum":1,"maximum":2147483647}},"required":["storageBytes","fileCount","maxFileBytes"]},"limits":{"type":"object","properties":{"products":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"ordersPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000000},{"type":"null"}]},"teamMembers":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"customDomains":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000},{"type":"null"}]},"removeBranding":{"type":"boolean"},"developerTools":{"type":"boolean"},"themeCode":{"type":"boolean"},"shopfastPay":{"type":"boolean"},"addOns":{"maxItems":3,"type":"array","items":{"type":"string","enum":["licensing","email_marketing","leak_tracer"]}}},"required":["products","ordersPerMonth","teamMembers","customDomains","removeBranding","developerTools","themeCode","shopfastPay","addOns"]},"trialDays":{"type":"integer","minimum":0,"maximum":365}},"required":["name","monthlyPriceMinor","currency","fees","isDefault","allowedModels"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores":{"get":{"operationId":"adminListStores","summary":"All stores with volume and platform revenue, sorted and filtered on the server","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["active","suspended"]},{"type":"null"}]}},{"name":"model","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["merchant_of_record","seller_gateway"]},{"type":"null"}]}},{"name":"override","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"planId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"trial","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["store","owner","plan","model","products","gmv","rev","orders","status","created","trial"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListStoresResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}":{"get":{"operationId":"adminGetStore","summary":"Store with plan, override, effective fees and balance","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStoreDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/plan":{"put":{"operationId":"adminSetStorePlan","summary":"Move a store to another plan; a paid plan is either complimentary (a reason, an optional end date) or billed to the seller","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planId":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},"mode":{"default":null,"anyOf":[{"type":"string","enum":["comp","bill"]},{"type":"null"}]},"reason":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"endsOn":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},"required":["planId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStoreDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/fee-override":{"put":{"operationId":"adminSetStoreOverride","summary":"Set or clear (all null) a per-store fee override","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"override":{"type":"object","properties":{"commissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"fixedFeeMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"morSurchargeBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"payoutFeeMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["commissionBps","fixedFeeMinor","morSurchargeBps","payoutFeeMinor"]},"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["override","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSetStoreOverrideResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/status":{"put":{"operationId":"adminSetStoreStatus","summary":"Suspend or reactivate a store","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","suspended"]},"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["status","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStoreDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/gateways":{"get":{"operationId":"adminListGateways","summary":"Platform gateway configuration and whether each mode can take payments","tags":["admin gateways"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListGatewaysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/gateways/{provider}":{"put":{"operationId":"adminUpdateGateway","summary":"Enable/disable a provider for MoR or for sellers","tags":["admin gateways"],"security":[{"adminSession":[]}],"parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string"},"enabledForMor":{"type":"boolean"},"enabledForSellers":{"type":"boolean"},"mode":{"type":"string","enum":["test","live"]},"methods":{"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"estimatedFeeBps":{"type":"integer","minimum":0,"maximum":10000},"estimatedFixedMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["displayName","enabledForMor","enabledForSellers","mode","methods","estimatedFeeBps","estimatedFixedMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformGateway"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/settings":{"get":{"operationId":"adminGetSettings","summary":"Settlement rules and tax rates","tags":["admin settings"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"adminUpdateSettings","summary":"Update settlement rules and tax rates","tags":["admin settings"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"settlement":{"type":"object","properties":{"holdDays":{"type":"integer","minimum":0,"maximum":90},"payoutSchedule":{"type":"string","enum":["daily","weekly","monthly"]},"payoutWeekday":{"type":"integer","minimum":0,"maximum":6},"payoutMinimumMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"reserveBps":{"type":"integer","minimum":0,"maximum":10000},"reserveDays":{"type":"integer","minimum":0,"maximum":180},"highRiskHoldDays":{"default":14,"type":"integer","minimum":0,"maximum":90},"highRiskScore":{"default":70,"type":"integer","minimum":1,"maximum":100}},"required":["holdDays","payoutSchedule","payoutWeekday","payoutMinimumMinor","reserveBps","reserveDays"]},"taxRates":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"rateBps":{"type":"integer","minimum":0,"maximum":10000},"label":{"type":"string","maxLength":40}},"required":["country","rateBps","label"]}},"ebookTaxRates":{"default":[],"type":"array","items":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"rateBps":{"type":"integer","minimum":0,"maximum":10000},"label":{"type":"string","maxLength":40}},"required":["country","rateBps","label"]}},"defaultCurrency":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"referrals":{"default":{"enabled":true,"shareBps":2000,"months":12,"holdDays":30,"linkDays":60},"type":"object","properties":{"enabled":{"type":"boolean"},"shareBps":{"type":"integer","minimum":0,"maximum":5000},"months":{"type":"integer","minimum":1,"maximum":60},"holdDays":{"type":"integer","minimum":0,"maximum":120},"linkDays":{"type":"integer","minimum":1,"maximum":365}},"required":["enabled","shareBps","months","holdDays","linkDays"]}},"required":["settlement","taxRates","defaultCurrency"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/payouts":{"get":{"operationId":"adminListPayouts","summary":"Seller payouts across the platform","tags":["admin payouts"],"security":[{"adminSession":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["scheduled","processing","paid","failed"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"rail","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["usdt_tron","usdt_bsc","usdt_ethereum","usdt_solana","usdc_base","usdc_polygon","usdc_solana","btc","ltc","eth"]},{"type":"null"}]}},{"name":"origin","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["schedule","seller","admin"]},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["store","amount","wallet","status","created"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListPayoutsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/payouts/run":{"post":{"operationId":"adminRunPayouts","summary":"Create payouts for every MoR store whose available balance meets the minimum (sent by transfer when ShopFast Pay runs on Stripe)","tags":["admin payouts"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRunPayoutsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/payouts/{payoutId}":{"put":{"operationId":"adminMarkPayout","summary":"Mark a payout paid or failed","tags":["admin payouts"],"security":[{"adminSession":[]}],"parameters":[{"name":"payoutId","in":"path","required":true,"schema":{"type":"string","pattern":"^po_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["processing","paid","failed"]},"reason":{"default":null,"anyOf":[{"type":"string","minLength":3,"maxLength":500},{"type":"null"}]},"txHash":{"default":null,"anyOf":[{"type":"string","minLength":8,"maxLength":200},{"type":"null"}]}},"required":["status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPayoutRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/themes":{"get":{"operationId":"listThemes","summary":"Installed themes, the stock theme library and which version is live","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes.","x-store-explicit-path":"/v1/stores/{storeId}/themes"},"post":{"operationId":"installTheme","summary":"Install a stock theme (with a style) or duplicate an installed one, unpublished","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stockId":{"type":"string","maxLength":40},"preset":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":60},"duplicateOf":{"anyOf":[{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["stockId","preset","name","duplicateOf"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes.","x-store-explicit-path":"/v1/stores/{storeId}/themes"}},"/v1/stores/{storeId}/themes":{"get":{"operationId":"listThemesWithStoreId","summary":"Installed themes, the stock theme library and which version is live","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes"},"post":{"operationId":"installThemeWithStoreId","summary":"Install a stock theme (with a style) or duplicate an installed one, unpublished","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stockId":{"type":"string","maxLength":40},"preset":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":60},"duplicateOf":{"anyOf":[{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["stockId","preset","name","duplicateOf"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes"}},"/v1/store/themes/{themeId}":{"get":{"operationId":"getTheme","summary":"The draft: every file, its revision and validation results","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDraft"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}"},"patch":{"operationId":"renameTheme","summary":"Rename a theme","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/themes/{themeId}.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}"},"delete":{"operationId":"deleteTheme","summary":"Delete an unpublished theme","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/themes/{themeId}.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}"}},"/v1/stores/{storeId}/themes/{themeId}":{"get":{"operationId":"getThemeWithStoreId","summary":"The draft: every file, its revision and validation results","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDraft"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}"},"patch":{"operationId":"renameThemeWithStoreId","summary":"Rename a theme","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of PATCH /v1/store/themes/{themeId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}"},"delete":{"operationId":"deleteThemeWithStoreId","summary":"Delete an unpublished theme","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/themes/{themeId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}"}},"/v1/store/themes/{themeId}/ops":{"post":{"operationId":"applyThemeOps","summary":"Apply typed edits to the draft (all or nothing). 409 when baseRevision is not the current revision","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"ops":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"op":{"type":"string","const":"set_section_setting"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"value":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"required":["op","file","section","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"set_block_setting"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"value":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"required":["op","file","section","block","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"add_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]},"preset":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}}},"required":["op","file","type","position"]},{"type":"object","properties":{"op":{"type":"string","const":"remove_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["op","file","section"]},{"type":"object","properties":{"op":{"type":"string","const":"move_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]}},"required":["op","file","section","position"]},{"type":"object","properties":{"op":{"type":"string","const":"duplicate_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]}},"required":["op","file","section"]},{"type":"object","properties":{"op":{"type":"string","const":"set_section_disabled"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"disabled":{"type":"boolean"}},"required":["op","file","section","disabled"]},{"type":"object","properties":{"op":{"type":"string","const":"add_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}}},"required":["op","file","section","type","position"]},{"type":"object","properties":{"op":{"type":"string","const":"remove_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["op","file","section","block"]},{"type":"object","properties":{"op":{"type":"string","const":"move_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]}},"required":["op","file","section","block","position"]},{"type":"object","properties":{"op":{"type":"string","const":"set_block_disabled"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"disabled":{"type":"boolean"}},"required":["op","file","section","block","disabled"]},{"type":"object","properties":{"op":{"type":"string","const":"duplicate_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]}},"required":["op","file","section","block"]},{"type":"object","properties":{"op":{"type":"string","const":"insert_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]},"section":{"type":"object","properties":{"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"disabled":{"default":false,"type":"boolean"},"blocks":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"disabled":{"default":false,"type":"boolean"}},"required":["type"]}}},"required":["type"]}},"required":["op","file","position","section"]},{"type":"object","properties":{"op":{"type":"string","const":"set_theme_setting"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"value":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"required":["op","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"apply_style_preset"},"preset":{"type":"string","minLength":1,"maxLength":60}},"required":["op","preset"]},{"type":"object","properties":{"op":{"type":"string","const":"set_translation"},"locale":{"type":"string","pattern":"^[a-z]{2}(?:-[A-Z]{2})?$"},"key":{"type":"string","pattern":"^[a-z0-9_]{1,60}(?:\\.[a-z0-9_]{1,60}){0,4}$"},"value":{"type":"string","maxLength":2000}},"required":["op","locale","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"write_file"},"path":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"},"content":{"type":"string","maxLength":300000}},"required":["op","path","content"]},{"type":"object","properties":{"op":{"type":"string","const":"delete_file"},"path":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"}},"required":["op","path"]}]}},"author":{"type":"string","enum":["seller","ai","code"]},"summary":{"type":"string","minLength":1,"maxLength":200},"prompt":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"aiProposalId":{"default":null,"anyOf":[{"type":"string","pattern":"^aipr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["baseRevision","ops","author","summary","prompt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeSaveResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/ops.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/ops"}},"/v1/stores/{storeId}/themes/{themeId}/ops":{"post":{"operationId":"applyThemeOpsWithStoreId","summary":"Apply typed edits to the draft (all or nothing). 409 when baseRevision is not the current revision","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"ops":{"minItems":1,"maxItems":50,"type":"array","items":{"oneOf":[{"type":"object","properties":{"op":{"type":"string","const":"set_section_setting"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"value":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"required":["op","file","section","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"set_block_setting"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"value":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"required":["op","file","section","block","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"add_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]},"preset":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}}},"required":["op","file","type","position"]},{"type":"object","properties":{"op":{"type":"string","const":"remove_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["op","file","section"]},{"type":"object","properties":{"op":{"type":"string","const":"move_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]}},"required":["op","file","section","position"]},{"type":"object","properties":{"op":{"type":"string","const":"duplicate_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]}},"required":["op","file","section"]},{"type":"object","properties":{"op":{"type":"string","const":"set_section_disabled"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"disabled":{"type":"boolean"}},"required":["op","file","section","disabled"]},{"type":"object","properties":{"op":{"type":"string","const":"add_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}}},"required":["op","file","section","type","position"]},{"type":"object","properties":{"op":{"type":"string","const":"remove_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["op","file","section","block"]},{"type":"object","properties":{"op":{"type":"string","const":"move_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]}},"required":["op","file","section","block","position"]},{"type":"object","properties":{"op":{"type":"string","const":"set_block_disabled"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"disabled":{"type":"boolean"}},"required":["op","file","section","block","disabled"]},{"type":"object","properties":{"op":{"type":"string","const":"duplicate_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"block":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]}},"required":["op","file","section","block"]},{"type":"object","properties":{"op":{"type":"string","const":"insert_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"position":{"anyOf":[{"type":"object","properties":{"after":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["after"]},{"type":"object","properties":{"before":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"}},"required":["before"]},{"type":"string","enum":["start","end"]}]},"id":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},{"type":"null"}]},"section":{"type":"object","properties":{"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"disabled":{"default":false,"type":"boolean"},"blocks":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"settings":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"disabled":{"default":false,"type":"boolean"}},"required":["type"]}}},"required":["type"]}},"required":["op","file","position","section"]},{"type":"object","properties":{"op":{"type":"string","const":"set_theme_setting"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"value":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]}},"required":["op","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"apply_style_preset"},"preset":{"type":"string","minLength":1,"maxLength":60}},"required":["op","preset"]},{"type":"object","properties":{"op":{"type":"string","const":"set_translation"},"locale":{"type":"string","pattern":"^[a-z]{2}(?:-[A-Z]{2})?$"},"key":{"type":"string","pattern":"^[a-z0-9_]{1,60}(?:\\.[a-z0-9_]{1,60}){0,4}$"},"value":{"type":"string","maxLength":2000}},"required":["op","locale","key","value"]},{"type":"object","properties":{"op":{"type":"string","const":"write_file"},"path":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"},"content":{"type":"string","maxLength":300000}},"required":["op","path","content"]},{"type":"object","properties":{"op":{"type":"string","const":"delete_file"},"path":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"}},"required":["op","path"]}]}},"author":{"type":"string","enum":["seller","ai","code"]},"summary":{"type":"string","minLength":1,"maxLength":200},"prompt":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"aiProposalId":{"default":null,"anyOf":[{"type":"string","pattern":"^aipr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["baseRevision","ops","author","summary","prompt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeSaveResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/ops, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/ops"}},"/v1/store/themes/{themeId}/publish":{"post":{"operationId":"publishTheme","summary":"Validate strictly, compile CSS, freeze the draft into a version and make the theme live","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"name":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},"required":["baseRevision","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishThemeResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/publish.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/publish"}},"/v1/stores/{storeId}/themes/{themeId}/publish":{"post":{"operationId":"publishThemeWithStoreId","summary":"Validate strictly, compile CSS, freeze the draft into a version and make the theme live","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"name":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},"required":["baseRevision","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishThemeResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/publish, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/publish"}},"/v1/store/themes/{themeId}/discard":{"post":{"operationId":"discardThemeDraft","summary":"Reset the draft to the latest published version","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["baseRevision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDraft"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/discard.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/discard"}},"/v1/stores/{storeId}/themes/{themeId}/discard":{"post":{"operationId":"discardThemeDraftWithStoreId","summary":"Reset the draft to the latest published version","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["baseRevision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDraft"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/discard, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/discard"}},"/v1/store/themes/{themeId}/versions":{"get":{"operationId":"listThemeVersions","summary":"Published versions, newest first","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeVersionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/versions.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/versions"}},"/v1/stores/{storeId}/themes/{themeId}/versions":{"get":{"operationId":"listThemeVersionsWithStoreId","summary":"Published versions, newest first","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeVersionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/versions, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/versions"}},"/v1/store/themes/{themeId}/versions/{versionId}":{"get":{"operationId":"getThemeVersion","summary":"One published version with its files","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThemeVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/versions/{versionId}.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/versions/{versionId}"}},"/v1/stores/{storeId}/themes/{themeId}/versions/{versionId}":{"get":{"operationId":"getThemeVersionWithStoreId","summary":"One published version with its files","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThemeVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/versions/{versionId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/versions/{versionId}"}},"/v1/store/themes/{themeId}/versions/{versionId}/restore":{"post":{"operationId":"restoreThemeVersion","summary":"Roll back: copy a version into the draft, and publish it again when asked","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"publish":{"type":"boolean"}},"required":["baseRevision","publish"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreThemeVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/versions/{versionId}/restore.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/versions/{versionId}/restore"}},"/v1/stores/{storeId}/themes/{themeId}/versions/{versionId}/restore":{"post":{"operationId":"restoreThemeVersionWithStoreId","summary":"Roll back: copy a version into the draft, and publish it again when asked","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"publish":{"type":"boolean"}},"required":["baseRevision","publish"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreThemeVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/versions/{versionId}/restore, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/versions/{versionId}/restore"}},"/v1/store/themes/{themeId}/revisions":{"get":{"operationId":"listThemeRevisions","summary":"Draft history with authors and AI prompts","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeRevisionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/revisions.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/revisions"}},"/v1/stores/{storeId}/themes/{themeId}/revisions":{"get":{"operationId":"listThemeRevisionsWithStoreId","summary":"Draft history with authors and AI prompts","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeRevisionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/revisions, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/revisions"}},"/v1/store/themes/{themeId}/ai":{"post":{"operationId":"proposeThemeEdit","summary":"Ask AI for a change. Returns validated ops to preview; nothing is saved until the seller applies them","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000},"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"template":{"type":"string","maxLength":120},"selection":{"anyOf":[{"type":"object","properties":{"file":{"type":"string","maxLength":120},"section":{"type":"string","maxLength":48},"block":{"anyOf":[{"type":"string","maxLength":48},{"type":"null"}]}},"required":["file","section","block"]},{"type":"null"}]},"mode":{"type":"string","enum":["edit","code"]},"file":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"images":{"default":[],"maxItems":4,"type":"array","items":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["uploadId"]}},"conversationId":{"default":null,"anyOf":[{"type":"string","pattern":"^aicv_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["prompt","baseRevision","template","selection","mode","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAiProposal"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/ai.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/ai"}},"/v1/stores/{storeId}/themes/{themeId}/ai":{"post":{"operationId":"proposeThemeEditWithStoreId","summary":"Ask AI for a change. Returns validated ops to preview; nothing is saved until the seller applies them","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"maxLength":2000},"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"template":{"type":"string","maxLength":120},"selection":{"anyOf":[{"type":"object","properties":{"file":{"type":"string","maxLength":120},"section":{"type":"string","maxLength":48},"block":{"anyOf":[{"type":"string","maxLength":48},{"type":"null"}]}},"required":["file","section","block"]},{"type":"null"}]},"mode":{"type":"string","enum":["edit","code"]},"file":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"images":{"default":[],"maxItems":4,"type":"array","items":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["uploadId"]}},"conversationId":{"default":null,"anyOf":[{"type":"string","pattern":"^aicv_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["prompt","baseRevision","template","selection","mode","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAiProposal"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/ai, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/ai"}},"/v1/store/themes/{themeId}/ai/history":{"get":{"operationId":"themeAiHistory","summary":"Your AI requests for this theme, newest first: what you asked (with images), the answer and what you did with it","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAiHistory"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"ai:write","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/ai/history.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/ai/history"}},"/v1/stores/{storeId}/themes/{themeId}/ai/history":{"get":{"operationId":"themeAiHistoryWithStoreId","summary":"Your AI requests for this theme, newest first: what you asked (with images), the answer and what you did with it","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAiHistory"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"ai:write","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/ai/history, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/ai/history"}},"/v1/store/storefront/preview-data":{"get":{"operationId":"getStorefrontPreviewData","summary":"What the editor previews with: the page it shows plus a sample of the catalog (never all of it), the shop context and the storefront origin","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[{"name":"type","in":"query","required":false,"schema":{"default":"","type":"string","enum":["","product","collection","page"]}},{"name":"handle","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":140}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStorefrontPreviewDataResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/storefront/preview-data.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/preview-data"}},"/v1/stores/{storeId}/storefront/preview-data":{"get":{"operationId":"getStorefrontPreviewDataWithStoreId","summary":"What the editor previews with: the page it shows plus a sample of the catalog (never all of it), the shop context and the storefront origin","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"type","in":"query","required":false,"schema":{"default":"","type":"string","enum":["","product","collection","page"]}},{"name":"handle","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":140}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStorefrontPreviewDataResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/storefront/preview-data, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/preview-data"}},"/v1/store/storefront/preview-data/page":{"post":{"operationId":"getStorefrontPreviewPage","summary":"Page data for the editor preview: products by handle or id and collection slices, from the same source storefront renders read","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handles":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"ids":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"related":{"default":false,"type":"boolean"},"slices":{"default":[],"maxItems":8,"type":"array","items":{"type":"object","properties":{"handle":{"type":"string","minLength":1,"maxLength":140},"source":{"default":"collection","type":"string","enum":["collection","category"]},"sort":{"default":"featured","type":"string","enum":["featured","best-selling","newest","price-ascending","price-descending","title-ascending"]},"offset":{"default":0,"type":"integer","minimum":0,"maximum":10000000},"after":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"limit":{"type":"integer","minimum":1,"maximum":250}},"required":["handle","limit"]}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDataResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/storefront/preview-data/page.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/preview-data/page"}},"/v1/stores/{storeId}/storefront/preview-data/page":{"post":{"operationId":"getStorefrontPreviewPageWithStoreId","summary":"Page data for the editor preview: products by handle or id and collection slices, from the same source storefront renders read","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handles":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"ids":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"related":{"default":false,"type":"boolean"},"slices":{"default":[],"maxItems":8,"type":"array","items":{"type":"object","properties":{"handle":{"type":"string","minLength":1,"maxLength":140},"source":{"default":"collection","type":"string","enum":["collection","category"]},"sort":{"default":"featured","type":"string","enum":["featured","best-selling","newest","price-ascending","price-descending","title-ascending"]},"offset":{"default":0,"type":"integer","minimum":0,"maximum":10000000},"after":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"limit":{"type":"integer","minimum":1,"maximum":250}},"required":["handle","limit"]}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDataResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/storefront/preview-data/page, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/preview-data/page"}},"/v1/store/themes/{themeId}/preview-link":{"post":{"operationId":"createThemePreviewLink","summary":"A signed, expiring link that shows this draft on the real storefront (noindex), opening `path` (the page being edited)","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"default":null,"anyOf":[{"type":"string","maxLength":300,"pattern":"^\\/(?!\\/)[^\\s\\\\]*$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThemePreviewLinkResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/preview-link.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/preview-link"}},"/v1/stores/{storeId}/themes/{themeId}/preview-link":{"post":{"operationId":"createThemePreviewLinkWithStoreId","summary":"A signed, expiring link that shows this draft on the real storefront (noindex), opening `path` (the page being edited)","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"default":null,"anyOf":[{"type":"string","maxLength":300,"pattern":"^\\/(?!\\/)[^\\s\\\\]*$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThemePreviewLinkResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/preview-link, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/preview-link"}},"/v1/store/storefront/feeds":{"get":{"operationId":"getFeedReport","summary":"Product feed URLs and per-product eligibility and issues","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedReportResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/storefront/feeds.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/feeds"}},"/v1/stores/{storeId}/storefront/feeds":{"get":{"operationId":"getFeedReportWithStoreId","summary":"Product feed URLs and per-product eligibility and issues","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedReportResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/storefront/feeds, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/feeds"}},"/v1/store/storefront/newsletter":{"get":{"operationId":"listNewsletterSubscribers","summary":"Emails collected by newsletter sections, newest first","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNewsletterSubscribersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/storefront/newsletter.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/newsletter"}},"/v1/stores/{storeId}/storefront/newsletter":{"get":{"operationId":"listNewsletterSubscribersWithStoreId","summary":"Emails collected by newsletter sections, newest first","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNewsletterSubscribersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/storefront/newsletter, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/newsletter"}},"/v1/store/pages":{"get":{"operationId":"listPages","summary":"Custom pages and policies","tags":["pages"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPagesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/pages.","x-store-explicit-path":"/v1/stores/{storeId}/pages"},"post":{"operationId":"createPage","summary":"Create a page (body is sanitized)","tags":["pages"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"bodyHtml":{"type":"string","maxLength":100000},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]},"published":{"type":"boolean"}},"required":["handle","title","bodyHtml","seoTitle","seoDescription","templateSuffix","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/pages.","x-store-explicit-path":"/v1/stores/{storeId}/pages"}},"/v1/stores/{storeId}/pages":{"get":{"operationId":"listPagesWithStoreId","summary":"Custom pages and policies","tags":["pages"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPagesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/pages, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/pages"},"post":{"operationId":"createPageWithStoreId","summary":"Create a page (body is sanitized)","tags":["pages"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"bodyHtml":{"type":"string","maxLength":100000},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]},"published":{"type":"boolean"}},"required":["handle","title","bodyHtml","seoTitle","seoDescription","templateSuffix","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/pages, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/pages"}},"/v1/store/pages/{pageId}":{"put":{"operationId":"updatePage","summary":"Update a page","tags":["pages"],"security":[{"apiKey":[]}],"parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^pg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"bodyHtml":{"type":"string","maxLength":100000},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]},"published":{"type":"boolean"}},"required":["handle","title","bodyHtml","seoTitle","seoDescription","templateSuffix","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/pages/{pageId}.","x-store-explicit-path":"/v1/stores/{storeId}/pages/{pageId}"},"delete":{"operationId":"deletePage","summary":"Delete a page","tags":["pages"],"security":[{"apiKey":[]}],"parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^pg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/pages/{pageId}.","x-store-explicit-path":"/v1/stores/{storeId}/pages/{pageId}"}},"/v1/stores/{storeId}/pages/{pageId}":{"put":{"operationId":"updatePageWithStoreId","summary":"Update a page","tags":["pages"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^pg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"bodyHtml":{"type":"string","maxLength":100000},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]},"published":{"type":"boolean"}},"required":["handle","title","bodyHtml","seoTitle","seoDescription","templateSuffix","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/pages/{pageId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/pages/{pageId}"},"delete":{"operationId":"deletePageWithStoreId","summary":"Delete a page","tags":["pages"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^pg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/pages/{pageId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/pages/{pageId}"}},"/v1/store/collections":{"get":{"operationId":"listCollections","summary":"Collections in storefront order","tags":["collections"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCollectionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/collections.","x-store-explicit-path":"/v1/stores/{storeId}/collections"},"post":{"operationId":"createCollection","summary":"Create a collection","tags":["collections"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":2000},"productIds":{"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"sort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"published":{"type":"boolean"},"kind":{"default":"manual","type":"string","enum":["manual","automatic"]},"rules":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["type","tag","price","name","pricing_mode","created_days","category"]},"op":{"type":"string","enum":["equals","not_equals","contains","greater_than","less_than"]},"value":{"type":"string","minLength":1,"maxLength":80}},"required":["field","op","value"]}},"match":{"default":"all","type":"string","enum":["all","any"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"seoTitle":{"default":null,"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"default":null,"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["handle","title","description","productIds","sort","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCollection"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/collections.","x-store-explicit-path":"/v1/stores/{storeId}/collections"}},"/v1/stores/{storeId}/collections":{"get":{"operationId":"listCollectionsWithStoreId","summary":"Collections in storefront order","tags":["collections"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCollectionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/collections, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/collections"},"post":{"operationId":"createCollectionWithStoreId","summary":"Create a collection","tags":["collections"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":2000},"productIds":{"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"sort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"published":{"type":"boolean"},"kind":{"default":"manual","type":"string","enum":["manual","automatic"]},"rules":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["type","tag","price","name","pricing_mode","created_days","category"]},"op":{"type":"string","enum":["equals","not_equals","contains","greater_than","less_than"]},"value":{"type":"string","minLength":1,"maxLength":80}},"required":["field","op","value"]}},"match":{"default":"all","type":"string","enum":["all","any"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"seoTitle":{"default":null,"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"default":null,"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["handle","title","description","productIds","sort","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCollection"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/collections, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/collections"}},"/v1/store/collections/{collectionId}":{"put":{"operationId":"updateCollection","summary":"Update a collection","tags":["collections"],"security":[{"apiKey":[]}],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":2000},"productIds":{"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"sort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"published":{"type":"boolean"},"kind":{"default":"manual","type":"string","enum":["manual","automatic"]},"rules":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["type","tag","price","name","pricing_mode","created_days","category"]},"op":{"type":"string","enum":["equals","not_equals","contains","greater_than","less_than"]},"value":{"type":"string","minLength":1,"maxLength":80}},"required":["field","op","value"]}},"match":{"default":"all","type":"string","enum":["all","any"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"seoTitle":{"default":null,"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"default":null,"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["handle","title","description","productIds","sort","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCollection"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/collections/{collectionId}.","x-store-explicit-path":"/v1/stores/{storeId}/collections/{collectionId}"},"delete":{"operationId":"deleteCollection","summary":"Delete a collection","tags":["collections"],"security":[{"apiKey":[]}],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/collections/{collectionId}.","x-store-explicit-path":"/v1/stores/{storeId}/collections/{collectionId}"}},"/v1/stores/{storeId}/collections/{collectionId}":{"put":{"operationId":"updateCollectionWithStoreId","summary":"Update a collection","tags":["collections"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"collectionId","in":"path","required":true,"schema":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"title":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":2000},"productIds":{"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"sort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"published":{"type":"boolean"},"kind":{"default":"manual","type":"string","enum":["manual","automatic"]},"rules":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["type","tag","price","name","pricing_mode","created_days","category"]},"op":{"type":"string","enum":["equals","not_equals","contains","greater_than","less_than"]},"value":{"type":"string","minLength":1,"maxLength":80}},"required":["field","op","value"]}},"match":{"default":"all","type":"string","enum":["all","any"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"seoTitle":{"default":null,"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"default":null,"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["handle","title","description","productIds","sort","published"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCollection"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/collections/{collectionId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/collections/{collectionId}"},"delete":{"operationId":"deleteCollectionWithStoreId","summary":"Delete a collection","tags":["collections"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"collectionId","in":"path","required":true,"schema":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of DELETE /v1/store/collections/{collectionId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/collections/{collectionId}"}},"/v1/storefront/resolve":{"get":{"operationId":"storefrontResolve","summary":"Host → store, live theme version and catalog etag","tags":["storefront"],"security":[],"parameters":[{"name":"host","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontResolution"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/catalog":{"get":{"operationId":"storefrontCatalog","summary":"Published products, collections, pages and reviews","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCatalog"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/themes/{versionId}":{"get":{"operationId":"storefrontTheme","summary":"An immutable published theme version (files + compiled CSS)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontThemeBundle"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stock-themes/{stockId}":{"get":{"operationId":"storefrontStockTheme","summary":"A stock theme with its default settings (stores that never published)","tags":["storefront"],"security":[],"parameters":[{"name":"stockId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontThemeBundle"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/preview":{"get":{"operationId":"storefrontPreview","summary":"A draft theme behind a signed preview token","tags":["storefront"],"security":[],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","minLength":20,"maxLength":400}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontPreviewResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/newsletter":{"post":{"operationId":"storefrontNewsletterSignup","summary":"A buyer signs up from a newsletter section (idempotent per email; rate limited)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"source":{"type":"string","maxLength":48},"page":{"type":"string","maxLength":200}},"required":["email","source","page"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}":{"get":{"operationId":"storefrontCheckout","summary":"A checkout and its order status for the buyer (the session id is the capability)","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCheckout"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/recent-purchases":{"get":{"operationId":"storefrontRecentPurchases","summary":"The latest paid orders of the last 7 days, anonymized for purchase alerts","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontRecentPurchases"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/product-sales":{"get":{"operationId":"storefrontProductSales","summary":"Units sold per product in the last 24 hours (product live stats)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontProductSales"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/reviews":{"get":{"operationId":"storefrontReviews","summary":"Published reviews across the store (verified, imported, and reviews of the store), pinned first then newest, paged, with the rating summary","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"perPage","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontReviewsPage"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"submitReview","summary":"A verified buyer reviews one item of their order (once per item)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"via":{"type":"string","const":"token"},"token":{"type":"string","minLength":20,"maxLength":400}},"required":["via","token"]},{"type":"object","properties":{"via":{"type":"string","const":"checkout"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["via","sessionId","access"]}]},"position":{"type":"integer","minimum":0,"maximum":49},"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"default":"","type":"string","maxLength":120},"body":{"type":"string","minLength":10,"maxLength":2000},"author":{"type":"string","minLength":1,"maxLength":60}},"required":["proof","position","rating","body","author"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitReviewResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/wallet":{"get":{"operationId":"buyerWallet","summary":"The signed-in buyer's store credit, gift cards and coupons","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerWallet"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/themes/{themeId}/assets":{"get":{"operationId":"listThemeAssets","summary":"Images uploaded into a theme","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeAssetsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/assets.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/assets"},"post":{"operationId":"addThemeAsset","summary":"Add a completed image upload to a theme (the editor then writes config/assets.json in the draft)","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"name":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,59}\\.(?:png|jpe?g|webp|gif)$"},{"type":"null"}]}},"required":["uploadId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAsset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/assets.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/assets"}},"/v1/stores/{storeId}/themes/{themeId}/assets":{"get":{"operationId":"listThemeAssetsWithStoreId","summary":"Images uploaded into a theme","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeAssetsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/assets, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/assets"},"post":{"operationId":"addThemeAssetWithStoreId","summary":"Add a completed image upload to a theme (the editor then writes config/assets.json in the draft)","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"name":{"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,59}\\.(?:png|jpe?g|webp|gif)$"},{"type":"null"}]}},"required":["uploadId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAsset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/assets, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/assets"}},"/v1/store/themes/{themeId}/assets/{assetId}":{"delete":{"operationId":"deleteThemeAsset","summary":"Remove an image from a theme. Published versions that use it keep working.","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^tha_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/themes/{themeId}/assets/{assetId}.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/assets/{assetId}"}},"/v1/stores/{storeId}/themes/{themeId}/assets/{assetId}":{"delete":{"operationId":"deleteThemeAssetWithStoreId","summary":"Remove an image from a theme. Published versions that use it keep working.","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^tha_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/themes/{themeId}/assets/{assetId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/assets/{assetId}"}},"/v1/store/themes/{themeId}/update":{"get":{"operationId":"getThemeUpdate","summary":"Whether a newer stock version exists, and what merging it into this theme's draft or live version would change","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"target","in":"query","required":false,"schema":{"default":"draft","type":"string","enum":["draft","live"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeUpdatePreview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/update.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/update"},"post":{"operationId":"applyThemeUpdate","summary":"Take the newest stock version, the way the seller chose: into the draft, as a new unpublished theme, or live (published at once)","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"resolutions":{"default":{},"type":"object","propertyNames":{"type":"string","maxLength":120},"additionalProperties":{"type":"string","enum":["ours","theirs"]}},"mode":{"default":"draft","type":"string","enum":["draft","new_theme","live"]},"name":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":60},{"type":"null"}]}},"required":["baseRevision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyThemeUpdateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/update.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/update"}},"/v1/stores/{storeId}/themes/{themeId}/update":{"get":{"operationId":"getThemeUpdateWithStoreId","summary":"Whether a newer stock version exists, and what merging it into this theme's draft or live version would change","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"target","in":"query","required":false,"schema":{"default":"draft","type":"string","enum":["draft","live"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeUpdatePreview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/update, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/update"},"post":{"operationId":"applyThemeUpdateWithStoreId","summary":"Take the newest stock version, the way the seller chose: into the draft, as a new unpublished theme, or live (published at once)","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"resolutions":{"default":{},"type":"object","propertyNames":{"type":"string","maxLength":120},"additionalProperties":{"type":"string","enum":["ours","theirs"]}},"mode":{"default":"draft","type":"string","enum":["draft","new_theme","live"]},"name":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":60},{"type":"null"}]}},"required":["baseRevision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyThemeUpdateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/update, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/update"}},"/v1/store/themes/{themeId}/shares":{"post":{"operationId":"createThemeShare","summary":"Export a theme or one template as a share code (and the package file behind it)","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"theme"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"template"},"path":{"type":"string","pattern":"^templates\\/[a-z0-9-]+(?:\\.[a-z][a-z0-9_-]{0,39})?\\.json$"}},"required":["kind","path"]}]}},"required":["scope"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeShare"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/shares.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/shares"}},"/v1/stores/{storeId}/themes/{themeId}/shares":{"post":{"operationId":"createThemeShareWithStoreId","summary":"Export a theme or one template as a share code (and the package file behind it)","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"theme"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"template"},"path":{"type":"string","pattern":"^templates\\/[a-z0-9-]+(?:\\.[a-z][a-z0-9_-]{0,39})?\\.json$"}},"required":["kind","path"]}]}},"required":["scope"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeShare"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/shares, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/shares"}},"/v1/store/themes/{themeId}/shares/{code}":{"delete":{"operationId":"deleteThemeShare","summary":"Revoke a share code before it expires","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"code","in":"path","required":true,"schema":{"type":"string","pattern":"^SF(?:-[2-9A-HJ-NP-Z]{4}){3}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/themes/{themeId}/shares/{code}.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/shares/{code}"}},"/v1/stores/{storeId}/themes/{themeId}/shares/{code}":{"delete":{"operationId":"deleteThemeShareWithStoreId","summary":"Revoke a share code before it expires","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"code","in":"path","required":true,"schema":{"type":"string","pattern":"^SF(?:-[2-9A-HJ-NP-Z]{4}){3}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/themes/{themeId}/shares/{code}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/shares/{code}"}},"/v1/stores/{storeId}/theme-imports/resolve":{"post":{"operationId":"resolveThemeImport","summary":"Look up a share code or read a package file, validated, so the seller can review it before importing","tags":["theme-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"code"},"code":{"type":"string","pattern":"^SF(?:-[2-9A-HJ-NP-Z]{4}){3}$"}},"required":["kind","code"]},{"type":"object","properties":{"kind":{"type":"string","const":"package"},"package":{"type":"object","properties":{"format":{"type":"string","const":"shopfast-theme@1"},"kind":{"type":"string","enum":["theme","template"]},"name":{"type":"string","minLength":1,"maxLength":80},"stockId":{"type":"string","maxLength":40},"stockVersion":{"type":"string","maxLength":20},"sourceStore":{"type":"string","maxLength":80},"exportedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"files":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"},"additionalProperties":{"type":"string","maxLength":300000}},"signature":{"type":"string","maxLength":200}},"required":["format","kind","name","stockId","stockVersion","sourceStore","exportedAt","files"]}},"required":["kind","package"]}]}},"required":["source"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeImportPreview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/theme-imports":{"post":{"operationId":"applyThemeImport","summary":"Import a share into a new unpublished theme or into a draft (409 when baseRevision is stale)","tags":["theme-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"code"},"code":{"type":"string","pattern":"^SF(?:-[2-9A-HJ-NP-Z]{4}){3}$"}},"required":["kind","code"]},{"type":"object","properties":{"kind":{"type":"string","const":"package"},"package":{"type":"object","properties":{"format":{"type":"string","const":"shopfast-theme@1"},"kind":{"type":"string","enum":["theme","template"]},"name":{"type":"string","minLength":1,"maxLength":80},"stockId":{"type":"string","maxLength":40},"stockVersion":{"type":"string","maxLength":20},"sourceStore":{"type":"string","maxLength":80},"exportedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"files":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"},"additionalProperties":{"type":"string","maxLength":300000}},"signature":{"type":"string","maxLength":200}},"required":["format","kind","name","stockId","stockVersion","sourceStore","exportedAt","files"]}},"required":["kind","package"]}]},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"new_theme"},"name":{"type":"string","minLength":1,"maxLength":60}},"required":["kind","name"]},{"type":"object","properties":{"kind":{"type":"string","const":"into_theme"},"themeId":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"},"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","themeId","baseRevision"]}]}},"required":["source","target"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyThemeImportResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/store/products/{productId}/template":{"put":{"operationId":"setProductTemplate","summary":"Pick the theme template a product page uses (null: the default product template)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["templateSuffix"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetProductTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/template.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/template"}},"/v1/stores/{storeId}/products/{productId}/template":{"put":{"operationId":"setProductTemplateWithStoreId","summary":"Pick the theme template a product page uses (null: the default product template)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["templateSuffix"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetProductTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/template, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/template"}},"/v1/stores/{storeId}/templates/reassign":{"post":{"operationId":"reassignTemplate","summary":"Move every product, collection or page from one template to another (after a rename), or back to the default (after a delete)","tags":["templates"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["product","collection","page"]},"from":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"to":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["type","from","to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReassignTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/store/themes/{themeId}/templates":{"get":{"operationId":"listThemeTemplates","summary":"Every template in a theme draft, with how many products, collections and pages use each alternate","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeTemplatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/templates.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/templates"},"post":{"operationId":"createThemeTemplate","summary":"Create an alternate template (templates/<type>.<suffix>.json) from the default template or by duplicating another","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"type":{"type":"string","enum":["product","collection","page"]},"suffix":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"from":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["baseRevision","type","suffix","from"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThemeTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/templates.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/templates"}},"/v1/stores/{storeId}/themes/{themeId}/templates":{"get":{"operationId":"listThemeTemplatesWithStoreId","summary":"Every template in a theme draft, with how many products, collections and pages use each alternate","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemeTemplatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/templates, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/templates"},"post":{"operationId":"createThemeTemplateWithStoreId","summary":"Create an alternate template (templates/<type>.<suffix>.json) from the default template or by duplicating another","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"type":{"type":"string","enum":["product","collection","page"]},"suffix":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"from":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["baseRevision","type","suffix","from"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThemeTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/templates, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/templates"}},"/v1/store/themes/{themeId}/templates/rename":{"post":{"operationId":"renameThemeTemplate","summary":"Rename an alternate template. 409 while products, collections or pages use it, unless reassign moves them along","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"type":{"type":"string","enum":["product","collection","page"]},"suffix":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"to":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"reassign":{"default":false,"type":"boolean"}},"required":["baseRevision","type","suffix","to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameThemeTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/templates/rename.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/templates/rename"}},"/v1/stores/{storeId}/themes/{themeId}/templates/rename":{"post":{"operationId":"renameThemeTemplateWithStoreId","summary":"Rename an alternate template. 409 while products, collections or pages use it, unless reassign moves them along","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"type":{"type":"string","enum":["product","collection","page"]},"suffix":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"to":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"reassign":{"default":false,"type":"boolean"}},"required":["baseRevision","type","suffix","to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameThemeTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/templates/rename, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/templates/rename"}},"/v1/store/themes/{themeId}/templates/delete":{"post":{"operationId":"deleteThemeTemplate","summary":"Delete an alternate template. 409 (with who uses it) while products, collections or pages are assigned to it","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"type":{"type":"string","enum":["product","collection","page"]},"suffix":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"}},"required":["baseRevision","type","suffix"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteThemeTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/templates/delete.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/templates/delete"}},"/v1/stores/{storeId}/themes/{themeId}/templates/delete":{"post":{"operationId":"deleteThemeTemplateWithStoreId","summary":"Delete an alternate template. 409 (with who uses it) while products, collections or pages are assigned to it","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"type":{"type":"string","enum":["product","collection","page"]},"suffix":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"}},"required":["baseRevision","type","suffix"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteThemeTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/templates/delete, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/templates/delete"}},"/v1/stores/{storeId}/theme-drafts/delete":{"post":{"operationId":"deleteThemeDrafts","summary":"Delete several unpublished themes at once (the live theme is never deleted)","tags":["theme-drafts"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"themeIds":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["themeIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteThemeDraftsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/store/themes/{themeId}/library":{"get":{"operationId":"getSectionLibrary","summary":"Every section the theme can add, with its variants and the metadata the \"Add section\" library filters on","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSectionLibraryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/library.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/library"}},"/v1/stores/{storeId}/themes/{themeId}/library":{"get":{"operationId":"getSectionLibraryWithStoreId","summary":"Every section the theme can add, with its variants and the metadata the \"Add section\" library filters on","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSectionLibraryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/library, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/library"}},"/v1/store/themes/{themeId}/update/render":{"get":{"operationId":"getThemeUpdatePreviewHtml","summary":"A page of this theme rendered before (the draft) or after (the draft with the stock update merged), for What's-new previews","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"template","in":"query","required":false,"schema":{"default":"index","type":"string","enum":["404","index","product","collection","list-collections","page","search","reviews","cart"]}},{"name":"side","in":"query","required":false,"schema":{"default":"after","type":"string","enum":["before","after"]}},{"name":"target","in":"query","required":false,"schema":{"default":"draft","type":"string","enum":["draft","live"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThemeUpdatePreviewHtmlResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/themes/{themeId}/update/render.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/update/render"}},"/v1/stores/{storeId}/themes/{themeId}/update/render":{"get":{"operationId":"getThemeUpdatePreviewHtmlWithStoreId","summary":"A page of this theme rendered before (the draft) or after (the draft with the stock update merged), for What's-new previews","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"template","in":"query","required":false,"schema":{"default":"index","type":"string","enum":["404","index","product","collection","list-collections","page","search","reviews","cart"]}},{"name":"side","in":"query","required":false,"schema":{"default":"after","type":"string","enum":["before","after"]}},{"name":"target","in":"query","required":false,"schema":{"default":"draft","type":"string","enum":["draft","live"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThemeUpdatePreviewHtmlResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/themes/{themeId}/update/render, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/update/render"}},"/v1/studio/me":{"get":{"operationId":"getStudioMe","summary":"Whether the signed-in user is a template developer, or has an invite waiting","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StudioMe"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/invites/{inviteId}/accept":{"post":{"operationId":"acceptTemplateInvite","summary":"Become a template developer (the invite was sent to your email)","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpi_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StudioMe"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/invites/{inviteId}/decline":{"post":{"operationId":"declineTemplateInvite","summary":"Turn down a template developer invite","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpi_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/templates":{"get":{"operationId":"listStudioTemplates","summary":"The templates this developer can work on or review, and the released ones a new template can start from","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStudioTemplatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"createStudioTemplate","summary":"Start a new template (version 1.0.0, as a draft) from a released template's files","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"},"name":{"type":"string","minLength":2,"maxLength":40},"startFrom":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}},"required":["id","name","startFrom"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/templates/{templateId}":{"get":{"operationId":"getStudioTemplate","summary":"A template with its release history and recent activity","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/templates/{templateId}/events":{"get":{"operationId":"listStudioTemplateEvents","summary":"A template's activity log, newest first","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStudioTemplateEventsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/templates/{templateId}/releases":{"post":{"operationId":"startTemplateRelease","summary":"Start the next version as a draft, from the current release or any older release (to roll back through review)","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"default":null,"anyOf":[{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"version":{"default":null,"anyOf":[{"type":"string","pattern":"^(?:0|[1-9]\\d{0,3})\\.(?:0|[1-9]\\d{0,3})\\.(?:0|[1-9]\\d{0,3})$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}":{"get":{"operationId":"getTemplateRelease","summary":"A release with every file, its notes, gallery card and what you may do with it","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"patch":{"operationId":"saveTemplateReleaseDetails","summary":"Change a draft release's version number, release notes or gallery card","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"version":{"type":"string","pattern":"^(?:0|[1-9]\\d{0,3})\\.(?:0|[1-9]\\d{0,3})\\.(?:0|[1-9]\\d{0,3})$"},"notes":{"type":"object","properties":{"title":{"default":"","type":"string","maxLength":120},"items":{"default":[],"maxItems":40,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["new","improved","fixed"]},"text":{"type":"string","minLength":1,"maxLength":300},"templates":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":60}}},"required":["kind","text"]}},"addedSections":{"default":[],"maxItems":40,"type":"array","items":{"type":"string","maxLength":40}},"changedSettings":{"default":[],"maxItems":80,"type":"array","items":{"type":"string","maxLength":40}},"visualNotes":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":300}},"thumbnails":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","maxLength":60}}}},"listing":{"type":"object","properties":{"order":{"default":100,"type":"integer","minimum":0,"maximum":1000},"tagline":{"default":"","type":"string","maxLength":160},"bestFor":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"presets":{"default":{},"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"type":"string","maxLength":200}},"template":{"default":null,"anyOf":[{"type":"object","properties":{"concept":{"type":"string","maxLength":200},"styles":{"maxItems":6,"type":"array","items":{"type":"string","maxLength":30}},"industries":{"maxItems":6,"type":"array","items":{"type":"string","maxLength":30}},"fonts":{"type":"object","properties":{"display":{"type":"string","maxLength":40},"body":{"type":"string","maxLength":40},"mono":{"type":"string","maxLength":40}},"required":["display","body","mono"]},"motion":{"type":"string","maxLength":200},"mode":{"type":"string","enum":["dark","light"]}},"required":["concept","styles","industries","fonts","motion","mode"]},{"type":"null"}]}}}},"required":["baseRevision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveTemplateReleaseDetailsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"delete":{"operationId":"discardTemplateRelease","summary":"Delete a draft release that was never released","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/files":{"put":{"operationId":"saveTemplateReleaseFiles","summary":"Write or delete files in a draft release","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"changes":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"},"body":{"anyOf":[{"type":"string","maxLength":300000},{"type":"null"}]}},"required":["path","body"]}}},"required":["baseRevision","changes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveTemplateReleaseFilesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/rebase":{"post":{"operationId":"rebaseTemplateRelease","summary":"Bring a newer release into this draft (three-way merge; where both changed the same spot your draft wins and it is listed)","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["baseRevision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebaseTemplateReleaseResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/submit":{"post":{"operationId":"submitTemplateRelease","summary":"Send a draft release for review (its files freeze)","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["baseRevision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/unsubmit":{"post":{"operationId":"unsubmitTemplateRelease","summary":"Take a release back out of review to keep editing","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/review":{"post":{"operationId":"reviewTemplateRelease","summary":"Approve a release (it is released at once) or send it back with a note. Never your own release.","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","request_changes"]},"note":{"default":"","type":"string","maxLength":2000}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/withdraw":{"post":{"operationId":"withdrawTemplateRelease","summary":"Pull a released release: new installs and update offers go back to the previous release. Stores that took it keep it.","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/diff":{"get":{"operationId":"getTemplateReleaseDiff","summary":"Line-by-line changes between a release and another release of the same template","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"against","in":"query","required":false,"schema":{"default":"base","anyOf":[{"type":"string","enum":["base","current"]},{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseDiff"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/releases/{releaseId}/preview":{"get":{"operationId":"getTemplateReleasePreview","summary":"One page of a release rendered with demo products, as sellers see it in the Template gallery (thumbnails)","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"page","in":"query","required":false,"schema":{"default":"index","type":"string","enum":["index","product","collection"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePreview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/studio/reviews":{"get":{"operationId":"listTemplateReviews","summary":"Releases waiting for review, oldest first (yours are listed but you cannot approve them)","tags":["studio"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTemplateReviewsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-team":{"get":{"operationId":"adminTemplateTeam","summary":"Template developers and invites","tags":["admin template-team"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateTeam"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-invites":{"post":{"operationId":"adminInviteTemplateDeveloper","summary":"Invite someone by email to build templates (owner role)","tags":["admin template-invites"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"name":{"type":"string","minLength":1,"maxLength":120},"kind":{"type":"string","enum":["staff","partner"]},"permissions":{"maxItems":3,"type":"array","items":{"type":"string","enum":["create","edit_builtin","review"]}}},"required":["email","name","kind","permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateInvite"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-invites/{inviteId}":{"delete":{"operationId":"adminRevokeTemplateInvite","summary":"Cancel a pending developer invite (owner role)","tags":["admin template-invites"],"security":[{"adminSession":[]}],"parameters":[{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpi_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-developers/{userId}":{"patch":{"operationId":"adminUpdateTemplateDeveloper","summary":"Change a developer's permissions, or suspend them (owner role)","tags":["admin template-developers"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"maxItems":3,"type":"array","items":{"type":"string","enum":["create","edit_builtin","review"]}},"status":{"type":"string","enum":["active","suspended"]},"reason":{"default":"","type":"string","maxLength":280}},"required":["permissions","status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateDeveloper"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/templates":{"get":{"operationId":"adminListTemplates","summary":"Every template with its current and open release, and how many store themes use it","tags":["admin templates"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListTemplatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-order":{"put":{"operationId":"adminReorderTemplates","summary":"Set the order templates are listed in everywhere: the Template gallery, onboarding, the studio and here (owner role)","tags":["admin template-order"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"order":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}}},"required":["order"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminReorderTemplatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/templates/{templateId}/default":{"post":{"operationId":"adminSetDefaultTemplate","summary":"Make a released template the one new stores start on, first in the gallery order (owner role). Existing stores keep their theme","tags":["admin templates"],"security":[{"adminSession":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSetDefaultTemplateResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/templates/{templateId}":{"get":{"operationId":"adminGetTemplate","summary":"A template's release history and activity","tags":["admin templates"],"security":[{"adminSession":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/templates/{templateId}/visibility":{"post":{"operationId":"adminSetTemplateHidden","summary":"Hide a template from the Template gallery, or show it again (owner role)","tags":["admin templates"],"security":[{"adminSession":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hidden":{"type":"boolean"},"reason":{"default":"","type":"string","maxLength":280}},"required":["hidden"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-releases/{releaseId}/withdraw":{"post":{"operationId":"adminWithdrawTemplateRelease","summary":"Pull a released release (owner role)","tags":["admin template-releases"],"security":[{"adminSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-releases/{releaseId}/review":{"get":{"operationId":"adminTemplateReleaseReview","summary":"What an admin needs to review a release: its checks, who worked on it, and whether this admin may approve it","tags":["admin template-releases"],"security":[{"adminSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTemplateReleaseReviewResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"adminReviewTemplateRelease","summary":"Approve a release (released at once) or send it back with a note (owner role; never a release worked on by someone with your email)","tags":["admin template-releases"],"security":[{"adminSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","request_changes"]},"note":{"default":"","type":"string","maxLength":2000}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-releases/{releaseId}/discard":{"post":{"operationId":"adminDiscardTemplateRelease","summary":"Delete an open studio release (draft, sent back or in review) that will not be finished, so the template can move on (owner role)","tags":["admin template-releases"],"security":[{"adminSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-releases/{releaseId}/diff":{"get":{"operationId":"adminTemplateReleaseDiff","summary":"Line-by-line changes in a release","tags":["admin template-releases"],"security":[{"adminSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"against","in":"query","required":false,"schema":{"default":"base","anyOf":[{"type":"string","enum":["base","current"]},{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateReleaseDiff"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-releases/{releaseId}/preview":{"get":{"operationId":"adminTemplateReleasePreview","summary":"One page of a release rendered with demo products, as sellers see it in the Template gallery","tags":["admin template-releases"],"security":[{"adminSession":[]}],"parameters":[{"name":"releaseId","in":"path","required":true,"schema":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"page","in":"query","required":false,"schema":{"default":"index","type":"string","enum":["index","product","collection"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePreview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/template-events":{"get":{"operationId":"adminTemplateEvents","summary":"The template activity log across every template and developer, newest first","tags":["admin template-events"],"security":[{"adminSession":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"templateId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["template.created","template.hidden","template.shown","template.reordered","template.made_default","release.started","release.files_saved","release.details_saved","release.rebased","release.submitted","release.unsubmitted","release.approved","release.changes_requested","release.withdrawn","release.discarded","release.filed_from_repo","release.imported","developer.invited","developer.joined","developer.updated","developer.suspended","developer.reactivated","invite.revoked"]},{"type":"null"}]}},{"name":"actor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["developer","admin","system"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["what","who","template","when"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStudioTemplateEventsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/stock-themes/{stockId}":{"get":{"operationId":"getStockThemeRelease","summary":"A template's current release with its files, for Template gallery previews (exactly what an install copies)","tags":["stock-themes"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"stockId","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockThemeRelease"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/store/themes/{themeId}/versions/{versionId}/answer":{"post":{"operationId":"answerUnrequestedThemeVersion","summary":"Keep a version ShopFast published without asking, or restore the version before it (live at once; the draft too, when untouched since)","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["keep","restore"]}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerUnrequestedThemeVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/versions/{versionId}/answer.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/versions/{versionId}/answer"}},"/v1/stores/{storeId}/themes/{themeId}/versions/{versionId}/answer":{"post":{"operationId":"answerUnrequestedThemeVersionWithStoreId","summary":"Keep a version ShopFast published without asking, or restore the version before it (live at once; the draft too, when untouched since)","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["keep","restore"]}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerUnrequestedThemeVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/versions/{versionId}/answer, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/versions/{versionId}/answer"}},"/v1/store/products/{productId}/full":{"get":{"operationId":"getProductFull","summary":"Everything the product editor shows: variants, media, files, delivery, checkout fields, SEO and relations","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFull"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/full.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/full"},"put":{"operationId":"saveProductFull","summary":"Save the whole editor document. 409 when someone else saved since baseUpdatedAt","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},{"type":"null"}]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"status":{"type":"string","enum":["active","draft","archived"]},"description":{"type":"string","maxLength":20000},"shortDescription":{"type":"string","maxLength":300},"delivers":{"type":"string","maxLength":200},"tags":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"visibility":{"type":"string","enum":["public","unlisted","private"]},"publishAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"featured":{"type":"boolean"},"pricingMode":{"type":"string","enum":["fixed","pay_what_you_want","free"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywMinMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywSuggestedMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"taxCategory":{"type":"string","enum":["digital_goods","ebook","software","saas","online_course","membership","service","exempt"]},"minPerOrder":{"type":"integer","minimum":1,"maximum":10000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"maxPerCustomer":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"stockMode":{"type":"string","enum":["unlimited","limited","key_pool","serial_pool"]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":1000000},"outOfStockBehavior":{"type":"string","enum":["hide","show_sold_out","allow_preorder"]},"variants":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":300},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"enabled":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"deliveryNote":{"type":"string","maxLength":2000},"fileRefs":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":40}},"discordRoleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"paymentRules":{"default":null,"anyOf":[{"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},{"type":"null"}]},"lowStockThreshold":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["id","name","description","priceMinor","compareAtMinor","enabled","stock","deliveryNote","fileRefs","discordRoleId"]}},"media":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"source":{"anyOf":[{"type":"object","properties":{"mediaId":{"type":"string","pattern":"^med_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["mediaId"]},{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["uploadId"]},{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000}},"required":["url"]}]},"alt":{"type":"string","maxLength":200},"kind":{"default":"image","type":"string","enum":["image","video","youtube","vimeo"]},"posterUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"externalId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},"required":["source","alt"]}},"files":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"ref":{"type":"string","minLength":1,"maxLength":40},"name":{"type":"string","minLength":1,"maxLength":120},"newVersion":{"anyOf":[{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40},"changelog":{"type":"string","maxLength":5000}},"required":["uploadId","version","changelog"]},{"type":"null"}]}},"required":["id","ref","name","newVersion"]}},"delivery":{"type":"object","properties":{"file":{"type":"object","properties":{"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"linkExpiryHours":{"anyOf":[{"type":"integer","minimum":1,"maximum":8760},{"type":"null"}]},"notifyOnUpdate":{"type":"boolean"}},"required":["downloadLimit","linkExpiryHours","notifyOnUpdate"]},"keys":{"type":"object","properties":{"pattern":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"instructions":{"type":"string","maxLength":2000}},"required":["pattern","instructions"]},"discord":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleName":{"type":"string","maxLength":100},"removeOnRefund":{"type":"boolean"},"removeOnExpiry":{"type":"boolean"},"mode":{"default":"optional","type":"string","enum":["disabled","optional","mandatory"]},"extraGrants":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"type":"string","pattern":"^\\d{17,20}$"},"roleName":{"type":"string","maxLength":100}},"required":["guildId","roleId","roleName"]}}},"required":["guildId","roleId","roleName","removeOnRefund","removeOnExpiry"]},"subscription":{"type":"object","properties":{"interval":{"type":"string","enum":["week","month","year"]},"intervalCount":{"type":"integer","minimum":1,"maximum":12},"trialDays":{"type":"integer","minimum":0,"maximum":365},"renewalReminderDays":{"type":"integer","minimum":0,"maximum":30},"cancelBehavior":{"type":"string","enum":["end_of_period","immediately"]},"gracePeriodDays":{"type":"integer","minimum":0,"maximum":30}},"required":["interval","intervalCount","trialDays","renewalReminderDays","cancelBehavior","gracePeriodDays"]},"service":{"type":"object","properties":{"instructions":{"type":"string","maxLength":5000},"bookingUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["instructions","bookingUrl","turnaroundDays"]},"postPurchaseMessage":{"type":"string","maxLength":5000},"redirectUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"dynamic":{"default":{"enabled":false,"url":null,"secretVersion":1},"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"secretVersion":{"type":"integer","minimum":1,"maximum":1000000}},"required":["enabled","url","secretVersion"]},"warranty":{"default":{"days":null,"terms":""},"type":"object","properties":{"days":{"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"terms":{"type":"string","maxLength":1000}},"required":["days","terms"]}},"required":["file","keys","discord","subscription","service","postPurchaseMessage","redirectUrl"]},"checkoutFields":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","email","number","select","checkbox","url","password","hidden","discord_id"]},"required":{"type":"boolean"},"placeholder":{"type":"string","maxLength":120},"helpText":{"type":"string","maxLength":200},"options":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"defaultValue":{"default":"","type":"string","maxLength":500}},"required":["id","label","type","required","placeholder","helpText","options"]}},"seo":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"ogImage":{"type":"string","enum":["cover","custom"]},"ogImageUrl":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["title","description","ogImage","ogImageUrl"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"upsellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"crossSellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleParts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}},"bundlePricing":{"default":{"kind":"fixed"},"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"quantityTiers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"minQuantity":{"type":"integer","minimum":2,"maximum":10000},"discountBps":{"type":"integer","minimum":1,"maximum":9500}},"required":["minQuantity","discountBps"]}},"tiersWithCoupons":{"default":true,"type":"boolean"},"paymentRules":{"default":{"disabledMethods":[],"multipliers":[]},"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},"affiliateCommissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"fraud":{"type":"object","properties":{"blockVpn":{"type":"boolean"},"requireVerifiedEmail":{"type":"boolean"}},"required":["blockVpn","requireVerifiedEmail"]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"attributes":{"type":"object","properties":{"game":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"platforms":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"default":null,"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"statusNote":{"default":"","type":"string","maxLength":140},"statusUpdatedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"instantDelivery":{"default":false,"type":"boolean"},"presetKey":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"features":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"featureGroups":{"default":[],"maxItems":24,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":60},"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},"required":["title","items"]}},"requirements":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}}}},"required":["name","slug","type","status","description","shortDescription","delivers","tags","visibility","publishAt","featured","pricingMode","priceMinor","compareAtMinor","pwywMinMinor","pwywSuggestedMinor","taxCategory","minPerOrder","maxPerOrder","maxPerCustomer","stockMode","stock","lowStockThreshold","outOfStockBehavior","variants","media","files","delivery","checkoutFields","seo","collectionIds","upsellIds","crossSellIds","bundleProductIds","affiliateCommissionBps","fraud"]},"baseUpdatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["product","baseUpdatedAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSaved"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/full.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/full"}},"/v1/stores/{storeId}/products/{productId}/full":{"get":{"operationId":"getProductFullWithStoreId","summary":"Everything the product editor shows: variants, media, files, delivery, checkout fields, SEO and relations","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFull"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/full, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/full"},"put":{"operationId":"saveProductFullWithStoreId","summary":"Save the whole editor document. 409 when someone else saved since baseUpdatedAt","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},{"type":"null"}]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"status":{"type":"string","enum":["active","draft","archived"]},"description":{"type":"string","maxLength":20000},"shortDescription":{"type":"string","maxLength":300},"delivers":{"type":"string","maxLength":200},"tags":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"visibility":{"type":"string","enum":["public","unlisted","private"]},"publishAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"featured":{"type":"boolean"},"pricingMode":{"type":"string","enum":["fixed","pay_what_you_want","free"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywMinMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywSuggestedMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"taxCategory":{"type":"string","enum":["digital_goods","ebook","software","saas","online_course","membership","service","exempt"]},"minPerOrder":{"type":"integer","minimum":1,"maximum":10000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"maxPerCustomer":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"stockMode":{"type":"string","enum":["unlimited","limited","key_pool","serial_pool"]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":1000000},"outOfStockBehavior":{"type":"string","enum":["hide","show_sold_out","allow_preorder"]},"variants":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":300},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"enabled":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"deliveryNote":{"type":"string","maxLength":2000},"fileRefs":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":40}},"discordRoleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"paymentRules":{"default":null,"anyOf":[{"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},{"type":"null"}]},"lowStockThreshold":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["id","name","description","priceMinor","compareAtMinor","enabled","stock","deliveryNote","fileRefs","discordRoleId"]}},"media":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"source":{"anyOf":[{"type":"object","properties":{"mediaId":{"type":"string","pattern":"^med_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["mediaId"]},{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["uploadId"]},{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000}},"required":["url"]}]},"alt":{"type":"string","maxLength":200},"kind":{"default":"image","type":"string","enum":["image","video","youtube","vimeo"]},"posterUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"externalId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},"required":["source","alt"]}},"files":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"ref":{"type":"string","minLength":1,"maxLength":40},"name":{"type":"string","minLength":1,"maxLength":120},"newVersion":{"anyOf":[{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40},"changelog":{"type":"string","maxLength":5000}},"required":["uploadId","version","changelog"]},{"type":"null"}]}},"required":["id","ref","name","newVersion"]}},"delivery":{"type":"object","properties":{"file":{"type":"object","properties":{"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"linkExpiryHours":{"anyOf":[{"type":"integer","minimum":1,"maximum":8760},{"type":"null"}]},"notifyOnUpdate":{"type":"boolean"}},"required":["downloadLimit","linkExpiryHours","notifyOnUpdate"]},"keys":{"type":"object","properties":{"pattern":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"instructions":{"type":"string","maxLength":2000}},"required":["pattern","instructions"]},"discord":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleName":{"type":"string","maxLength":100},"removeOnRefund":{"type":"boolean"},"removeOnExpiry":{"type":"boolean"},"mode":{"default":"optional","type":"string","enum":["disabled","optional","mandatory"]},"extraGrants":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"type":"string","pattern":"^\\d{17,20}$"},"roleName":{"type":"string","maxLength":100}},"required":["guildId","roleId","roleName"]}}},"required":["guildId","roleId","roleName","removeOnRefund","removeOnExpiry"]},"subscription":{"type":"object","properties":{"interval":{"type":"string","enum":["week","month","year"]},"intervalCount":{"type":"integer","minimum":1,"maximum":12},"trialDays":{"type":"integer","minimum":0,"maximum":365},"renewalReminderDays":{"type":"integer","minimum":0,"maximum":30},"cancelBehavior":{"type":"string","enum":["end_of_period","immediately"]},"gracePeriodDays":{"type":"integer","minimum":0,"maximum":30}},"required":["interval","intervalCount","trialDays","renewalReminderDays","cancelBehavior","gracePeriodDays"]},"service":{"type":"object","properties":{"instructions":{"type":"string","maxLength":5000},"bookingUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["instructions","bookingUrl","turnaroundDays"]},"postPurchaseMessage":{"type":"string","maxLength":5000},"redirectUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"dynamic":{"default":{"enabled":false,"url":null,"secretVersion":1},"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"secretVersion":{"type":"integer","minimum":1,"maximum":1000000}},"required":["enabled","url","secretVersion"]},"warranty":{"default":{"days":null,"terms":""},"type":"object","properties":{"days":{"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"terms":{"type":"string","maxLength":1000}},"required":["days","terms"]}},"required":["file","keys","discord","subscription","service","postPurchaseMessage","redirectUrl"]},"checkoutFields":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","email","number","select","checkbox","url","password","hidden","discord_id"]},"required":{"type":"boolean"},"placeholder":{"type":"string","maxLength":120},"helpText":{"type":"string","maxLength":200},"options":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"defaultValue":{"default":"","type":"string","maxLength":500}},"required":["id","label","type","required","placeholder","helpText","options"]}},"seo":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"ogImage":{"type":"string","enum":["cover","custom"]},"ogImageUrl":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["title","description","ogImage","ogImageUrl"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"upsellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"crossSellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleParts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}},"bundlePricing":{"default":{"kind":"fixed"},"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"quantityTiers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"minQuantity":{"type":"integer","minimum":2,"maximum":10000},"discountBps":{"type":"integer","minimum":1,"maximum":9500}},"required":["minQuantity","discountBps"]}},"tiersWithCoupons":{"default":true,"type":"boolean"},"paymentRules":{"default":{"disabledMethods":[],"multipliers":[]},"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},"affiliateCommissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"fraud":{"type":"object","properties":{"blockVpn":{"type":"boolean"},"requireVerifiedEmail":{"type":"boolean"}},"required":["blockVpn","requireVerifiedEmail"]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"attributes":{"type":"object","properties":{"game":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"platforms":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"default":null,"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"statusNote":{"default":"","type":"string","maxLength":140},"statusUpdatedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"instantDelivery":{"default":false,"type":"boolean"},"presetKey":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"features":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"featureGroups":{"default":[],"maxItems":24,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":60},"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},"required":["title","items"]}},"requirements":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}}}},"required":["name","slug","type","status","description","shortDescription","delivers","tags","visibility","publishAt","featured","pricingMode","priceMinor","compareAtMinor","pwywMinMinor","pwywSuggestedMinor","taxCategory","minPerOrder","maxPerOrder","maxPerCustomer","stockMode","stock","lowStockThreshold","outOfStockBehavior","variants","media","files","delivery","checkoutFields","seo","collectionIds","upsellIds","crossSellIds","bundleProductIds","affiliateCommissionBps","fraud"]},"baseUpdatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["product","baseUpdatedAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSaved"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/full, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/full"}},"/v1/store/products/full":{"post":{"operationId":"createProductFull","summary":"Create a product from the editor (description sanitized, slug unique per store)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},{"type":"null"}]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"status":{"type":"string","enum":["active","draft","archived"]},"description":{"type":"string","maxLength":20000},"shortDescription":{"type":"string","maxLength":300},"delivers":{"type":"string","maxLength":200},"tags":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"visibility":{"type":"string","enum":["public","unlisted","private"]},"publishAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"featured":{"type":"boolean"},"pricingMode":{"type":"string","enum":["fixed","pay_what_you_want","free"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywMinMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywSuggestedMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"taxCategory":{"type":"string","enum":["digital_goods","ebook","software","saas","online_course","membership","service","exempt"]},"minPerOrder":{"type":"integer","minimum":1,"maximum":10000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"maxPerCustomer":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"stockMode":{"type":"string","enum":["unlimited","limited","key_pool","serial_pool"]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":1000000},"outOfStockBehavior":{"type":"string","enum":["hide","show_sold_out","allow_preorder"]},"variants":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":300},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"enabled":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"deliveryNote":{"type":"string","maxLength":2000},"fileRefs":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":40}},"discordRoleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"paymentRules":{"default":null,"anyOf":[{"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},{"type":"null"}]},"lowStockThreshold":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["id","name","description","priceMinor","compareAtMinor","enabled","stock","deliveryNote","fileRefs","discordRoleId"]}},"media":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"source":{"anyOf":[{"type":"object","properties":{"mediaId":{"type":"string","pattern":"^med_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["mediaId"]},{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["uploadId"]},{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000}},"required":["url"]}]},"alt":{"type":"string","maxLength":200},"kind":{"default":"image","type":"string","enum":["image","video","youtube","vimeo"]},"posterUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"externalId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},"required":["source","alt"]}},"files":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"ref":{"type":"string","minLength":1,"maxLength":40},"name":{"type":"string","minLength":1,"maxLength":120},"newVersion":{"anyOf":[{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40},"changelog":{"type":"string","maxLength":5000}},"required":["uploadId","version","changelog"]},{"type":"null"}]}},"required":["id","ref","name","newVersion"]}},"delivery":{"type":"object","properties":{"file":{"type":"object","properties":{"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"linkExpiryHours":{"anyOf":[{"type":"integer","minimum":1,"maximum":8760},{"type":"null"}]},"notifyOnUpdate":{"type":"boolean"}},"required":["downloadLimit","linkExpiryHours","notifyOnUpdate"]},"keys":{"type":"object","properties":{"pattern":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"instructions":{"type":"string","maxLength":2000}},"required":["pattern","instructions"]},"discord":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleName":{"type":"string","maxLength":100},"removeOnRefund":{"type":"boolean"},"removeOnExpiry":{"type":"boolean"},"mode":{"default":"optional","type":"string","enum":["disabled","optional","mandatory"]},"extraGrants":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"type":"string","pattern":"^\\d{17,20}$"},"roleName":{"type":"string","maxLength":100}},"required":["guildId","roleId","roleName"]}}},"required":["guildId","roleId","roleName","removeOnRefund","removeOnExpiry"]},"subscription":{"type":"object","properties":{"interval":{"type":"string","enum":["week","month","year"]},"intervalCount":{"type":"integer","minimum":1,"maximum":12},"trialDays":{"type":"integer","minimum":0,"maximum":365},"renewalReminderDays":{"type":"integer","minimum":0,"maximum":30},"cancelBehavior":{"type":"string","enum":["end_of_period","immediately"]},"gracePeriodDays":{"type":"integer","minimum":0,"maximum":30}},"required":["interval","intervalCount","trialDays","renewalReminderDays","cancelBehavior","gracePeriodDays"]},"service":{"type":"object","properties":{"instructions":{"type":"string","maxLength":5000},"bookingUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["instructions","bookingUrl","turnaroundDays"]},"postPurchaseMessage":{"type":"string","maxLength":5000},"redirectUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"dynamic":{"default":{"enabled":false,"url":null,"secretVersion":1},"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"secretVersion":{"type":"integer","minimum":1,"maximum":1000000}},"required":["enabled","url","secretVersion"]},"warranty":{"default":{"days":null,"terms":""},"type":"object","properties":{"days":{"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"terms":{"type":"string","maxLength":1000}},"required":["days","terms"]}},"required":["file","keys","discord","subscription","service","postPurchaseMessage","redirectUrl"]},"checkoutFields":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","email","number","select","checkbox","url","password","hidden","discord_id"]},"required":{"type":"boolean"},"placeholder":{"type":"string","maxLength":120},"helpText":{"type":"string","maxLength":200},"options":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"defaultValue":{"default":"","type":"string","maxLength":500}},"required":["id","label","type","required","placeholder","helpText","options"]}},"seo":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"ogImage":{"type":"string","enum":["cover","custom"]},"ogImageUrl":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["title","description","ogImage","ogImageUrl"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"upsellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"crossSellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleParts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}},"bundlePricing":{"default":{"kind":"fixed"},"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"quantityTiers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"minQuantity":{"type":"integer","minimum":2,"maximum":10000},"discountBps":{"type":"integer","minimum":1,"maximum":9500}},"required":["minQuantity","discountBps"]}},"tiersWithCoupons":{"default":true,"type":"boolean"},"paymentRules":{"default":{"disabledMethods":[],"multipliers":[]},"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},"affiliateCommissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"fraud":{"type":"object","properties":{"blockVpn":{"type":"boolean"},"requireVerifiedEmail":{"type":"boolean"}},"required":["blockVpn","requireVerifiedEmail"]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"attributes":{"type":"object","properties":{"game":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"platforms":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"default":null,"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"statusNote":{"default":"","type":"string","maxLength":140},"statusUpdatedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"instantDelivery":{"default":false,"type":"boolean"},"presetKey":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"features":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"featureGroups":{"default":[],"maxItems":24,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":60},"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},"required":["title","items"]}},"requirements":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}}}},"required":["name","slug","type","status","description","shortDescription","delivers","tags","visibility","publishAt","featured","pricingMode","priceMinor","compareAtMinor","pwywMinMinor","pwywSuggestedMinor","taxCategory","minPerOrder","maxPerOrder","maxPerCustomer","stockMode","stock","lowStockThreshold","outOfStockBehavior","variants","media","files","delivery","checkoutFields","seo","collectionIds","upsellIds","crossSellIds","bundleProductIds","affiliateCommissionBps","fraud"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSaved"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/full.","x-store-explicit-path":"/v1/stores/{storeId}/products/full"}},"/v1/stores/{storeId}/products/full":{"post":{"operationId":"createProductFullWithStoreId","summary":"Create a product from the editor (description sanitized, slug unique per store)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},{"type":"null"}]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"status":{"type":"string","enum":["active","draft","archived"]},"description":{"type":"string","maxLength":20000},"shortDescription":{"type":"string","maxLength":300},"delivers":{"type":"string","maxLength":200},"tags":{"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"visibility":{"type":"string","enum":["public","unlisted","private"]},"publishAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"featured":{"type":"boolean"},"pricingMode":{"type":"string","enum":["fixed","pay_what_you_want","free"]},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywMinMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"pwywSuggestedMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"taxCategory":{"type":"string","enum":["digital_goods","ebook","software","saas","online_course","membership","service","exempt"]},"minPerOrder":{"type":"integer","minimum":1,"maximum":10000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"maxPerCustomer":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"stockMode":{"type":"string","enum":["unlimited","limited","key_pool","serial_pool"]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":1000000},"outOfStockBehavior":{"type":"string","enum":["hide","show_sold_out","allow_preorder"]},"variants":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":300},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"enabled":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"deliveryNote":{"type":"string","maxLength":2000},"fileRefs":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":40}},"discordRoleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"paymentRules":{"default":null,"anyOf":[{"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},{"type":"null"}]},"lowStockThreshold":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}}},"required":["id","name","description","priceMinor","compareAtMinor","enabled","stock","deliveryNote","fileRefs","discordRoleId"]}},"media":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"source":{"anyOf":[{"type":"object","properties":{"mediaId":{"type":"string","pattern":"^med_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["mediaId"]},{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["uploadId"]},{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000}},"required":["url"]}]},"alt":{"type":"string","maxLength":200},"kind":{"default":"image","type":"string","enum":["image","video","youtube","vimeo"]},"posterUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"externalId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},"required":["source","alt"]}},"files":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"ref":{"type":"string","minLength":1,"maxLength":40},"name":{"type":"string","minLength":1,"maxLength":120},"newVersion":{"anyOf":[{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40},"changelog":{"type":"string","maxLength":5000}},"required":["uploadId","version","changelog"]},{"type":"null"}]}},"required":["id","ref","name","newVersion"]}},"delivery":{"type":"object","properties":{"file":{"type":"object","properties":{"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"linkExpiryHours":{"anyOf":[{"type":"integer","minimum":1,"maximum":8760},{"type":"null"}]},"notifyOnUpdate":{"type":"boolean"}},"required":["downloadLimit","linkExpiryHours","notifyOnUpdate"]},"keys":{"type":"object","properties":{"pattern":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"instructions":{"type":"string","maxLength":2000}},"required":["pattern","instructions"]},"discord":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleName":{"type":"string","maxLength":100},"removeOnRefund":{"type":"boolean"},"removeOnExpiry":{"type":"boolean"},"mode":{"default":"optional","type":"string","enum":["disabled","optional","mandatory"]},"extraGrants":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"type":"string","pattern":"^\\d{17,20}$"},"roleName":{"type":"string","maxLength":100}},"required":["guildId","roleId","roleName"]}}},"required":["guildId","roleId","roleName","removeOnRefund","removeOnExpiry"]},"subscription":{"type":"object","properties":{"interval":{"type":"string","enum":["week","month","year"]},"intervalCount":{"type":"integer","minimum":1,"maximum":12},"trialDays":{"type":"integer","minimum":0,"maximum":365},"renewalReminderDays":{"type":"integer","minimum":0,"maximum":30},"cancelBehavior":{"type":"string","enum":["end_of_period","immediately"]},"gracePeriodDays":{"type":"integer","minimum":0,"maximum":30}},"required":["interval","intervalCount","trialDays","renewalReminderDays","cancelBehavior","gracePeriodDays"]},"service":{"type":"object","properties":{"instructions":{"type":"string","maxLength":5000},"bookingUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["instructions","bookingUrl","turnaroundDays"]},"postPurchaseMessage":{"type":"string","maxLength":5000},"redirectUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"dynamic":{"default":{"enabled":false,"url":null,"secretVersion":1},"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"secretVersion":{"type":"integer","minimum":1,"maximum":1000000}},"required":["enabled","url","secretVersion"]},"warranty":{"default":{"days":null,"terms":""},"type":"object","properties":{"days":{"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"terms":{"type":"string","maxLength":1000}},"required":["days","terms"]}},"required":["file","keys","discord","subscription","service","postPurchaseMessage","redirectUrl"]},"checkoutFields":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","email","number","select","checkbox","url","password","hidden","discord_id"]},"required":{"type":"boolean"},"placeholder":{"type":"string","maxLength":120},"helpText":{"type":"string","maxLength":200},"options":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"defaultValue":{"default":"","type":"string","maxLength":500}},"required":["id","label","type","required","placeholder","helpText","options"]}},"seo":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"ogImage":{"type":"string","enum":["cover","custom"]},"ogImageUrl":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["title","description","ogImage","ogImageUrl"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"upsellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"crossSellIds":{"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"bundleParts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}},"bundlePricing":{"default":{"kind":"fixed"},"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"quantityTiers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"minQuantity":{"type":"integer","minimum":2,"maximum":10000},"discountBps":{"type":"integer","minimum":1,"maximum":9500}},"required":["minQuantity","discountBps"]}},"tiersWithCoupons":{"default":true,"type":"boolean"},"paymentRules":{"default":{"disabledMethods":[],"multipliers":[]},"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"multipliers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"]}}},"required":["disabledMethods","multipliers"]},"affiliateCommissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"fraud":{"type":"object","properties":{"blockVpn":{"type":"boolean"},"requireVerifiedEmail":{"type":"boolean"}},"required":["blockVpn","requireVerifiedEmail"]},"newKeys":{"default":[],"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":500}},"attributes":{"type":"object","properties":{"game":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"platforms":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"default":null,"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"statusNote":{"default":"","type":"string","maxLength":140},"statusUpdatedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"instantDelivery":{"default":false,"type":"boolean"},"presetKey":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"features":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"featureGroups":{"default":[],"maxItems":24,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":60},"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},"required":["title","items"]}},"requirements":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}}}},"required":["name","slug","type","status","description","shortDescription","delivers","tags","visibility","publishAt","featured","pricingMode","priceMinor","compareAtMinor","pwywMinMinor","pwywSuggestedMinor","taxCategory","minPerOrder","maxPerOrder","maxPerCustomer","stockMode","stock","lowStockThreshold","outOfStockBehavior","variants","media","files","delivery","checkoutFields","seo","collectionIds","upsellIds","crossSellIds","bundleProductIds","affiliateCommissionBps","fraud"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSaved"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/full, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/full"}},"/v1/store/products/{productId}/last-edit":{"get":{"operationId":"getProductLastEdit","summary":"Who last changed a product and when, and how many sales changed its stock since a time (the editor explains a save conflict with it)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"since","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLastEdit"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/last-edit.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/last-edit"}},"/v1/stores/{storeId}/products/{productId}/last-edit":{"get":{"operationId":"getProductLastEditWithStoreId","summary":"Who last changed a product and when, and how many sales changed its stock since a time (the editor explains a save conflict with it)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"since","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLastEdit"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/last-edit, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/last-edit"}},"/v1/store/product-slugs":{"get":{"operationId":"checkProductSlug","summary":"Is this slug free in the store? Suggests the next free one","tags":["product-slugs"],"security":[{"apiKey":[]}],"parameters":[{"name":"slug","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckProductSlugResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/product-slugs.","x-store-explicit-path":"/v1/stores/{storeId}/product-slugs"}},"/v1/stores/{storeId}/product-slugs":{"get":{"operationId":"checkProductSlugWithStoreId","summary":"Is this slug free in the store? Suggests the next free one","tags":["product-slugs"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"slug","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckProductSlugResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/product-slugs, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-slugs"}},"/v1/store/products/{productId}/duplicate":{"post":{"operationId":"duplicateProduct","summary":"Copy a product as a draft (variants, media, files, settings; not keys or sales)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFull"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/duplicate.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/duplicate"}},"/v1/stores/{storeId}/products/{productId}/duplicate":{"post":{"operationId":"duplicateProductWithStoreId","summary":"Copy a product as a draft (variants, media, files, settings; not keys or sales)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFull"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/duplicate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/duplicate"}},"/v1/store/products/{productId}/restore":{"post":{"operationId":"restoreProduct","summary":"Restore a deleted product as a draft","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFull"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/restore.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/restore"}},"/v1/stores/{storeId}/products/{productId}/restore":{"post":{"operationId":"restoreProductWithStoreId","summary":"Restore a deleted product as a draft","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFull"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/restore, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/restore"}},"/v1/store/products/bulk":{"post":{"operationId":"bulkProducts","summary":"Apply one action to many products","tags":["products"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"op":{"oneOf":[{"type":"object","properties":{"action":{"type":"string","const":"set_status"},"status":{"type":"string","enum":["active","draft","archived"]}},"required":["action","status"]},{"type":"object","properties":{"action":{"type":"string","const":"set_visibility"},"visibility":{"type":"string","enum":["public","unlisted","private"]}},"required":["action","visibility"]},{"type":"object","properties":{"action":{"type":"string","const":"add_tag"},"tag":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"required":["action","tag"]},{"type":"object","properties":{"action":{"type":"string","const":"remove_tag"},"tag":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"required":["action","tag"]},{"type":"object","properties":{"action":{"type":"string","const":"add_to_collection"},"collectionId":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["action","collectionId"]},{"type":"object","properties":{"action":{"type":"string","const":"add_to_category"},"categoryId":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["action","categoryId"]},{"type":"object","properties":{"action":{"type":"string","const":"remove_from_category"},"categoryId":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["action","categoryId"]},{"type":"object","properties":{"action":{"type":"string","const":"duplicate"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"delete"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"restore"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"set_discord"},"mode":{"type":"string","enum":["disabled","optional","mandatory"]},"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleName":{"type":"string","maxLength":100}},"required":["action","mode","guildId","roleId","roleName"]},{"type":"object","properties":{"action":{"type":"string","const":"set_delivery_note"},"message":{"type":"string","maxLength":5000}},"required":["action","message"]},{"type":"object","properties":{"action":{"type":"string","const":"set_checkout_fields"},"mode":{"type":"string","enum":["append","replace"]},"fields":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","email","number","select","checkbox","url","password","hidden","discord_id"]},"required":{"type":"boolean"},"placeholder":{"type":"string","maxLength":120},"helpText":{"type":"string","maxLength":200},"options":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"defaultValue":{"default":"","type":"string","maxLength":500}},"required":["id","label","type","required","placeholder","helpText","options"]}}},"required":["action","mode","fields"]}]}},"required":["productIds","op"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/bulk.","x-store-explicit-path":"/v1/stores/{storeId}/products/bulk"}},"/v1/stores/{storeId}/products/bulk":{"post":{"operationId":"bulkProductsWithStoreId","summary":"Apply one action to many products","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"op":{"oneOf":[{"type":"object","properties":{"action":{"type":"string","const":"set_status"},"status":{"type":"string","enum":["active","draft","archived"]}},"required":["action","status"]},{"type":"object","properties":{"action":{"type":"string","const":"set_visibility"},"visibility":{"type":"string","enum":["public","unlisted","private"]}},"required":["action","visibility"]},{"type":"object","properties":{"action":{"type":"string","const":"add_tag"},"tag":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"required":["action","tag"]},{"type":"object","properties":{"action":{"type":"string","const":"remove_tag"},"tag":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[^,\\n]+$"}},"required":["action","tag"]},{"type":"object","properties":{"action":{"type":"string","const":"add_to_collection"},"collectionId":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["action","collectionId"]},{"type":"object","properties":{"action":{"type":"string","const":"add_to_category"},"categoryId":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["action","categoryId"]},{"type":"object","properties":{"action":{"type":"string","const":"remove_from_category"},"categoryId":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["action","categoryId"]},{"type":"object","properties":{"action":{"type":"string","const":"duplicate"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"delete"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"restore"}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","const":"set_discord"},"mode":{"type":"string","enum":["disabled","optional","mandatory"]},"guildId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"roleName":{"type":"string","maxLength":100}},"required":["action","mode","guildId","roleId","roleName"]},{"type":"object","properties":{"action":{"type":"string","const":"set_delivery_note"},"message":{"type":"string","maxLength":5000}},"required":["action","message"]},{"type":"object","properties":{"action":{"type":"string","const":"set_checkout_fields"},"mode":{"type":"string","enum":["append","replace"]},"fields":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","email","number","select","checkbox","url","password","hidden","discord_id"]},"required":{"type":"boolean"},"placeholder":{"type":"string","maxLength":120},"helpText":{"type":"string","maxLength":200},"options":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"defaultValue":{"default":"","type":"string","maxLength":500}},"required":["id","label","type","required","placeholder","helpText","options"]}}},"required":["action","mode","fields"]}]}},"required":["productIds","op"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/bulk, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/bulk"}},"/v1/store/products/export":{"get":{"operationId":"exportProducts","summary":"Every product as CSV (PRODUCT_CSV_COLUMNS)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/export.","x-store-explicit-path":"/v1/stores/{storeId}/products/export"}},"/v1/stores/{storeId}/products/export":{"get":{"operationId":"exportProductsWithStoreId","summary":"Every product as CSV (PRODUCT_CSV_COLUMNS)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/export"}},"/v1/store/products/import":{"post":{"operationId":"importProducts","summary":"Create or update products from CSV (matched by slug). dryRun validates without writing; any error writes nothing","tags":["products"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"type":"string","minLength":1,"maxLength":5000000},"dryRun":{"type":"boolean"}},"required":["csv","dryRun"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductImportResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/import.","x-store-explicit-path":"/v1/stores/{storeId}/products/import"}},"/v1/stores/{storeId}/products/import":{"post":{"operationId":"importProductsWithStoreId","summary":"Create or update products from CSV (matched by slug). dryRun validates without writing; any error writes nothing","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"type":"string","minLength":1,"maxLength":5000000},"dryRun":{"type":"boolean"}},"required":["csv","dryRun"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductImportResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/import, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/import"}},"/v1/store/products/deleted":{"get":{"operationId":"listDeletedProducts","summary":"Recently deleted products that can be restored","tags":["products"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeletedProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/deleted.","x-store-explicit-path":"/v1/stores/{storeId}/products/deleted"}},"/v1/stores/{storeId}/products/deleted":{"get":{"operationId":"listDeletedProductsWithStoreId","summary":"Recently deleted products that can be restored","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeletedProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/deleted, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/deleted"}},"/v1/store/products/{productId}/delivery-webhook/secret":{"get":{"operationId":"getDeliveryWebhookSecret","summary":"The signing secret for this product's delivery URL (Standard Webhooks)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryWebhookSecret"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/delivery-webhook/secret.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/delivery-webhook/secret"}},"/v1/stores/{storeId}/products/{productId}/delivery-webhook/secret":{"get":{"operationId":"getDeliveryWebhookSecretWithStoreId","summary":"The signing secret for this product's delivery URL (Standard Webhooks)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryWebhookSecret"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/delivery-webhook/secret, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/delivery-webhook/secret"}},"/v1/store/products/{productId}/delivery-webhook/rotate":{"post":{"operationId":"rotateDeliveryWebhookSecret","summary":"Replace the signing secret; the old one stops verifying at once","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryWebhookSecret"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/delivery-webhook/rotate.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/delivery-webhook/rotate"}},"/v1/stores/{storeId}/products/{productId}/delivery-webhook/rotate":{"post":{"operationId":"rotateDeliveryWebhookSecretWithStoreId","summary":"Replace the signing secret; the old one stops verifying at once","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryWebhookSecret"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/delivery-webhook/rotate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/delivery-webhook/rotate"}},"/v1/store/products/{productId}/delivery-webhook/test":{"post":{"operationId":"testDeliveryWebhook","summary":"Call a delivery URL with a signed sample order and show what buyers would get","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri"}},"required":["url"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryWebhookTest"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/delivery-webhook/test.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/delivery-webhook/test"}},"/v1/stores/{storeId}/products/{productId}/delivery-webhook/test":{"post":{"operationId":"testDeliveryWebhookWithStoreId","summary":"Call a delivery URL with a signed sample order and show what buyers would get","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri"}},"required":["url"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryWebhookTest"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/delivery-webhook/test, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/delivery-webhook/test"}},"/v1/store/products/{productId}/subscribers":{"get":{"operationId":"listProductSubscribers","summary":"Subscriptions to this product: state, period end and renewals","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"state","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","past_due","ended"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductSubscribersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/subscribers.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/subscribers"}},"/v1/stores/{storeId}/products/{productId}/subscribers":{"get":{"operationId":"listProductSubscribersWithStoreId","summary":"Subscriptions to this product: state, period end and renewals","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"state","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","past_due","ended"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductSubscribersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/subscribers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/subscribers"}},"/v1/store/products/{productId}/subscribers/{subscriptionId}/cancel":{"post":{"operationId":"cancelProductSubscriber","summary":"Cancel a subscription now (access ends and Discord roles come off) or at the period end","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","pattern":"^sub_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"when":{"type":"string","enum":["now","period_end"]}},"required":["when"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSubscriber"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/subscribers/{subscriptionId}/cancel.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/subscribers/{subscriptionId}/cancel"}},"/v1/stores/{storeId}/products/{productId}/subscribers/{subscriptionId}/cancel":{"post":{"operationId":"cancelProductSubscriberWithStoreId","summary":"Cancel a subscription now (access ends and Discord roles come off) or at the period end","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","pattern":"^sub_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"when":{"type":"string","enum":["now","period_end"]}},"required":["when"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSubscriber"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/subscribers/{subscriptionId}/cancel, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/subscribers/{subscriptionId}/cancel"}},"/v1/store/uploads":{"post":{"operationId":"createUpload","summary":"Get a short-lived signed URL to PUT one file to (images for the gallery, private deliverables)","tags":["uploads"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"purpose":{"type":"string","enum":["media","file","image","asset"]},"filename":{"type":"string","minLength":1,"maxLength":200},"contentType":{"type":"string","minLength":3,"maxLength":120,"pattern":"^[a-z0-9.+-]+\\/[a-z0-9.+-]+$"},"bytes":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["purpose","filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadTicket"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/uploads.","x-store-explicit-path":"/v1/stores/{storeId}/uploads"}},"/v1/stores/{storeId}/uploads":{"post":{"operationId":"createUploadWithStoreId","summary":"Get a short-lived signed URL to PUT one file to (images for the gallery, private deliverables)","tags":["uploads"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"purpose":{"type":"string","enum":["media","file","image","asset"]},"filename":{"type":"string","minLength":1,"maxLength":200},"contentType":{"type":"string","minLength":3,"maxLength":120,"pattern":"^[a-z0-9.+-]+\\/[a-z0-9.+-]+$"},"bytes":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["purpose","filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadTicket"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/uploads, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/uploads"}},"/v1/store/uploads/{uploadId}/complete":{"post":{"operationId":"completeUpload","summary":"Check the uploaded bytes (size, real file type, image dimensions) and make the upload usable","tags":["uploads"],"security":[{"apiKey":[]}],"parameters":[{"name":"uploadId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedAsset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/uploads/{uploadId}/complete.","x-store-explicit-path":"/v1/stores/{storeId}/uploads/{uploadId}/complete"}},"/v1/stores/{storeId}/uploads/{uploadId}/complete":{"post":{"operationId":"completeUploadWithStoreId","summary":"Check the uploaded bytes (size, real file type, image dimensions) and make the upload usable","tags":["uploads"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"uploadId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedAsset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/uploads/{uploadId}/complete, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/uploads/{uploadId}/complete"}},"/v1/store/products/{productId}/files/{fileId}/download":{"get":{"operationId":"getFileDownloadUrl","summary":"A short-lived link for the seller to download the current version of a deliverable","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFileDownloadUrlResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/files/{fileId}/download.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/files/{fileId}/download"}},"/v1/stores/{storeId}/products/{productId}/files/{fileId}/download":{"get":{"operationId":"getFileDownloadUrlWithStoreId","summary":"A short-lived link for the seller to download the current version of a deliverable","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFileDownloadUrlResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/files/{fileId}/download, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/files/{fileId}/download"}},"/v1/store/products/{productId}/keys/import":{"post":{"operationId":"importKeys","summary":"Import keys or serials from pasted text or CSV: format check, duplicates skipped, optionally reserved for one option","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":5000000},"delimiter":{"type":"string","enum":["newline","comma","semicolon","tab","csv"]},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"strict":{"type":"boolean"}},"required":["text","delimiter","variantId","strict"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyImportResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/keys/import.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/keys/import"}},"/v1/stores/{storeId}/products/{productId}/keys/import":{"post":{"operationId":"importKeysWithStoreId","summary":"Import keys or serials from pasted text or CSV: format check, duplicates skipped, optionally reserved for one option","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":5000000},"delimiter":{"type":"string","enum":["newline","comma","semicolon","tab","csv"]},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"strict":{"type":"boolean"}},"required":["text","delimiter","variantId","strict"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyImportResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/keys/import, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/keys/import"}},"/v1/store/products/{productId}/keys/export":{"get":{"operationId":"exportKeys","summary":"Keys as CSV (value, status, option, order, assigned at)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["available","assigned","all"]}},{"name":"variantId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/keys/export.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/keys/export"}},"/v1/stores/{storeId}/products/{productId}/keys/export":{"get":{"operationId":"exportKeysWithStoreId","summary":"Keys as CSV (value, status, option, order, assigned at)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["available","assigned","all"]}},{"name":"variantId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/keys/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/keys/export"}},"/v1/store/products/{productId}/keys/remove":{"post":{"operationId":"removeKeys","summary":"Remove unused keys from the pool (assigned keys are never removed)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyIds":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["keyIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/keys/remove.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/keys/remove"}},"/v1/stores/{storeId}/products/{productId}/keys/remove":{"post":{"operationId":"removeKeysWithStoreId","summary":"Remove unused keys from the pool (assigned keys are never removed)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyIds":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["keyIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/keys/remove, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/keys/remove"}},"/v1/store/inventory":{"get":{"operationId":"listInventory","summary":"Stock for every product and option, with key pool health","tags":["inventory"],"security":[{"apiKey":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","low","out","pools","counted"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{1,7}$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"health","type":"string","enum":["health","product","type","available","sold","cover","alert"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInventoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/inventory.","x-store-explicit-path":"/v1/stores/{storeId}/inventory"}},"/v1/stores/{storeId}/inventory":{"get":{"operationId":"listInventoryWithStoreId","summary":"Stock for every product and option, with key pool health","tags":["inventory"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","low","out","pools","counted"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{1,7}$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"health","type":"string","enum":["health","product","type","available","sold","cover","alert"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInventoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/inventory, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/inventory"}},"/v1/store/inventory/adjust":{"post":{"operationId":"adjustStock","summary":"Change a counted stock and record why","tags":["inventory"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"mode":{"type":"string","enum":["add","set"]},"amount":{"type":"integer","minimum":-10000000,"maximum":10000000},"reason":{"type":"string","enum":["restock","correction","damaged","returned"]},"note":{"type":"string","maxLength":280}},"required":["productId","variantId","mode","amount","reason","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustStockResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/inventory/adjust.","x-store-explicit-path":"/v1/stores/{storeId}/inventory/adjust"}},"/v1/stores/{storeId}/inventory/adjust":{"post":{"operationId":"adjustStockWithStoreId","summary":"Change a counted stock and record why","tags":["inventory"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"mode":{"type":"string","enum":["add","set"]},"amount":{"type":"integer","minimum":-10000000,"maximum":10000000},"reason":{"type":"string","enum":["restock","correction","damaged","returned"]},"note":{"type":"string","maxLength":280}},"required":["productId","variantId","mode","amount","reason","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustStockResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/inventory/adjust, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/inventory/adjust"}},"/v1/store/inventory/history":{"get":{"operationId":"listStockHistory","summary":"Every stock change, newest first","tags":["inventory"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStockHistoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/inventory/history.","x-store-explicit-path":"/v1/stores/{storeId}/inventory/history"}},"/v1/stores/{storeId}/inventory/history":{"get":{"operationId":"listStockHistoryWithStoreId","summary":"Every stock change, newest first","tags":["inventory"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStockHistoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/inventory/history, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/inventory/history"}},"/v1/store/products/{productId}/move":{"post":{"operationId":"moveProduct","summary":"Move a product in the order the storefront lists products (or in a hand-picked collection): first, last, or next to another product","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"type":"string","enum":["top","bottom","before","after","position"]},"anchor":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"position":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"collectionId":{"default":null,"anyOf":[{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMoved"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/move.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/move"}},"/v1/stores/{storeId}/products/{productId}/move":{"post":{"operationId":"moveProductWithStoreId","summary":"Move a product in the order the storefront lists products (or in a hand-picked collection): first, last, or next to another product","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"type":"string","enum":["top","bottom","before","after","position"]},"anchor":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"position":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"collectionId":{"default":null,"anyOf":[{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMoved"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/move, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/move"}},"/v1/store/collections/reorder":{"post":{"operationId":"reorderCollections","summary":"Set the storefront order of collections","tags":["collections"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderCollectionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/collections/reorder.","x-store-explicit-path":"/v1/stores/{storeId}/collections/reorder"}},"/v1/stores/{storeId}/collections/reorder":{"post":{"operationId":"reorderCollectionsWithStoreId","summary":"Set the storefront order of collections","tags":["collections"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderCollectionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/collections/reorder, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/collections/reorder"}},"/v1/store/collections/preview":{"post":{"operationId":"previewCollectionRules","summary":"Products an automatic collection would contain","tags":["collections"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["type","tag","price","name","pricing_mode","created_days","category"]},"op":{"type":"string","enum":["equals","not_equals","contains","greater_than","less_than"]},"value":{"type":"string","minLength":1,"maxLength":80}},"required":["field","op","value"]}},"match":{"type":"string","enum":["all","any"]}},"required":["rules","match"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewCollectionRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/collections/preview.","x-store-explicit-path":"/v1/stores/{storeId}/collections/preview"}},"/v1/stores/{storeId}/collections/preview":{"post":{"operationId":"previewCollectionRulesWithStoreId","summary":"Products an automatic collection would contain","tags":["collections"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["type","tag","price","name","pricing_mode","created_days","category"]},"op":{"type":"string","enum":["equals","not_equals","contains","greater_than","less_than"]},"value":{"type":"string","minLength":1,"maxLength":80}},"required":["field","op","value"]}},"match":{"type":"string","enum":["all","any"]}},"required":["rules","match"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewCollectionRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/collections/preview, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/collections/preview"}},"/v1/store/bundles":{"get":{"operationId":"listBundles","summary":"Bundles with what they include and the savings","tags":["bundles"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBundlesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/bundles.","x-store-explicit-path":"/v1/stores/{storeId}/bundles"},"post":{"operationId":"createBundle","summary":"Create a bundle product","tags":["bundles"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":20000},"status":{"type":"string","enum":["active","draft","archived"]},"productIds":{"minItems":2,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"pricing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"coverUploadId":{"anyOf":[{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"parts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}}},"required":["name","description","status","productIds","pricing","coverUploadId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/bundles.","x-store-explicit-path":"/v1/stores/{storeId}/bundles"}},"/v1/stores/{storeId}/bundles":{"get":{"operationId":"listBundlesWithStoreId","summary":"Bundles with what they include and the savings","tags":["bundles"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBundlesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/bundles, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/bundles"},"post":{"operationId":"createBundleWithStoreId","summary":"Create a bundle product","tags":["bundles"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":20000},"status":{"type":"string","enum":["active","draft","archived"]},"productIds":{"minItems":2,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"pricing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"coverUploadId":{"anyOf":[{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"parts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}}},"required":["name","description","status","productIds","pricing","coverUploadId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/bundles, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/bundles"}},"/v1/store/bundles/{productId}":{"put":{"operationId":"updateBundle","summary":"Update a bundle product","tags":["bundles"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":20000},"status":{"type":"string","enum":["active","draft","archived"]},"productIds":{"minItems":2,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"pricing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"coverUploadId":{"anyOf":[{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"parts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}}},"required":["name","description","status","productIds","pricing","coverUploadId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/bundles/{productId}.","x-store-explicit-path":"/v1/stores/{storeId}/bundles/{productId}"}},"/v1/stores/{storeId}/bundles/{productId}":{"put":{"operationId":"updateBundleWithStoreId","summary":"Update a bundle product","tags":["bundles"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":20000},"status":{"type":"string","enum":["active","draft","archived"]},"productIds":{"minItems":2,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"pricing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"]}]},"coverUploadId":{"anyOf":[{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"parts":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["productId","variantId"]}}},"required":["name","description","status","productIds","pricing","coverUploadId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BundleRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/bundles/{productId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/bundles/{productId}"}},"/v1/store/offers":{"get":{"operationId":"listOfferRules","summary":"Add-on and upsell rules with 30-day conversions","tags":["offers"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfferRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/offers.","x-store-explicit-path":"/v1/stores/{storeId}/offers"},"post":{"operationId":"createOfferRule","summary":"When product X is in the cart, offer Y at Z","tags":["offers"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["order_bump","upsell","cross_sell"]},"triggerProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"offerProductId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"offerVariantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"discount":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"bps":{"type":"integer","minimum":1,"maximum":10000}},"required":["kind","bps"]},{"type":"object","properties":{"kind":{"type":"string","const":"fixed_price"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]}]},"headline":{"type":"string","minLength":1,"maxLength":100},"body":{"type":"string","maxLength":300},"placement":{"type":"string","enum":["cart","checkout","product_page"]},"enabled":{"type":"boolean"}},"required":["name","kind","triggerProductIds","offerProductId","offerVariantId","discount","headline","body","placement","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/offers.","x-store-explicit-path":"/v1/stores/{storeId}/offers"}},"/v1/stores/{storeId}/offers":{"get":{"operationId":"listOfferRulesWithStoreId","summary":"Add-on and upsell rules with 30-day conversions","tags":["offers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfferRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/offers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/offers"},"post":{"operationId":"createOfferRuleWithStoreId","summary":"When product X is in the cart, offer Y at Z","tags":["offers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["order_bump","upsell","cross_sell"]},"triggerProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"offerProductId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"offerVariantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"discount":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"bps":{"type":"integer","minimum":1,"maximum":10000}},"required":["kind","bps"]},{"type":"object","properties":{"kind":{"type":"string","const":"fixed_price"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]}]},"headline":{"type":"string","minLength":1,"maxLength":100},"body":{"type":"string","maxLength":300},"placement":{"type":"string","enum":["cart","checkout","product_page"]},"enabled":{"type":"boolean"}},"required":["name","kind","triggerProductIds","offerProductId","offerVariantId","discount","headline","body","placement","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/offers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/offers"}},"/v1/store/offers/{ruleId}":{"put":{"operationId":"updateOfferRule","summary":"Update an offer rule","tags":["offers"],"security":[{"apiKey":[]}],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^offr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["order_bump","upsell","cross_sell"]},"triggerProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"offerProductId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"offerVariantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"discount":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"bps":{"type":"integer","minimum":1,"maximum":10000}},"required":["kind","bps"]},{"type":"object","properties":{"kind":{"type":"string","const":"fixed_price"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]}]},"headline":{"type":"string","minLength":1,"maxLength":100},"body":{"type":"string","maxLength":300},"placement":{"type":"string","enum":["cart","checkout","product_page"]},"enabled":{"type":"boolean"}},"required":["name","kind","triggerProductIds","offerProductId","offerVariantId","discount","headline","body","placement","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/offers/{ruleId}.","x-store-explicit-path":"/v1/stores/{storeId}/offers/{ruleId}"},"delete":{"operationId":"deleteOfferRule","summary":"Delete an offer rule","tags":["offers"],"security":[{"apiKey":[]}],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^offr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/offers/{ruleId}.","x-store-explicit-path":"/v1/stores/{storeId}/offers/{ruleId}"}},"/v1/stores/{storeId}/offers/{ruleId}":{"put":{"operationId":"updateOfferRuleWithStoreId","summary":"Update an offer rule","tags":["offers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^offr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["order_bump","upsell","cross_sell"]},"triggerProductIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"offerProductId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"offerVariantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"discount":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"bps":{"type":"integer","minimum":1,"maximum":10000}},"required":["kind","bps"]},{"type":"object","properties":{"kind":{"type":"string","const":"fixed_price"},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","priceMinor"]}]},"headline":{"type":"string","minLength":1,"maxLength":100},"body":{"type":"string","maxLength":300},"placement":{"type":"string","enum":["cart","checkout","product_page"]},"enabled":{"type":"boolean"}},"required":["name","kind","triggerProductIds","offerProductId","offerVariantId","discount","headline","body","placement","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/offers/{ruleId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/offers/{ruleId}"},"delete":{"operationId":"deleteOfferRuleWithStoreId","summary":"Delete an offer rule","tags":["offers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^offr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of DELETE /v1/store/offers/{ruleId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/offers/{ruleId}"}},"/v1/store/offers/reorder":{"post":{"operationId":"reorderOfferRules","summary":"Set which offer shows first when several match","tags":["offers"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","pattern":"^offr_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderOfferRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/offers/reorder.","x-store-explicit-path":"/v1/stores/{storeId}/offers/reorder"}},"/v1/stores/{storeId}/offers/reorder":{"post":{"operationId":"reorderOfferRulesWithStoreId","summary":"Set which offer shows first when several match","tags":["offers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","pattern":"^offr_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderOfferRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/offers/reorder, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/offers/reorder"}},"/v1/store/categories":{"get":{"operationId":"listCategories","summary":"Every product category in tree order, with product counts (own and with subcategories)","tags":["categories"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/categories.","x-store-explicit-path":"/v1/stores/{storeId}/categories"},"post":{"operationId":"createCategory","summary":"Create a category, top-level or under a parent, optionally with products","tags":["categories"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":80},"handle":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},{"type":"null"}]},"parentId":{"default":null,"anyOf":[{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"index":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":500},{"type":"null"}]},"description":{"default":"","type":"string","maxLength":2000},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"published":{"default":true,"type":"boolean"},"sort":{"default":"manual","type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"seoTitle":{"default":null,"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"default":null,"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"productIds":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["title"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCategoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/categories.","x-store-explicit-path":"/v1/stores/{storeId}/categories"}},"/v1/stores/{storeId}/categories":{"get":{"operationId":"listCategoriesWithStoreId","summary":"Every product category in tree order, with product counts (own and with subcategories)","tags":["categories"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/categories, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/categories"},"post":{"operationId":"createCategoryWithStoreId","summary":"Create a category, top-level or under a parent, optionally with products","tags":["categories"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":80},"handle":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},{"type":"null"}]},"parentId":{"default":null,"anyOf":[{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"index":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":500},{"type":"null"}]},"description":{"default":"","type":"string","maxLength":2000},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"published":{"default":true,"type":"boolean"},"sort":{"default":"manual","type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"seoTitle":{"default":null,"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"default":null,"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"productIds":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["title"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCategoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/categories, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/categories"}},"/v1/store/categories/{categoryId}":{"patch":{"operationId":"updateCategory","summary":"Rename a category or change its handle (the old one redirects), description, image, SEO, sort or visibility","tags":["categories"],"security":[{"apiKey":[]}],"parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":80},"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"description":{"type":"string","maxLength":2000},"imageUrl":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"published":{"type":"boolean"},"sort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCategoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/categories/{categoryId}.","x-store-explicit-path":"/v1/stores/{storeId}/categories/{categoryId}"},"delete":{"operationId":"deleteCategory","summary":"Delete a category: lift or delete its subcategories, file its products in the parent or take them out","tags":["categories"],"security":[{"apiKey":[]}],"parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"children","in":"query","required":false,"schema":{"default":"lift","type":"string","enum":["lift","delete"]}},{"name":"products","in":"query","required":false,"schema":{"default":"parent","type":"string","enum":["parent","unassign"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryDeleteResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/categories/{categoryId}.","x-store-explicit-path":"/v1/stores/{storeId}/categories/{categoryId}"}},"/v1/stores/{storeId}/categories/{categoryId}":{"patch":{"operationId":"updateCategoryWithStoreId","summary":"Rename a category or change its handle (the old one redirects), description, image, SEO, sort or visibility","tags":["categories"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":80},"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"description":{"type":"string","maxLength":2000},"imageUrl":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"published":{"type":"boolean"},"sort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCategoryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PATCH /v1/store/categories/{categoryId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/categories/{categoryId}"},"delete":{"operationId":"deleteCategoryWithStoreId","summary":"Delete a category: lift or delete its subcategories, file its products in the parent or take them out","tags":["categories"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"children","in":"query","required":false,"schema":{"default":"lift","type":"string","enum":["lift","delete"]}},{"name":"products","in":"query","required":false,"schema":{"default":"parent","type":"string","enum":["parent","unassign"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryDeleteResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of DELETE /v1/store/categories/{categoryId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/categories/{categoryId}"}},"/v1/store/categories/{categoryId}/move":{"post":{"operationId":"moveCategory","summary":"Move a category under another parent (or to the top level) and to a place among its siblings","tags":["categories"],"security":[{"apiKey":[]}],"parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"anyOf":[{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"index":{"type":"integer","minimum":0,"maximum":500}},"required":["parentId","index"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/categories/{categoryId}/move.","x-store-explicit-path":"/v1/stores/{storeId}/categories/{categoryId}/move"}},"/v1/stores/{storeId}/categories/{categoryId}/move":{"post":{"operationId":"moveCategoryWithStoreId","summary":"Move a category under another parent (or to the top level) and to a place among its siblings","tags":["categories"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"anyOf":[{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"index":{"type":"integer","minimum":0,"maximum":500}},"required":["parentId","index"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/categories/{categoryId}/move, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/categories/{categoryId}/move"}},"/v1/store/categories/{categoryId}/products":{"get":{"operationId":"listCategoryProducts","summary":"Products filed directly in a category","tags":["categories"],"security":[{"apiKey":[]}],"parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryProducts"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/categories/{categoryId}/products.","x-store-explicit-path":"/v1/stores/{storeId}/categories/{categoryId}/products"},"post":{"operationId":"changeCategoryProducts","summary":"File products in a category or take them out","tags":["categories"],"security":[{"apiKey":[]}],"parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"add":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"remove":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryProductsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/categories/{categoryId}/products.","x-store-explicit-path":"/v1/stores/{storeId}/categories/{categoryId}/products"}},"/v1/stores/{storeId}/categories/{categoryId}/products":{"get":{"operationId":"listCategoryProductsWithStoreId","summary":"Products filed directly in a category","tags":["categories"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryProducts"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/categories/{categoryId}/products, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/categories/{categoryId}/products"},"post":{"operationId":"changeCategoryProductsWithStoreId","summary":"File products in a category or take them out","tags":["categories"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"add":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"remove":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryProductsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/categories/{categoryId}/products, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/categories/{categoryId}/products"}},"/v1/storefront/stores/{storeId}/categories":{"get":{"operationId":"storefrontCategories","summary":"The published category tree, in tree order, with product counts on the storefront","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCategoriesResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/categories/{handle}/products":{"get":{"operationId":"storefrontCategoryProducts","summary":"A page of the products in a category and its subcategories, sorted, with its breadcrumbs and children","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"handle","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":140}},{"name":"sort","in":"query","required":false,"schema":{"default":"featured","type":"string","enum":["featured","best-selling","newest","price-ascending","price-descending","title-ascending"]}},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"after","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCategoryPage"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/domains":{"get":{"operationId":"listDomains","summary":"Custom domains with their DNS records, verification and SSL status","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/domains.","x-store-explicit-path":"/v1/stores/{storeId}/domains"},"post":{"operationId":"addDomain","summary":"Connect a domain (and optionally its www twin). Returns the one DNS record per hostname to add (plus one TXT record when another store connected the domain before)","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostname":{"type":"string","maxLength":253,"pattern":"^(?=.{4,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"www":{"type":"string","enum":["none","redirect_to_www","redirect_to_apex"]},"mode":{"default":"cname","type":"string","enum":["cname","nameservers"]}},"required":["hostname","www"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/domains.","x-store-explicit-path":"/v1/stores/{storeId}/domains"}},"/v1/stores/{storeId}/domains":{"get":{"operationId":"listDomainsWithStoreId","summary":"Custom domains with their DNS records, verification and SSL status","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/domains, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains"},"post":{"operationId":"addDomainWithStoreId","summary":"Connect a domain (and optionally its www twin). Returns the one DNS record per hostname to add (plus one TXT record when another store connected the domain before)","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostname":{"type":"string","maxLength":253,"pattern":"^(?=.{4,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"www":{"type":"string","enum":["none","redirect_to_www","redirect_to_apex"]},"mode":{"default":"cname","type":"string","enum":["cname","nameservers"]}},"required":["hostname","www"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/domains, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains"}},"/v1/store/domains/{domainId}/check":{"post":{"operationId":"checkDomain","summary":"Look at DNS and ask Cloudflare for the latest status now. A root domain and its www are checked together","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomain"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/domains/{domainId}/check.","x-store-explicit-path":"/v1/stores/{storeId}/domains/{domainId}/check"}},"/v1/stores/{storeId}/domains/{domainId}/check":{"post":{"operationId":"checkDomainWithStoreId","summary":"Look at DNS and ask Cloudflare for the latest status now. A root domain and its www are checked together","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomain"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/domains/{domainId}/check, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains/{domainId}/check"}},"/v1/store/domains/primary":{"put":{"operationId":"setPrimaryDomain","summary":"Choose where buyers land. Every other address redirects there (null: the shopfa.st address)","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domainId":{"anyOf":[{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["domainId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/domains/primary.","x-store-explicit-path":"/v1/stores/{storeId}/domains/primary"}},"/v1/stores/{storeId}/domains/primary":{"put":{"operationId":"setPrimaryDomainWithStoreId","summary":"Choose where buyers land. Every other address redirects there (null: the shopfa.st address)","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domainId":{"anyOf":[{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["domainId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/domains/primary, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains/primary"}},"/v1/store/domains/{domainId}":{"delete":{"operationId":"removeDomain","summary":"Disconnect a domain and release its certificate. A nameserver-mode domain loses its whole DNS zone at ShopFast","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/domains/{domainId}.","x-store-explicit-path":"/v1/stores/{storeId}/domains/{domainId}"}},"/v1/stores/{storeId}/domains/{domainId}":{"delete":{"operationId":"removeDomainWithStoreId","summary":"Disconnect a domain and release its certificate. A nameserver-mode domain loses its whole DNS zone at ShopFast","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/domains/{domainId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains/{domainId}"}},"/v1/store/domains/{domainId}/dns-records":{"get":{"operationId":"listDomainDnsRecords","summary":"Every record in a nameserver-mode domain's zone. ShopFast's storefront records are marked managed","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/domains/{domainId}/dns-records.","x-store-explicit-path":"/v1/stores/{storeId}/domains/{domainId}/dns-records"},"post":{"operationId":"createDomainDnsRecord","summary":"Add an MX, TXT, CNAME, A, AAAA, SRV or CAA record (DNS only, never proxied)","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"A"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv4","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"AAAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"MX"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"priority":{"type":"integer","minimum":0,"maximum":65535},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","priority"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","minLength":1,"maxLength":2048,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"SRV"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"priority":{"type":"integer","minimum":0,"maximum":65535},"weight":{"type":"integer","minimum":0,"maximum":65535},"port":{"type":"integer","minimum":0,"maximum":65535},"target":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","priority","weight","port","target"]},{"type":"object","properties":{"type":{"type":"string","const":"CAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"flags":{"default":0,"anyOf":[{"type":"number","const":0},{"type":"number","const":128}]},"tag":{"type":"string","enum":["issue","issuewild","iodef"]},"value":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","tag","value"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/domains/{domainId}/dns-records.","x-store-explicit-path":"/v1/stores/{storeId}/domains/{domainId}/dns-records"}},"/v1/stores/{storeId}/domains/{domainId}/dns-records":{"get":{"operationId":"listDomainDnsRecordsWithStoreId","summary":"Every record in a nameserver-mode domain's zone. ShopFast's storefront records are marked managed","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/domains/{domainId}/dns-records, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains/{domainId}/dns-records"},"post":{"operationId":"createDomainDnsRecordWithStoreId","summary":"Add an MX, TXT, CNAME, A, AAAA, SRV or CAA record (DNS only, never proxied)","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"A"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv4","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"AAAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"MX"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"priority":{"type":"integer","minimum":0,"maximum":65535},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","priority"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","minLength":1,"maxLength":2048,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"SRV"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"priority":{"type":"integer","minimum":0,"maximum":65535},"weight":{"type":"integer","minimum":0,"maximum":65535},"port":{"type":"integer","minimum":0,"maximum":65535},"target":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","priority","weight","port","target"]},{"type":"object","properties":{"type":{"type":"string","const":"CAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"flags":{"default":0,"anyOf":[{"type":"number","const":0},{"type":"number","const":128}]},"tag":{"type":"string","enum":["issue","issuewild","iodef"]},"value":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","tag","value"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/domains/{domainId}/dns-records, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains/{domainId}/dns-records"}},"/v1/store/domains/{domainId}/dns-records/{recordId}":{"put":{"operationId":"updateDomainDnsRecord","summary":"Replace one of your records. Managed storefront records cannot be changed","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"A"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv4","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"AAAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"MX"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"priority":{"type":"integer","minimum":0,"maximum":65535},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","priority"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","minLength":1,"maxLength":2048,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"SRV"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"priority":{"type":"integer","minimum":0,"maximum":65535},"weight":{"type":"integer","minimum":0,"maximum":65535},"port":{"type":"integer","minimum":0,"maximum":65535},"target":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","priority","weight","port","target"]},{"type":"object","properties":{"type":{"type":"string","const":"CAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"flags":{"default":0,"anyOf":[{"type":"number","const":0},{"type":"number","const":128}]},"tag":{"type":"string","enum":["issue","issuewild","iodef"]},"value":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","tag","value"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/domains/{domainId}/dns-records/{recordId}.","x-store-explicit-path":"/v1/stores/{storeId}/domains/{domainId}/dns-records/{recordId}"},"delete":{"operationId":"deleteDomainDnsRecord","summary":"Delete one of your records. Managed storefront records cannot be deleted","tags":["domains"],"security":[{"apiKey":[]}],"parameters":[{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/domains/{domainId}/dns-records/{recordId}.","x-store-explicit-path":"/v1/stores/{storeId}/domains/{domainId}/dns-records/{recordId}"}},"/v1/stores/{storeId}/domains/{domainId}/dns-records/{recordId}":{"put":{"operationId":"updateDomainDnsRecordWithStoreId","summary":"Replace one of your records. Managed storefront records cannot be changed","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"A"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv4","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"AAAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"MX"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string"},"priority":{"type":"integer","minimum":0,"maximum":65535},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","priority"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","minLength":1,"maxLength":2048,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content"]},{"type":"object","properties":{"type":{"type":"string","const":"SRV"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"priority":{"type":"integer","minimum":0,"maximum":65535},"weight":{"type":"integer","minimum":0,"maximum":65535},"port":{"type":"integer","minimum":0,"maximum":65535},"target":{"type":"string"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","priority","weight","port","target"]},{"type":"object","properties":{"type":{"type":"string","const":"CAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"flags":{"default":0,"anyOf":[{"type":"number","const":0},{"type":"number","const":128}]},"tag":{"type":"string","enum":["issue","issuewild","iodef"]},"value":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","tag","value"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/domains/{domainId}/dns-records/{recordId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains/{domainId}/dns-records/{recordId}"},"delete":{"operationId":"deleteDomainDnsRecordWithStoreId","summary":"Delete one of your records. Managed storefront records cannot be deleted","tags":["domains"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{32}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneDnsRecords"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/domains/{domainId}/dns-records/{recordId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/domains/{domainId}/dns-records/{recordId}"}},"/v1/storefront/tls-allowed":{"get":{"operationId":"storefrontTlsAllowed","summary":"Whether the origin may get a certificate for this hostname: a seller domain with proven ownership, or an active nameserver-mode zone","tags":["storefront"],"security":[],"parameters":[{"name":"host","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontTlsAllowedResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/domains/readiness":{"get":{"operationId":"adminDomainReadiness","summary":"Cloudflare token, Cloudflare for SaaS, the fallback origin and nameserver mode, checked live","tags":["admin domains"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainReadiness"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/domains/fallback-origin":{"post":{"operationId":"adminEnsureFallbackOrigin","summary":"Set the SaaS zone's fallback origin to the CNAME target, then check again","tags":["admin domains"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainReadiness"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/seo":{"get":{"operationId":"getSeo","summary":"Store-level search and social settings, plus sitemap and feed links","tags":["seo"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/seo.","x-store-explicit-path":"/v1/stores/{storeId}/seo"},"put":{"operationId":"updateSeo","summary":"Save store-level search and social settings","tags":["seo"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"socialImageUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"allowIndexing":{"type":"boolean"},"blockAiCrawlers":{"type":"boolean"}},"required":["title","description","socialImageUrl","allowIndexing","blockAiCrawlers"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/seo.","x-store-explicit-path":"/v1/stores/{storeId}/seo"}},"/v1/stores/{storeId}/seo":{"get":{"operationId":"getSeoWithStoreId","summary":"Store-level search and social settings, plus sitemap and feed links","tags":["seo"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/seo, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/seo"},"put":{"operationId":"updateSeoWithStoreId","summary":"Save store-level search and social settings","tags":["seo"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"socialImageUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"allowIndexing":{"type":"boolean"},"blockAiCrawlers":{"type":"boolean"}},"required":["title","description","socialImageUrl","allowIndexing","blockAiCrawlers"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeoOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/seo, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/seo"}},"/v1/store/webhooks/endpoints":{"get":{"operationId":"listWebhookEndpoints","summary":"Webhook endpoints with their health","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookEndpointsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/webhooks/endpoints.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/endpoints"},"post":{"operationId":"createWebhookEndpoint","summary":"Add an endpoint. The signing secret is in the response","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri"},"description":{"type":"string","maxLength":200},"events":{"minItems":1,"maxItems":44,"type":"array","items":{"type":"string","enum":["order.created","order.paid","order.fulfilled","order.needs_attention","order.refunded","dispute.created","dispute.updated","dispute.closed","subscription.created","subscription.renewed","subscription.canceled","subscription.expired","product.created","product.updated","product.deleted","inventory.low","inventory.depleted","customer.created","review.created","discount.redeemed","payout.paid","theme.published","domain.verified","gift_card.created","gift_card.updated","gift_card.redeemed","discount.created","discount.updated","discount.deleted","team.member_joined","team.member_updated","team.member_removed","license.activated","license.device_reset","license.extended","license.expiring","license.expired","license.revoked","license.compensated","product.sales_paused","product.sales_resumed","license.replaced","subscription.renewal_failed","storefront.updated"]}}},"required":["url","description","events"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookEndpointResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/webhooks/endpoints.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/endpoints"}},"/v1/stores/{storeId}/webhooks/endpoints":{"get":{"operationId":"listWebhookEndpointsWithStoreId","summary":"Webhook endpoints with their health","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookEndpointsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:read","description":"The explicit form of GET /v1/store/webhooks/endpoints, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/endpoints"},"post":{"operationId":"createWebhookEndpointWithStoreId","summary":"Add an endpoint. The signing secret is in the response","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri"},"description":{"type":"string","maxLength":200},"events":{"minItems":1,"maxItems":44,"type":"array","items":{"type":"string","enum":["order.created","order.paid","order.fulfilled","order.needs_attention","order.refunded","dispute.created","dispute.updated","dispute.closed","subscription.created","subscription.renewed","subscription.canceled","subscription.expired","product.created","product.updated","product.deleted","inventory.low","inventory.depleted","customer.created","review.created","discount.redeemed","payout.paid","theme.published","domain.verified","gift_card.created","gift_card.updated","gift_card.redeemed","discount.created","discount.updated","discount.deleted","team.member_joined","team.member_updated","team.member_removed","license.activated","license.device_reset","license.extended","license.expiring","license.expired","license.revoked","license.compensated","product.sales_paused","product.sales_resumed","license.replaced","subscription.renewal_failed","storefront.updated"]}}},"required":["url","description","events"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookEndpointResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The explicit form of POST /v1/store/webhooks/endpoints, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/endpoints"}},"/v1/store/webhooks/endpoints/{endpointId}":{"patch":{"operationId":"updateWebhookEndpoint","summary":"Change the URL, events or description, or turn it on or off","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri"},"description":{"type":"string","maxLength":200},"events":{"minItems":1,"maxItems":44,"type":"array","items":{"type":"string","enum":["order.created","order.paid","order.fulfilled","order.needs_attention","order.refunded","dispute.created","dispute.updated","dispute.closed","subscription.created","subscription.renewed","subscription.canceled","subscription.expired","product.created","product.updated","product.deleted","inventory.low","inventory.depleted","customer.created","review.created","discount.redeemed","payout.paid","theme.published","domain.verified","gift_card.created","gift_card.updated","gift_card.redeemed","discount.created","discount.updated","discount.deleted","team.member_joined","team.member_updated","team.member_removed","license.activated","license.device_reset","license.extended","license.expiring","license.expired","license.revoked","license.compensated","product.sales_paused","product.sales_resumed","license.replaced","subscription.renewal_failed","storefront.updated"]}},"enabled":{"type":"boolean"},"transformerPluginId":{"anyOf":[{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/webhooks/endpoints/{endpointId}.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}"},"delete":{"operationId":"deleteWebhookEndpoint","summary":"Delete an endpoint and its pending deliveries","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/webhooks/endpoints/{endpointId}.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}"}},"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}":{"patch":{"operationId":"updateWebhookEndpointWithStoreId","summary":"Change the URL, events or description, or turn it on or off","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri"},"description":{"type":"string","maxLength":200},"events":{"minItems":1,"maxItems":44,"type":"array","items":{"type":"string","enum":["order.created","order.paid","order.fulfilled","order.needs_attention","order.refunded","dispute.created","dispute.updated","dispute.closed","subscription.created","subscription.renewed","subscription.canceled","subscription.expired","product.created","product.updated","product.deleted","inventory.low","inventory.depleted","customer.created","review.created","discount.redeemed","payout.paid","theme.published","domain.verified","gift_card.created","gift_card.updated","gift_card.redeemed","discount.created","discount.updated","discount.deleted","team.member_joined","team.member_updated","team.member_removed","license.activated","license.device_reset","license.extended","license.expiring","license.expired","license.revoked","license.compensated","product.sales_paused","product.sales_resumed","license.replaced","subscription.renewal_failed","storefront.updated"]}},"enabled":{"type":"boolean"},"transformerPluginId":{"anyOf":[{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The explicit form of PATCH /v1/store/webhooks/endpoints/{endpointId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/endpoints/{endpointId}"},"delete":{"operationId":"deleteWebhookEndpointWithStoreId","summary":"Delete an endpoint and its pending deliveries","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The explicit form of DELETE /v1/store/webhooks/endpoints/{endpointId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/endpoints/{endpointId}"}},"/v1/store/webhooks/endpoints/{endpointId}/secret":{"post":{"operationId":"revealWebhookSecret","summary":"Show the current signing secret (store owners only)","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevealWebhookSecretResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/webhooks/endpoints/{endpointId}/secret.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}/secret"}},"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}/secret":{"post":{"operationId":"revealWebhookSecretWithStoreId","summary":"Show the current signing secret (store owners only)","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevealWebhookSecretResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The explicit form of POST /v1/store/webhooks/endpoints/{endpointId}/secret, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/endpoints/{endpointId}/secret"}},"/v1/store/webhooks/endpoints/{endpointId}/rotate":{"post":{"operationId":"rotateWebhookSecret","summary":"Replace the signing secret. The old one keeps signing alongside the new one for the overlap","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"overlapHours":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":24},{"type":"number","const":72}]}},"required":["overlapHours"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateWebhookSecretResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/webhooks/endpoints/{endpointId}/rotate.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}/rotate"}},"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}/rotate":{"post":{"operationId":"rotateWebhookSecretWithStoreId","summary":"Replace the signing secret. The old one keeps signing alongside the new one for the overlap","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"overlapHours":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":24},{"type":"number","const":72}]}},"required":["overlapHours"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateWebhookSecretResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The explicit form of POST /v1/store/webhooks/endpoints/{endpointId}/rotate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/endpoints/{endpointId}/rotate"}},"/v1/store/webhooks/endpoints/{endpointId}/test":{"post":{"operationId":"sendWebhookTest","summary":"Send a signed webhook.test event to this endpoint now","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/webhooks/endpoints/{endpointId}/test.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}/test"}},"/v1/stores/{storeId}/webhooks/endpoints/{endpointId}/test":{"post":{"operationId":"sendWebhookTestWithStoreId","summary":"Send a signed webhook.test event to this endpoint now","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The explicit form of POST /v1/store/webhooks/endpoints/{endpointId}/test, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/endpoints/{endpointId}/test"}},"/v1/store/webhooks/deliveries":{"get":{"operationId":"listWebhookDeliveries","summary":"The delivery log, newest first (or sorted by any column)","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"endpointId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["pending","retrying","succeeded","failed"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","event","endpoint","status","response","attempts","next"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookDeliveriesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/webhooks/deliveries.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/deliveries"}},"/v1/stores/{storeId}/webhooks/deliveries":{"get":{"operationId":"listWebhookDeliveriesWithStoreId","summary":"The delivery log, newest first (or sorted by any column)","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"endpointId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["pending","retrying","succeeded","failed"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","event","endpoint","status","response","attempts","next"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookDeliveriesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:read","description":"The explicit form of GET /v1/store/webhooks/deliveries, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/deliveries"}},"/v1/store/webhooks/deliveries/{deliveryId}":{"get":{"operationId":"getWebhookDelivery","summary":"One delivery: the signed request and every attempt with its response","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string","pattern":"^whd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/webhooks/deliveries/{deliveryId}.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/deliveries/{deliveryId}"}},"/v1/stores/{storeId}/webhooks/deliveries/{deliveryId}":{"get":{"operationId":"getWebhookDeliveryWithStoreId","summary":"One delivery: the signed request and every attempt with its response","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string","pattern":"^whd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:read","description":"The explicit form of GET /v1/store/webhooks/deliveries/{deliveryId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/deliveries/{deliveryId}"}},"/v1/store/webhooks/deliveries/{deliveryId}/replay":{"post":{"operationId":"replayWebhookDelivery","summary":"Send the same event again as a new delivery","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string","pattern":"^whd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/webhooks/deliveries/{deliveryId}/replay.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/deliveries/{deliveryId}/replay"}},"/v1/stores/{storeId}/webhooks/deliveries/{deliveryId}/replay":{"post":{"operationId":"replayWebhookDeliveryWithStoreId","summary":"Send the same event again as a new delivery","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string","pattern":"^whd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"webhooks:write","description":"The explicit form of POST /v1/store/webhooks/deliveries/{deliveryId}/replay, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/deliveries/{deliveryId}/replay"}},"/v1/stores/{storeId}/api-keys":{"get":{"operationId":"listApiKeys","summary":"API keys, newest first (secrets are never returned)","tags":["api-keys"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"createApiKey","summary":"Create a scoped key. The secret is shown once, in this response","tags":["api-keys"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"scopes":{"type":"object","propertyNames":{"type":"string","enum":["store","catalog","orders","customers","marketing","storefront","analytics","balance","webhooks","security","team","audit","support","settings","payments"]},"additionalProperties":{"type":"string","enum":["none","read","write"]}},"expiresInDays":{"anyOf":[{"anyOf":[{"type":"number","const":30},{"type":"number","const":90},{"type":"number","const":365}]},{"type":"null"}]}},"required":["name","scopes","expiresInDays"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/api-keys/{keyId}":{"delete":{"operationId":"revokeApiKey","summary":"Revoke a key. Requests with it fail from now on","tags":["api-keys"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"patch":{"operationId":"updateApiKey","summary":"Limit a key to IP addresses or ranges (empty: any address)","tags":["api-keys"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedIps":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":64}}},"required":["allowedIps"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/store/storefront/checkout-settings":{"get":{"operationId":"getCheckoutSettings","summary":"Cart drawer and checkout customization","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCheckoutSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/storefront/checkout-settings.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/checkout-settings"},"put":{"operationId":"updateCheckoutSettings","summary":"Save the checkout settings","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"layout":{"default":"two_column","type":"string","enum":["two_column","one_column"]},"logo":{"default":{"kind":"name","imageUrl":null},"type":"object","properties":{"kind":{"default":"name","type":"string","enum":["name","image"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500,"pattern":"^https:\\/\\/\\S+$"},{"type":"null"}]}}},"colors":{"default":{"mode":"theme","background":"#0f0f17","surface":"#17171f","text":"#f2f2f7","muted":"#9a9aa8","accent":"#7c5cff","onAccent":"#ffffff"},"type":"object","properties":{"mode":{"default":"theme","type":"string","enum":["theme","custom"]},"background":{"default":"#0f0f17","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#17171f","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#f2f2f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#9a9aa8","type":"string","pattern":"^#[0-9a-f]{6}$"},"accent":{"default":"#7c5cff","type":"string","pattern":"^#[0-9a-f]{6}$"},"onAccent":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"}}},"fields":{"default":{"name":"required","country":"required","phone":"hidden","address":"hidden"},"type":"object","properties":{"name":{"default":"required","type":"string","enum":["required","optional","hidden"]},"country":{"default":"required","type":"string","enum":["required","optional","hidden"]},"phone":{"default":"hidden","type":"string","enum":["required","optional","hidden"]},"address":{"default":"hidden","type":"string","enum":["required","optional","hidden"]}}},"customFields":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,31}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","number","email","url","select","checkbox","discord"]},"required":{"type":"boolean"},"placeholder":{"default":"","type":"string","maxLength":80},"help":{"default":"","type":"string","maxLength":160},"options":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"productIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["id","label","type","required"]}},"showDiscountField":{"default":true,"type":"boolean"},"showGiftCardField":{"default":true,"type":"boolean"},"consent":{"default":{"enabled":true,"text":"I agree to the {link} and understand digital products are delivered instantly.","linkLabel":"Terms of Service","linkUrl":"/policies/terms-of-service"},"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"I agree to the {link} and understand digital products are delivered instantly.","type":"string","maxLength":200},"linkLabel":{"default":"Terms of Service","type":"string","maxLength":60},"linkUrl":{"default":"/policies/terms-of-service","type":"string","maxLength":500,"pattern":"^(?:\\/[^\\s]*|https:\\/\\/[^\\s]+)$"}}},"marketingOptIn":{"default":{"enabled":false,"label":"Email me about new releases and offers"},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"label":{"default":"Email me about new releases and offers","type":"string","maxLength":120}}},"trustBadges":{"default":["secure","instant","refund"],"maxItems":4,"type":"array","items":{"type":"string","enum":["secure","instant","refund","support"]}},"showOrderBumps":{"default":true,"type":"boolean"},"emailVerification":{"default":"products","type":"string","enum":["never","products","always"]},"verifyProductIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"offerAccounts":{"default":true,"type":"boolean"},"thankYou":{"default":{"heading":"Thanks for your order","message":"Your files and keys are below. We also sent them to your inbox.","redirectUrl":null,"redirectDelaySec":8},"type":"object","properties":{"heading":{"default":"Thanks for your order","type":"string","maxLength":60},"message":{"default":"Your files and keys are below. We also sent them to your inbox.","type":"string","maxLength":400},"redirectUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500,"pattern":"^(?:\\/[^\\s]*|https:\\/\\/[^\\s]+)$"},{"type":"null"}]},"redirectDelaySec":{"default":8,"type":"integer","minimum":3,"maximum":60}}},"strings":{"default":{"contactHeading":"Contact","detailsHeading":"Your details","paymentHeading":"Payment","summaryHeading":"Order summary","payButton":"Pay {amount}","freeButton":"Get it free","emailHelp":"Your receipt, keys and download links go here.","discountPlaceholder":"Discount code","giftCardPlaceholder":"Gift card code","apply":"Apply","secureNote":"Payments are encrypted and processed securely."},"type":"object","properties":{"contactHeading":{"default":"Contact","type":"string","maxLength":40},"detailsHeading":{"default":"Your details","type":"string","maxLength":40},"paymentHeading":{"default":"Payment","type":"string","maxLength":40},"summaryHeading":{"default":"Order summary","type":"string","maxLength":40},"payButton":{"default":"Pay {amount}","type":"string","maxLength":40},"freeButton":{"default":"Get it free","type":"string","maxLength":40},"emailHelp":{"default":"Your receipt, keys and download links go here.","type":"string","maxLength":120},"discountPlaceholder":{"default":"Discount code","type":"string","maxLength":40},"giftCardPlaceholder":{"default":"Gift card code","type":"string","maxLength":40},"apply":{"default":"Apply","type":"string","maxLength":20},"secureNote":{"default":"Payments are encrypted and processed securely.","type":"string","maxLength":120}}},"minOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"maxOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"cartMode":{"default":"separate","type":"string","enum":["separate","one_page"]},"methodDiscounts":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":100,"maximum":3000}},"required":["method","bps"]}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCheckoutSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/storefront/checkout-settings.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/checkout-settings"}},"/v1/stores/{storeId}/storefront/checkout-settings":{"get":{"operationId":"getCheckoutSettingsWithStoreId","summary":"Cart drawer and checkout customization","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCheckoutSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/storefront/checkout-settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/checkout-settings"},"put":{"operationId":"updateCheckoutSettingsWithStoreId","summary":"Save the checkout settings","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"layout":{"default":"two_column","type":"string","enum":["two_column","one_column"]},"logo":{"default":{"kind":"name","imageUrl":null},"type":"object","properties":{"kind":{"default":"name","type":"string","enum":["name","image"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500,"pattern":"^https:\\/\\/\\S+$"},{"type":"null"}]}}},"colors":{"default":{"mode":"theme","background":"#0f0f17","surface":"#17171f","text":"#f2f2f7","muted":"#9a9aa8","accent":"#7c5cff","onAccent":"#ffffff"},"type":"object","properties":{"mode":{"default":"theme","type":"string","enum":["theme","custom"]},"background":{"default":"#0f0f17","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#17171f","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#f2f2f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#9a9aa8","type":"string","pattern":"^#[0-9a-f]{6}$"},"accent":{"default":"#7c5cff","type":"string","pattern":"^#[0-9a-f]{6}$"},"onAccent":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"}}},"fields":{"default":{"name":"required","country":"required","phone":"hidden","address":"hidden"},"type":"object","properties":{"name":{"default":"required","type":"string","enum":["required","optional","hidden"]},"country":{"default":"required","type":"string","enum":["required","optional","hidden"]},"phone":{"default":"hidden","type":"string","enum":["required","optional","hidden"]},"address":{"default":"hidden","type":"string","enum":["required","optional","hidden"]}}},"customFields":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,31}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"type":"string","enum":["text","textarea","number","email","url","select","checkbox","discord"]},"required":{"type":"boolean"},"placeholder":{"default":"","type":"string","maxLength":80},"help":{"default":"","type":"string","maxLength":160},"options":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"productIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["id","label","type","required"]}},"showDiscountField":{"default":true,"type":"boolean"},"showGiftCardField":{"default":true,"type":"boolean"},"consent":{"default":{"enabled":true,"text":"I agree to the {link} and understand digital products are delivered instantly.","linkLabel":"Terms of Service","linkUrl":"/policies/terms-of-service"},"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"I agree to the {link} and understand digital products are delivered instantly.","type":"string","maxLength":200},"linkLabel":{"default":"Terms of Service","type":"string","maxLength":60},"linkUrl":{"default":"/policies/terms-of-service","type":"string","maxLength":500,"pattern":"^(?:\\/[^\\s]*|https:\\/\\/[^\\s]+)$"}}},"marketingOptIn":{"default":{"enabled":false,"label":"Email me about new releases and offers"},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"label":{"default":"Email me about new releases and offers","type":"string","maxLength":120}}},"trustBadges":{"default":["secure","instant","refund"],"maxItems":4,"type":"array","items":{"type":"string","enum":["secure","instant","refund","support"]}},"showOrderBumps":{"default":true,"type":"boolean"},"emailVerification":{"default":"products","type":"string","enum":["never","products","always"]},"verifyProductIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"offerAccounts":{"default":true,"type":"boolean"},"thankYou":{"default":{"heading":"Thanks for your order","message":"Your files and keys are below. We also sent them to your inbox.","redirectUrl":null,"redirectDelaySec":8},"type":"object","properties":{"heading":{"default":"Thanks for your order","type":"string","maxLength":60},"message":{"default":"Your files and keys are below. We also sent them to your inbox.","type":"string","maxLength":400},"redirectUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500,"pattern":"^(?:\\/[^\\s]*|https:\\/\\/[^\\s]+)$"},{"type":"null"}]},"redirectDelaySec":{"default":8,"type":"integer","minimum":3,"maximum":60}}},"strings":{"default":{"contactHeading":"Contact","detailsHeading":"Your details","paymentHeading":"Payment","summaryHeading":"Order summary","payButton":"Pay {amount}","freeButton":"Get it free","emailHelp":"Your receipt, keys and download links go here.","discountPlaceholder":"Discount code","giftCardPlaceholder":"Gift card code","apply":"Apply","secureNote":"Payments are encrypted and processed securely."},"type":"object","properties":{"contactHeading":{"default":"Contact","type":"string","maxLength":40},"detailsHeading":{"default":"Your details","type":"string","maxLength":40},"paymentHeading":{"default":"Payment","type":"string","maxLength":40},"summaryHeading":{"default":"Order summary","type":"string","maxLength":40},"payButton":{"default":"Pay {amount}","type":"string","maxLength":40},"freeButton":{"default":"Get it free","type":"string","maxLength":40},"emailHelp":{"default":"Your receipt, keys and download links go here.","type":"string","maxLength":120},"discountPlaceholder":{"default":"Discount code","type":"string","maxLength":40},"giftCardPlaceholder":{"default":"Gift card code","type":"string","maxLength":40},"apply":{"default":"Apply","type":"string","maxLength":20},"secureNote":{"default":"Payments are encrypted and processed securely.","type":"string","maxLength":120}}},"minOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"maxOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"cartMode":{"default":"separate","type":"string","enum":["separate","one_page"]},"methodDiscounts":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"method":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"bps":{"type":"integer","minimum":100,"maximum":3000}},"required":["method","bps"]}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCheckoutSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/storefront/checkout-settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/checkout-settings"}},"/v1/store/storefront/cart-settings":{"put":{"operationId":"updateCartSettings","summary":"Save the cart drawer settings","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"default":"drawer","type":"string","enum":["drawer","page"]},"side":{"default":"right","type":"string","enum":["right","left"]},"width":{"default":420,"type":"integer","minimum":340,"maximum":560},"showUpsells":{"default":true,"type":"boolean"},"upsellHeading":{"default":"Pairs well with","type":"string","maxLength":60},"showDiscountField":{"default":true,"type":"boolean"},"showGiftCardField":{"default":true,"type":"boolean"},"showNotes":{"default":false,"type":"boolean"},"notesLabel":{"default":"Note for the seller","type":"string","maxLength":60},"showTrustLine":{"default":true,"type":"boolean"},"trustLine":{"default":"Instant delivery to your inbox. Secure checkout.","type":"string","maxLength":120},"showProgress":{"default":true,"type":"boolean"},"progressMessage":{"default":"Add {remaining} more to get {reward}","type":"string","maxLength":120},"progressReachedMessage":{"default":"You unlocked {reward}","type":"string","maxLength":120},"labels":{"default":{"title":"Your cart","checkout":"Check out","viewCart":"View cart","continueShopping":"Keep shopping","emptyTitle":"Your cart is empty","emptyBody":"Browse the catalog and add something you like.","emptyCta":"Browse products"},"type":"object","properties":{"title":{"default":"Your cart","type":"string","maxLength":40},"checkout":{"default":"Check out","type":"string","maxLength":40},"viewCart":{"default":"View cart","type":"string","maxLength":40},"continueShopping":{"default":"Keep shopping","type":"string","maxLength":40},"emptyTitle":{"default":"Your cart is empty","type":"string","maxLength":60},"emptyBody":{"default":"Browse the catalog and add something you like.","type":"string","maxLength":160},"emptyCta":{"default":"Browse products","type":"string","maxLength":40}}},"colors":{"default":{"mode":"theme","background":"#0f0f17","surface":"#17171f","text":"#f2f2f7","muted":"#9a9aa8","accent":"#7c5cff","onAccent":"#ffffff"},"type":"object","properties":{"mode":{"default":"theme","type":"string","enum":["theme","custom"]},"background":{"default":"#0f0f17","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#17171f","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#f2f2f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#9a9aa8","type":"string","pattern":"^#[0-9a-f]{6}$"},"accent":{"default":"#7c5cff","type":"string","pattern":"^#[0-9a-f]{6}$"},"onAccent":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCheckoutSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/storefront/cart-settings.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/cart-settings"}},"/v1/stores/{storeId}/storefront/cart-settings":{"put":{"operationId":"updateCartSettingsWithStoreId","summary":"Save the cart drawer settings","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"default":"drawer","type":"string","enum":["drawer","page"]},"side":{"default":"right","type":"string","enum":["right","left"]},"width":{"default":420,"type":"integer","minimum":340,"maximum":560},"showUpsells":{"default":true,"type":"boolean"},"upsellHeading":{"default":"Pairs well with","type":"string","maxLength":60},"showDiscountField":{"default":true,"type":"boolean"},"showGiftCardField":{"default":true,"type":"boolean"},"showNotes":{"default":false,"type":"boolean"},"notesLabel":{"default":"Note for the seller","type":"string","maxLength":60},"showTrustLine":{"default":true,"type":"boolean"},"trustLine":{"default":"Instant delivery to your inbox. Secure checkout.","type":"string","maxLength":120},"showProgress":{"default":true,"type":"boolean"},"progressMessage":{"default":"Add {remaining} more to get {reward}","type":"string","maxLength":120},"progressReachedMessage":{"default":"You unlocked {reward}","type":"string","maxLength":120},"labels":{"default":{"title":"Your cart","checkout":"Check out","viewCart":"View cart","continueShopping":"Keep shopping","emptyTitle":"Your cart is empty","emptyBody":"Browse the catalog and add something you like.","emptyCta":"Browse products"},"type":"object","properties":{"title":{"default":"Your cart","type":"string","maxLength":40},"checkout":{"default":"Check out","type":"string","maxLength":40},"viewCart":{"default":"View cart","type":"string","maxLength":40},"continueShopping":{"default":"Keep shopping","type":"string","maxLength":40},"emptyTitle":{"default":"Your cart is empty","type":"string","maxLength":60},"emptyBody":{"default":"Browse the catalog and add something you like.","type":"string","maxLength":160},"emptyCta":{"default":"Browse products","type":"string","maxLength":40}}},"colors":{"default":{"mode":"theme","background":"#0f0f17","surface":"#17171f","text":"#f2f2f7","muted":"#9a9aa8","accent":"#7c5cff","onAccent":"#ffffff"},"type":"object","properties":{"mode":{"default":"theme","type":"string","enum":["theme","custom"]},"background":{"default":"#0f0f17","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#17171f","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#f2f2f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#9a9aa8","type":"string","pattern":"^#[0-9a-f]{6}$"},"accent":{"default":"#7c5cff","type":"string","pattern":"^#[0-9a-f]{6}$"},"onAccent":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontCheckoutSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/storefront/cart-settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/cart-settings"}},"/v1/store/discounts":{"get":{"operationId":"listDiscounts","summary":"Discount codes and automatic discounts with uses and revenue","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","scheduled","expired","disabled"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDiscountsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/discounts.","x-store-explicit-path":"/v1/stores/{storeId}/discounts"},"post":{"operationId":"createDiscount","summary":"Create a discount","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["code","automatic"]},"code":{"anyOf":[{"type":"string","minLength":3,"maxLength":32,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":80},"valueType":{"type":"string","enum":["percent","fixed","free"]},"value":{"type":"integer","minimum":0,"maximum":9007199254740991},"scope":{"type":"string","enum":["all","products","collections","categories"]},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"minSubtotalMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"usageLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"perCustomerLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"combinable":{"type":"boolean"},"autoAddFreeProducts":{"type":"boolean"},"enabled":{"type":"boolean"},"disabledMethods":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"variantIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"showInAccount":{"default":false,"type":"boolean"},"firstOrderOnly":{"default":false,"type":"boolean"},"minQuantity":{"default":0,"type":"integer","minimum":0,"maximum":1000},"durations":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"rule":{"default":{"type":"standard"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"standard"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"bogo"},"buy":{"type":"integer","minimum":1,"maximum":20},"get":{"type":"integer","minimum":1,"maximum":20},"percentBps":{"type":"integer","minimum":1,"maximum":10000},"maxUses":{"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]}},"required":["type","buy","get","percentBps","maxUses"]},{"type":"object","properties":{"type":{"type":"string","const":"tiered"},"basis":{"type":"string","enum":["quantity","subtotal"]},"tiers":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"object","properties":{"threshold":{"type":"integer","minimum":1,"maximum":100000000},"percentBps":{"type":"integer","minimum":1,"maximum":10000}},"required":["threshold","percentBps"]}}},"required":["type","basis","tiers"]},{"type":"object","properties":{"type":{"type":"string","const":"duration_bonus"},"from":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]},"bonus":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"required":["type","from","bonus"]}]},"excludeSaleItems":{"default":false,"type":"boolean"},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100},"activeHours":{"default":null,"anyOf":[{"type":"object","properties":{"days":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"from":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"to":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"timezone":{"type":"string","maxLength":64}},"required":["days","from","to","timezone"]},{"type":"null"}]},"bulkCodes":{"default":false,"type":"boolean"}},"required":["kind","code","title","valueType","value","scope","productIds","collectionIds","minSubtotalMinor","usageLimit","perCustomerLimit","startsAt","endsAt","combinable","autoAddFreeProducts","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/discounts.","x-store-explicit-path":"/v1/stores/{storeId}/discounts"}},"/v1/stores/{storeId}/discounts":{"get":{"operationId":"listDiscountsWithStoreId","summary":"Discount codes and automatic discounts with uses and revenue","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","scheduled","expired","disabled"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDiscountsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/discounts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts"},"post":{"operationId":"createDiscountWithStoreId","summary":"Create a discount","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["code","automatic"]},"code":{"anyOf":[{"type":"string","minLength":3,"maxLength":32,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":80},"valueType":{"type":"string","enum":["percent","fixed","free"]},"value":{"type":"integer","minimum":0,"maximum":9007199254740991},"scope":{"type":"string","enum":["all","products","collections","categories"]},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"minSubtotalMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"usageLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"perCustomerLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"combinable":{"type":"boolean"},"autoAddFreeProducts":{"type":"boolean"},"enabled":{"type":"boolean"},"disabledMethods":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"variantIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"showInAccount":{"default":false,"type":"boolean"},"firstOrderOnly":{"default":false,"type":"boolean"},"minQuantity":{"default":0,"type":"integer","minimum":0,"maximum":1000},"durations":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"rule":{"default":{"type":"standard"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"standard"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"bogo"},"buy":{"type":"integer","minimum":1,"maximum":20},"get":{"type":"integer","minimum":1,"maximum":20},"percentBps":{"type":"integer","minimum":1,"maximum":10000},"maxUses":{"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]}},"required":["type","buy","get","percentBps","maxUses"]},{"type":"object","properties":{"type":{"type":"string","const":"tiered"},"basis":{"type":"string","enum":["quantity","subtotal"]},"tiers":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"object","properties":{"threshold":{"type":"integer","minimum":1,"maximum":100000000},"percentBps":{"type":"integer","minimum":1,"maximum":10000}},"required":["threshold","percentBps"]}}},"required":["type","basis","tiers"]},{"type":"object","properties":{"type":{"type":"string","const":"duration_bonus"},"from":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]},"bonus":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"required":["type","from","bonus"]}]},"excludeSaleItems":{"default":false,"type":"boolean"},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100},"activeHours":{"default":null,"anyOf":[{"type":"object","properties":{"days":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"from":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"to":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"timezone":{"type":"string","maxLength":64}},"required":["days","from","to","timezone"]},{"type":"null"}]},"bulkCodes":{"default":false,"type":"boolean"}},"required":["kind","code","title","valueType","value","scope","productIds","collectionIds","minSubtotalMinor","usageLimit","perCustomerLimit","startsAt","endsAt","combinable","autoAddFreeProducts","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/discounts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts"}},"/v1/store/discounts/{discountId}":{"put":{"operationId":"updateDiscount","summary":"Update a discount (orders already paid keep their discount)","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["code","automatic"]},"code":{"anyOf":[{"type":"string","minLength":3,"maxLength":32,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":80},"valueType":{"type":"string","enum":["percent","fixed","free"]},"value":{"type":"integer","minimum":0,"maximum":9007199254740991},"scope":{"type":"string","enum":["all","products","collections","categories"]},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"minSubtotalMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"usageLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"perCustomerLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"combinable":{"type":"boolean"},"autoAddFreeProducts":{"type":"boolean"},"enabled":{"type":"boolean"},"disabledMethods":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"variantIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"showInAccount":{"default":false,"type":"boolean"},"firstOrderOnly":{"default":false,"type":"boolean"},"minQuantity":{"default":0,"type":"integer","minimum":0,"maximum":1000},"durations":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"rule":{"default":{"type":"standard"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"standard"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"bogo"},"buy":{"type":"integer","minimum":1,"maximum":20},"get":{"type":"integer","minimum":1,"maximum":20},"percentBps":{"type":"integer","minimum":1,"maximum":10000},"maxUses":{"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]}},"required":["type","buy","get","percentBps","maxUses"]},{"type":"object","properties":{"type":{"type":"string","const":"tiered"},"basis":{"type":"string","enum":["quantity","subtotal"]},"tiers":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"object","properties":{"threshold":{"type":"integer","minimum":1,"maximum":100000000},"percentBps":{"type":"integer","minimum":1,"maximum":10000}},"required":["threshold","percentBps"]}}},"required":["type","basis","tiers"]},{"type":"object","properties":{"type":{"type":"string","const":"duration_bonus"},"from":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]},"bonus":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"required":["type","from","bonus"]}]},"excludeSaleItems":{"default":false,"type":"boolean"},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100},"activeHours":{"default":null,"anyOf":[{"type":"object","properties":{"days":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"from":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"to":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"timezone":{"type":"string","maxLength":64}},"required":["days","from","to","timezone"]},{"type":"null"}]},"bulkCodes":{"default":false,"type":"boolean"}},"required":["kind","code","title","valueType","value","scope","productIds","collectionIds","minSubtotalMinor","usageLimit","perCustomerLimit","startsAt","endsAt","combinable","autoAddFreeProducts","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/discounts/{discountId}.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}"},"delete":{"operationId":"deleteDiscount","summary":"Delete a discount that was never used (disable used ones)","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/discounts/{discountId}.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}"}},"/v1/stores/{storeId}/discounts/{discountId}":{"put":{"operationId":"updateDiscountWithStoreId","summary":"Update a discount (orders already paid keep their discount)","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["code","automatic"]},"code":{"anyOf":[{"type":"string","minLength":3,"maxLength":32,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":80},"valueType":{"type":"string","enum":["percent","fixed","free"]},"value":{"type":"integer","minimum":0,"maximum":9007199254740991},"scope":{"type":"string","enum":["all","products","collections","categories"]},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"minSubtotalMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"usageLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"perCustomerLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"combinable":{"type":"boolean"},"autoAddFreeProducts":{"type":"boolean"},"enabled":{"type":"boolean"},"disabledMethods":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]}},"variantIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"showInAccount":{"default":false,"type":"boolean"},"firstOrderOnly":{"default":false,"type":"boolean"},"minQuantity":{"default":0,"type":"integer","minimum":0,"maximum":1000},"durations":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"rule":{"default":{"type":"standard"},"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"standard"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"bogo"},"buy":{"type":"integer","minimum":1,"maximum":20},"get":{"type":"integer","minimum":1,"maximum":20},"percentBps":{"type":"integer","minimum":1,"maximum":10000},"maxUses":{"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]}},"required":["type","buy","get","percentBps","maxUses"]},{"type":"object","properties":{"type":{"type":"string","const":"tiered"},"basis":{"type":"string","enum":["quantity","subtotal"]},"tiers":{"minItems":1,"maxItems":6,"type":"array","items":{"type":"object","properties":{"threshold":{"type":"integer","minimum":1,"maximum":100000000},"percentBps":{"type":"integer","minimum":1,"maximum":10000}},"required":["threshold","percentBps"]}}},"required":["type","basis","tiers"]},{"type":"object","properties":{"type":{"type":"string","const":"duration_bonus"},"from":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]},"bonus":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]}},"required":["type","from","bonus"]}]},"excludeSaleItems":{"default":false,"type":"boolean"},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100},"activeHours":{"default":null,"anyOf":[{"type":"object","properties":{"days":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"from":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"to":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"timezone":{"type":"string","maxLength":64}},"required":["days","from","to","timezone"]},{"type":"null"}]},"bulkCodes":{"default":false,"type":"boolean"}},"required":["kind","code","title","valueType","value","scope","productIds","collectionIds","minSubtotalMinor","usageLimit","perCustomerLimit","startsAt","endsAt","combinable","autoAddFreeProducts","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PUT /v1/store/discounts/{discountId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}"},"delete":{"operationId":"deleteDiscountWithStoreId","summary":"Delete a discount that was never used (disable used ones)","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of DELETE /v1/store/discounts/{discountId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}"}},"/v1/store/gift-cards":{"get":{"operationId":"listGiftCards","summary":"Gift cards with balances","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","used","expired","disabled"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGiftCardsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/gift-cards.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards"},"post":{"operationId":"issueGiftCard","summary":"Issue a gift card. The full code is returned once, here","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":100,"maximum":100000000},"recipientEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"recipientName":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"note":{"type":"string","maxLength":280},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"send":{"type":"boolean"},"code":{"default":null,"anyOf":[{"type":"string","minLength":8,"maxLength":40,"pattern":"^[A-Za-z0-9 -]+$"},{"type":"null"}]}},"required":["amountMinor","recipientEmail","recipientName","note","expiresAt","send"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gift-cards.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards"}},"/v1/stores/{storeId}/gift-cards":{"get":{"operationId":"listGiftCardsWithStoreId","summary":"Gift cards with balances","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","used","expired","disabled"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGiftCardsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/gift-cards, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards"},"post":{"operationId":"issueGiftCardWithStoreId","summary":"Issue a gift card. The full code is returned once, here","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":100,"maximum":100000000},"recipientEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"recipientName":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"note":{"type":"string","maxLength":280},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"send":{"type":"boolean"},"code":{"default":null,"anyOf":[{"type":"string","minLength":8,"maxLength":40,"pattern":"^[A-Za-z0-9 -]+$"},{"type":"null"}]}},"required":["amountMinor","recipientEmail","recipientName","note","expiresAt","send"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/gift-cards, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards"}},"/v1/store/gift-cards/{giftCardId}":{"get":{"operationId":"getGiftCard","summary":"A gift card and its history","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/gift-cards/{giftCardId}.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards/{giftCardId}"},"patch":{"operationId":"updateGiftCard","summary":"Adjust the balance, disable or re-enable, or change the expiry","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"adjustMinor":{"anyOf":[{"type":"integer","minimum":-100000000,"maximum":100000000},{"type":"null"}]},"enabled":{"type":["boolean","null"]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"note":{"type":"string","maxLength":280}},"required":["adjustMinor","enabled","expiresAt","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/gift-cards/{giftCardId}.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards/{giftCardId}"},"delete":{"operationId":"deleteGiftCard","summary":"Delete a gift card that was never used (disable used ones so their history stays)","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/gift-cards/{giftCardId}.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards/{giftCardId}"}},"/v1/stores/{storeId}/gift-cards/{giftCardId}":{"get":{"operationId":"getGiftCardWithStoreId","summary":"A gift card and its history","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/gift-cards/{giftCardId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards/{giftCardId}"},"patch":{"operationId":"updateGiftCardWithStoreId","summary":"Adjust the balance, disable or re-enable, or change the expiry","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"adjustMinor":{"anyOf":[{"type":"integer","minimum":-100000000,"maximum":100000000},{"type":"null"}]},"enabled":{"type":["boolean","null"]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"note":{"type":"string","maxLength":280}},"required":["adjustMinor","enabled","expiresAt","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PATCH /v1/store/gift-cards/{giftCardId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards/{giftCardId}"},"delete":{"operationId":"deleteGiftCardWithStoreId","summary":"Delete a gift card that was never used (disable used ones so their history stays)","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of DELETE /v1/store/gift-cards/{giftCardId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards/{giftCardId}"}},"/v1/storefront/stores/{storeId}/checkout-config":{"get":{"operationId":"storefrontCheckoutConfig","summary":"Cart and checkout settings and how buyers can pay","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutConfig"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts":{"post":{"operationId":"storefrontCreateCart","summary":"Start an empty cart (the id is the capability)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"lines":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"default":null,"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"customPriceMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"addOnOf":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"options":{"default":{},"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":80}},"quantity":{"type":"integer","minimum":1,"maximum":100}},"required":["productId","quantity"]}}},"required":["lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}":{"get":{"operationId":"storefrontGetCart","summary":"A priced cart (tax once the country is known)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"patch":{"operationId":"storefrontUpdateCart","summary":"Note, prefilled details and country","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","maxLength":500},"email":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"returnUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"cancelUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}/lines":{"post":{"operationId":"storefrontAddCartLines","summary":"Add products (same product and options merge)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"lines":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"default":null,"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"customPriceMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"addOnOf":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"options":{"default":{},"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":80}},"quantity":{"type":"integer","minimum":1,"maximum":100}},"required":["productId","quantity"]}}},"required":["lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}/lines/{lineId}":{"patch":{"operationId":"storefrontUpdateCartLine","summary":"Change a quantity (0 removes the line)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"string","pattern":"^ln_[0-9a-hjkmnp-tv-z]{10}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quantity":{"type":"integer","minimum":0,"maximum":100}},"required":["quantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}/codes":{"post":{"operationId":"storefrontApplyCartCode","summary":"Apply a discount code or a gift card (auto tells them apart)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["auto","discount","gift_card"]},"code":{"type":"string","minLength":1,"maxLength":40}},"required":["kind","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}/codes/{kind}":{"delete":{"operationId":"storefrontRemoveCartCode","summary":"Remove the discount code or gift card","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["discount","gift_card"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}/checkout":{"post":{"operationId":"storefrontStartCheckout","summary":"Validate details, run fraud checks, price the cart and open a checkout session. 409 email-verification-required sends a code","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"name":{"type":"string","maxLength":120},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"address":{"anyOf":[{"type":"object","properties":{"line1":{"type":"string","minLength":1,"maxLength":120},"line2":{"type":"string","maxLength":120},"city":{"type":"string","minLength":1,"maxLength":80},"region":{"type":"string","maxLength":80},"postalCode":{"type":"string","maxLength":20}},"required":["line1","line2","city","region","postalCode"]},{"type":"null"}]},"customFields":{"type":"object","propertyNames":{"type":"string","maxLength":32},"additionalProperties":{"type":"string","maxLength":1000}},"consent":{"type":"boolean"},"marketingOptIn":{"type":"boolean"},"provider":{"anyOf":[{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},{"type":"null"}]},"method":{"anyOf":[{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},{"type":"null"}]},"option":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{1,39}$"},{"type":"null"}]},"verificationCode":{"anyOf":[{"type":"string","pattern":"^\\d{6}$"},{"type":"null"}]},"useStoreCredit":{"default":false,"type":"boolean"},"manualMethodId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tipMinor":{"default":0,"type":"integer","minimum":0,"maximum":10000000},"autoRenew":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"consentText":{"type":"string","minLength":1,"maxLength":300}},"required":["productId","variantId","consentText"]}},"withdrawalWaiver":{"default":false,"type":"boolean"},"company":{"default":"","type":"string","maxLength":120},"taxId":{"default":"","type":"string","maxLength":40},"returnUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"cancelUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]}},"required":["email","name","country","phone","address","customFields","consent","marketingOptIn","provider","method","verificationCode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCheckoutResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}/page":{"get":{"operationId":"storefrontOrderPage","summary":"The order page: status for the session id, keys and downloads only with the access token or the signed-in buyer","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPage"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}/claim":{"post":{"operationId":"storefrontClaimOrder","summary":"Start an account for the order's email: emails a sign-in code (the access token proves it is the buyer's order)","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","minLength":20,"maxLength":200}},"required":["access"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontClaimOrderResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"get":{"operationId":"getClaim","summary":"The buyer's claim on this order, if any","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetClaimResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/code":{"post":{"operationId":"buyerRequestCode","summary":"Email a one-time sign-in code (rate limited)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/verify":{"post":{"operationId":"buyerVerifyCode","summary":"Trade the code for a session; creates the account on first sign-in","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["email","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerSessionResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/login":{"post":{"operationId":"buyerPasswordLogin","summary":"Sign in with a password (accounts that set one)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"password":{"type":"string","minLength":1,"maxLength":200}},"required":["email","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerSessionResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account":{"get":{"operationId":"buyerMe","summary":"The signed-in buyer","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerMeResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"patch":{"operationId":"buyerUpdateProfile","summary":"Name, phone, country and email preferences","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"phone":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"marketingOptIn":{"type":"boolean"}},"required":["name","phone","country","marketingOptIn"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerUpdateProfileResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/password":{"put":{"operationId":"buyerSetPassword","summary":"Set or change the optional password","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","minLength":10,"maxLength":200}},"required":["password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerSetPasswordResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/orders":{"get":{"operationId":"buyerOrders","summary":"The buyer's orders in this store (every order placed with their email)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOrdersResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/library":{"get":{"operationId":"buyerLibrary","summary":"Downloads (fresh signed links), license keys and subscriptions","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerLibrary"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/subscriptions/{subscriptionId}/cancel":{"post":{"operationId":"buyerCancelSubscription","summary":"Cancel at the end of the period","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","pattern":"^sub_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerSubscription"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/logout":{"post":{"operationId":"buyerLogout","summary":"End the buyer session","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/access":{"get":{"operationId":"getMyAccess","summary":"Your role and permissions in this store (the dashboard hides what you cannot use)","tags":["access"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreAccess"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/store/settings/general":{"get":{"operationId":"getStoreGeneral","summary":"Store profile, branding, status, locale and legal details","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/settings/general.","x-store-explicit-path":"/v1/stores/{storeId}/settings/general"},"patch":{"operationId":"updateStoreGeneral","summary":"Update the store profile, brand color, storefront status, time zone, currency display or legal details","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"tagline":{"type":"string","maxLength":160},"supportEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"brandColor":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"status":{"type":"string","enum":["open","closed","maintenance"]},"statusMessage":{"type":"string","maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":64},"currencyDisplay":{"type":"string","enum":["symbol","code"]},"legal":{"type":"object","properties":{"businessName":{"type":"string","maxLength":120},"registrationNumber":{"type":"string","maxLength":60},"vatNumber":{"type":"string","maxLength":40},"addressLine1":{"type":"string","maxLength":120},"addressLine2":{"type":"string","maxLength":120},"city":{"type":"string","maxLength":80},"postalCode":{"type":"string","maxLength":20},"region":{"type":"string","maxLength":80},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"required":["businessName","registrationNumber","vatNumber","addressLine1","addressLine2","city","postalCode","region","country"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/settings/general.","x-store-explicit-path":"/v1/stores/{storeId}/settings/general"}},"/v1/stores/{storeId}/settings/general":{"get":{"operationId":"getStoreGeneralWithStoreId","summary":"Store profile, branding, status, locale and legal details","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The explicit form of GET /v1/store/settings/general, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/general"},"patch":{"operationId":"updateStoreGeneralWithStoreId","summary":"Update the store profile, brand color, storefront status, time zone, currency display or legal details","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"tagline":{"type":"string","maxLength":160},"supportEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"brandColor":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"status":{"type":"string","enum":["open","closed","maintenance"]},"statusMessage":{"type":"string","maxLength":500},"timezone":{"type":"string","minLength":1,"maxLength":64},"currencyDisplay":{"type":"string","enum":["symbol","code"]},"legal":{"type":"object","properties":{"businessName":{"type":"string","maxLength":120},"registrationNumber":{"type":"string","maxLength":60},"vatNumber":{"type":"string","maxLength":40},"addressLine1":{"type":"string","maxLength":120},"addressLine2":{"type":"string","maxLength":120},"city":{"type":"string","maxLength":80},"postalCode":{"type":"string","maxLength":20},"region":{"type":"string","maxLength":80},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"required":["businessName","registrationNumber","vatNumber","addressLine1","addressLine2","city","postalCode","region","country"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of PATCH /v1/store/settings/general, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/general"}},"/v1/store/settings/handle":{"put":{"operationId":"changeStoreHandle","summary":"Change the store address; the old address keeps redirecting","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"}},"required":["handle"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/settings/handle.","x-store-explicit-path":"/v1/stores/{storeId}/settings/handle"},"get":{"operationId":"checkStoreHandle","summary":"Is a store address free?","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[{"name":"handle","in":"query","required":true,"schema":{"type":"string","maxLength":60}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStoreHandleResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/settings/handle.","x-store-explicit-path":"/v1/stores/{storeId}/settings/handle"}},"/v1/stores/{storeId}/settings/handle":{"put":{"operationId":"changeStoreHandleWithStoreId","summary":"Change the store address; the old address keeps redirecting","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"}},"required":["handle"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of PUT /v1/store/settings/handle, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/handle"},"get":{"operationId":"checkStoreHandleWithStoreId","summary":"Is a store address free?","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"handle","in":"query","required":true,"schema":{"type":"string","maxLength":60}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStoreHandleResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The explicit form of GET /v1/store/settings/handle, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/handle"}},"/v1/store/settings/assets":{"post":{"operationId":"uploadStoreAsset","summary":"Use a finished image upload as the logo or favicon","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["logo","favicon"]},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","uploadId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/settings/assets.","x-store-explicit-path":"/v1/stores/{storeId}/settings/assets"}},"/v1/stores/{storeId}/settings/assets":{"post":{"operationId":"uploadStoreAssetWithStoreId","summary":"Use a finished image upload as the logo or favicon","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["logo","favicon"]},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","uploadId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of POST /v1/store/settings/assets, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/assets"}},"/v1/store/settings/assets/{kind}":{"delete":{"operationId":"deleteStoreAsset","summary":"Remove the logo or favicon","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["logo","favicon"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/settings/assets/{kind}.","x-store-explicit-path":"/v1/stores/{storeId}/settings/assets/{kind}"}},"/v1/stores/{storeId}/settings/assets/{kind}":{"delete":{"operationId":"deleteStoreAssetWithStoreId","summary":"Remove the logo or favicon","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["logo","favicon"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreGeneral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of DELETE /v1/store/settings/assets/{kind}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/assets/{kind}"}},"/v1/store/settings/notifications":{"get":{"operationId":"getNotificationSettings","summary":"Which events reach whom, the Discord and Telegram channels and recent deliveries","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/settings/notifications.","x-store-explicit-path":"/v1/stores/{storeId}/settings/notifications"}},"/v1/stores/{storeId}/settings/notifications":{"get":{"operationId":"getNotificationSettingsWithStoreId","summary":"Which events reach whom, the Discord and Telegram channels and recent deliveries","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The explicit form of GET /v1/store/settings/notifications, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/notifications"}},"/v1/store/settings/notifications/deliveries":{"get":{"operationId":"listNotificationDeliveries","summary":"Alerts and tests ShopFast sent for this store, newest first (or by alert, channel, recipient or status)","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"channel","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["owner_email","team_email","discord","telegram"]},{"type":"null"}]}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["sent","simulated","failed"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","event","channel","target","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotificationDeliveriesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/settings/notifications/deliveries.","x-store-explicit-path":"/v1/stores/{storeId}/settings/notifications/deliveries"}},"/v1/stores/{storeId}/settings/notifications/deliveries":{"get":{"operationId":"listNotificationDeliveriesWithStoreId","summary":"Alerts and tests ShopFast sent for this store, newest first (or by alert, channel, recipient or status)","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"channel","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["owner_email","team_email","discord","telegram"]},{"type":"null"}]}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["sent","simulated","failed"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","event","channel","target","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotificationDeliveriesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The explicit form of GET /v1/store/settings/notifications/deliveries, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/notifications/deliveries"}},"/v1/store/settings/notifications/rules":{"put":{"operationId":"updateNotificationRules","summary":"Save the event × channel toggles and which team members get team emails","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["order_paid","order_refunded","order_disputed","product_low_stock","product_out_of_stock","product_restocked","review_posted","subscription_renewed","subscription_cancelled","payout_sent","team_member_joined","checkout_blocked","security_alert","ticket_opened","ticket_replied","ticket_sla_breached","ticket_rated","discord_problem","payment_waiting","payment_review"]},"ownerEmail":{"type":"boolean"},"teamEmail":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["event","ownerEmail","teamEmail","discord","telegram"]}},"teamRecipients":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","maxLength":40},"enabled":{"type":"boolean"}},"required":["userId","enabled"]}}},"required":["rules","teamRecipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/settings/notifications/rules.","x-store-explicit-path":"/v1/stores/{storeId}/settings/notifications/rules"}},"/v1/stores/{storeId}/settings/notifications/rules":{"put":{"operationId":"updateNotificationRulesWithStoreId","summary":"Save the event × channel toggles and which team members get team emails","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["order_paid","order_refunded","order_disputed","product_low_stock","product_out_of_stock","product_restocked","review_posted","subscription_renewed","subscription_cancelled","payout_sent","team_member_joined","checkout_blocked","security_alert","ticket_opened","ticket_replied","ticket_sla_breached","ticket_rated","discord_problem","payment_waiting","payment_review"]},"ownerEmail":{"type":"boolean"},"teamEmail":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["event","ownerEmail","teamEmail","discord","telegram"]}},"teamRecipients":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","maxLength":40},"enabled":{"type":"boolean"}},"required":["userId","enabled"]}}},"required":["rules","teamRecipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of PUT /v1/store/settings/notifications/rules, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/notifications/rules"}},"/v1/store/settings/notifications/channel":{"put":{"operationId":"setNotificationChannel","summary":"Connect or clear the Discord webhook or the Telegram bot (secrets are encrypted and never sent back)","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"channel":{"type":"string","const":"discord"},"webhookUrl":{"anyOf":[{"type":"string","maxLength":300,"pattern":"^https:\\/\\/(?:ptb\\.|canary\\.)?discord(?:app)?\\.com\\/api\\/webhooks\\/\\d{5,25}\\/[A-Za-z0-9_-]{20,100}$"},{"type":"null"}]}},"required":["channel","webhookUrl"]},{"type":"object","properties":{"channel":{"type":"string","const":"telegram"},"botToken":{"anyOf":[{"type":"string","pattern":"^\\d{5,15}:[A-Za-z0-9_-]{30,50}$"},{"type":"null"}]},"chatId":{"anyOf":[{"type":"string","pattern":"^(?:-?\\d{3,20}|@[A-Za-z0-9_]{5,32})$"},{"type":"null"}]}},"required":["channel","botToken","chatId"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/settings/notifications/channel.","x-store-explicit-path":"/v1/stores/{storeId}/settings/notifications/channel"}},"/v1/stores/{storeId}/settings/notifications/channel":{"put":{"operationId":"setNotificationChannelWithStoreId","summary":"Connect or clear the Discord webhook or the Telegram bot (secrets are encrypted and never sent back)","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"channel":{"type":"string","const":"discord"},"webhookUrl":{"anyOf":[{"type":"string","maxLength":300,"pattern":"^https:\\/\\/(?:ptb\\.|canary\\.)?discord(?:app)?\\.com\\/api\\/webhooks\\/\\d{5,25}\\/[A-Za-z0-9_-]{20,100}$"},{"type":"null"}]}},"required":["channel","webhookUrl"]},{"type":"object","properties":{"channel":{"type":"string","const":"telegram"},"botToken":{"anyOf":[{"type":"string","pattern":"^\\d{5,15}:[A-Za-z0-9_-]{30,50}$"},{"type":"null"}]},"chatId":{"anyOf":[{"type":"string","pattern":"^(?:-?\\d{3,20}|@[A-Za-z0-9_]{5,32})$"},{"type":"null"}]}},"required":["channel","botToken","chatId"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of PUT /v1/store/settings/notifications/channel, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/notifications/channel"}},"/v1/store/settings/notifications/test":{"post":{"operationId":"testNotification","summary":"Send a test notification to one channel","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","enum":["owner_email","team_email","discord","telegram"]}},"required":["channel"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDelivery"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/settings/notifications/test.","x-store-explicit-path":"/v1/stores/{storeId}/settings/notifications/test"}},"/v1/stores/{storeId}/settings/notifications/test":{"post":{"operationId":"testNotificationWithStoreId","summary":"Send a test notification to one channel","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","enum":["owner_email","team_email","discord","telegram"]}},"required":["channel"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDelivery"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of POST /v1/store/settings/notifications/test, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/notifications/test"}},"/v1/store/team":{"get":{"operationId":"getTeam","summary":"Members, pending invites, custom roles and your own access","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:read","x-api-key-scope":"team:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/team.","x-store-explicit-path":"/v1/stores/{storeId}/team"}},"/v1/stores/{storeId}/team":{"get":{"operationId":"getTeamWithStoreId","summary":"Members, pending invites, custom roles and your own access","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:read","x-api-key-scope":"team:read","description":"The explicit form of GET /v1/store/team, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team"}},"/v1/store/team/invites":{"post":{"operationId":"inviteMember","summary":"Invite someone by email. The link works for 7 days.","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"assignment":{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]},"department":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"expiresInHours":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":720},{"type":"null"}]}},"required":["email","assignment"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteMemberResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/invites.","x-store-explicit-path":"/v1/stores/{storeId}/team/invites"}},"/v1/stores/{storeId}/team/invites":{"post":{"operationId":"inviteMemberWithStoreId","summary":"Invite someone by email. The link works for 7 days.","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"assignment":{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]},"department":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"expiresInHours":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":720},{"type":"null"}]}},"required":["email","assignment"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteMemberResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/invites, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/invites"}},"/v1/store/team/invites/{inviteId}/resend":{"post":{"operationId":"resendInvite","summary":"Send the invite again with a new link and a fresh 7 days","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendInviteResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/invites/{inviteId}/resend.","x-store-explicit-path":"/v1/stores/{storeId}/team/invites/{inviteId}/resend"}},"/v1/stores/{storeId}/team/invites/{inviteId}/resend":{"post":{"operationId":"resendInviteWithStoreId","summary":"Send the invite again with a new link and a fresh 7 days","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendInviteResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/invites/{inviteId}/resend, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/invites/{inviteId}/resend"}},"/v1/store/team/invites/{inviteId}":{"delete":{"operationId":"revokeInvite","summary":"Cancel a pending invite","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/team/invites/{inviteId}.","x-store-explicit-path":"/v1/stores/{storeId}/team/invites/{inviteId}"}},"/v1/stores/{storeId}/team/invites/{inviteId}":{"delete":{"operationId":"revokeInviteWithStoreId","summary":"Cancel a pending invite","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of DELETE /v1/store/team/invites/{inviteId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/invites/{inviteId}"}},"/v1/store/team/members/{userId}/role":{"put":{"operationId":"updateMemberRole","summary":"Change a member's role (the owner's role changes only through a transfer)","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/team/members/{userId}/role.","x-store-explicit-path":"/v1/stores/{storeId}/team/members/{userId}/role"}},"/v1/stores/{storeId}/team/members/{userId}/role":{"put":{"operationId":"updateMemberRoleWithStoreId","summary":"Change a member's role (the owner's role changes only through a transfer)","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of PUT /v1/store/team/members/{userId}/role, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/members/{userId}/role"}},"/v1/store/team/members/{userId}/ai":{"put":{"operationId":"setMemberAiAccess","summary":"Turn Use AI on or off for a teammate (Ask AI, the AI builder and theme AI spend the store's AI credits). Only the owner","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/team/members/{userId}/ai.","x-store-explicit-path":"/v1/stores/{storeId}/team/members/{userId}/ai"}},"/v1/stores/{storeId}/team/members/{userId}/ai":{"put":{"operationId":"setMemberAiAccessWithStoreId","summary":"Turn Use AI on or off for a teammate (Ask AI, the AI builder and theme AI spend the store's AI credits). Only the owner","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of PUT /v1/store/team/members/{userId}/ai, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/members/{userId}/ai"}},"/v1/store/team/members/{userId}":{"delete":{"operationId":"removeMember","summary":"Remove someone from the team and end their access at once","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/team/members/{userId}.","x-store-explicit-path":"/v1/stores/{storeId}/team/members/{userId}"}},"/v1/stores/{storeId}/team/members/{userId}":{"delete":{"operationId":"removeMemberWithStoreId","summary":"Remove someone from the team and end their access at once","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of DELETE /v1/store/team/members/{userId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/members/{userId}"}},"/v1/store/team/leave":{"post":{"operationId":"leaveStore","summary":"Leave this store (owners transfer ownership first)","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/leave.","x-store-explicit-path":"/v1/stores/{storeId}/team/leave"}},"/v1/stores/{storeId}/team/leave":{"post":{"operationId":"leaveStoreWithStoreId","summary":"Leave this store (owners transfer ownership first)","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/leave, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/leave"}},"/v1/store/team/transfer":{"post":{"operationId":"transferOwnership","summary":"Owner only: make another member the owner. You become an admin.","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","maxLength":40},"password":{"type":"string","minLength":1,"maxLength":200}},"required":["userId","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/transfer.","x-store-explicit-path":"/v1/stores/{storeId}/team/transfer"}},"/v1/stores/{storeId}/team/transfer":{"post":{"operationId":"transferOwnershipWithStoreId","summary":"Owner only: make another member the owner. You become an admin.","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","maxLength":40},"password":{"type":"string","minLength":1,"maxLength":200}},"required":["userId","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/transfer, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/transfer"}},"/v1/store/team/roles":{"post":{"operationId":"createRole","summary":"Create a custom role from the permission matrix","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","maxLength":200},"permissions":{"minItems":1,"maxItems":36,"type":"array","items":{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]}}},"required":["name","description","permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomRole"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/roles.","x-store-explicit-path":"/v1/stores/{storeId}/team/roles"}},"/v1/stores/{storeId}/team/roles":{"post":{"operationId":"createRoleWithStoreId","summary":"Create a custom role from the permission matrix","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","maxLength":200},"permissions":{"minItems":1,"maxItems":36,"type":"array","items":{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]}}},"required":["name","description","permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomRole"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/roles, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/roles"}},"/v1/store/team/roles/{roleId}":{"put":{"operationId":"updateRole","summary":"Edit a custom role. Members with it get the new permissions on their next request.","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","maxLength":200},"permissions":{"minItems":1,"maxItems":36,"type":"array","items":{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]}}},"required":["name","description","permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomRole"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/team/roles/{roleId}.","x-store-explicit-path":"/v1/stores/{storeId}/team/roles/{roleId}"},"delete":{"operationId":"deleteRole","summary":"Delete a custom role nobody has","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/team/roles/{roleId}.","x-store-explicit-path":"/v1/stores/{storeId}/team/roles/{roleId}"}},"/v1/stores/{storeId}/team/roles/{roleId}":{"put":{"operationId":"updateRoleWithStoreId","summary":"Edit a custom role. Members with it get the new permissions on their next request.","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","maxLength":200},"permissions":{"minItems":1,"maxItems":36,"type":"array","items":{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]}}},"required":["name","description","permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomRole"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of PUT /v1/store/team/roles/{roleId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/roles/{roleId}"},"delete":{"operationId":"deleteRoleWithStoreId","summary":"Delete a custom role nobody has","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of DELETE /v1/store/team/roles/{roleId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/roles/{roleId}"}},"/v1/invites/{token}":{"get":{"operationId":"getInvite","summary":"What an invite link is for (store name, role, who sent it)","tags":["invites"],"security":[],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitePreview"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/invites/{token}/accept":{"post":{"operationId":"acceptInvite","summary":"Join the store. The signed-in account must use the invited email.","tags":["invites"],"security":[{"sellerSession":[]}],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptInviteResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/settings/integrations":{"get":{"operationId":"getIntegrations","summary":"Analytics, chat and review apps, Telegram, Discord and outgoing webhooks","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/settings/integrations.","x-store-explicit-path":"/v1/stores/{storeId}/settings/integrations"},"put":{"operationId":"updateIntegrations","summary":"Save the storefront integration ids (each checked against a strict pattern)","tags":["settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"googleAnalyticsId":{"anyOf":[{"type":"string","pattern":"^G-[A-Z0-9]{6,12}$"},{"type":"null"}]},"metaPixelId":{"anyOf":[{"type":"string","pattern":"^\\d{10,20}$"},{"type":"null"}]},"clarityId":{"anyOf":[{"type":"string","pattern":"^[a-z0-9]{8,12}$"},{"type":"null"}]},"crispWebsiteId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"tawk":{"anyOf":[{"type":"object","properties":{"propertyId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"widgetId":{"type":"string","pattern":"^[0-9a-z]{6,12}$"}},"required":["propertyId","widgetId"]},{"type":"null"}]},"consentRequired":{"type":"boolean"},"trustpilotBcc":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"gtmContainerId":{"default":null,"anyOf":[{"type":"string","pattern":"^GTM-[A-Z0-9]{4,10}$"},{"type":"null"}]},"gtmOnCheckout":{"default":false,"type":"boolean"}},"required":["googleAnalyticsId","metaPixelId","clarityId","crispWebsiteId","tawk","consentRequired","trustpilotBcc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/settings/integrations.","x-store-explicit-path":"/v1/stores/{storeId}/settings/integrations"}},"/v1/stores/{storeId}/settings/integrations":{"get":{"operationId":"getIntegrationsWithStoreId","summary":"Analytics, chat and review apps, Telegram, Discord and outgoing webhooks","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read","x-api-key-scope":"settings:read","description":"The explicit form of GET /v1/store/settings/integrations, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/integrations"},"put":{"operationId":"updateIntegrationsWithStoreId","summary":"Save the storefront integration ids (each checked against a strict pattern)","tags":["settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"googleAnalyticsId":{"anyOf":[{"type":"string","pattern":"^G-[A-Z0-9]{6,12}$"},{"type":"null"}]},"metaPixelId":{"anyOf":[{"type":"string","pattern":"^\\d{10,20}$"},{"type":"null"}]},"clarityId":{"anyOf":[{"type":"string","pattern":"^[a-z0-9]{8,12}$"},{"type":"null"}]},"crispWebsiteId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"tawk":{"anyOf":[{"type":"object","properties":{"propertyId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"widgetId":{"type":"string","pattern":"^[0-9a-z]{6,12}$"}},"required":["propertyId","widgetId"]},{"type":"null"}]},"consentRequired":{"type":"boolean"},"trustpilotBcc":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"gtmContainerId":{"default":null,"anyOf":[{"type":"string","pattern":"^GTM-[A-Z0-9]{4,10}$"},{"type":"null"}]},"gtmOnCheckout":{"default":false,"type":"boolean"}},"required":["googleAnalyticsId","metaPixelId","clarityId","crispWebsiteId","tawk","consentRequired","trustpilotBcc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write","x-api-key-scope":"settings:write","description":"The explicit form of PUT /v1/store/settings/integrations, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/settings/integrations"}},"/v1/stores/{storeId}/discord":{"get":{"operationId":"getDiscord","summary":"Server connection, product → role mappings and the member sync log","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"},"delete":{"operationId":"disconnectDiscord","summary":"Disconnect a server (the main one when guildId is empty; mappings are kept for when you reconnect). A server that already went away is cleared from the list.","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"guildId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/connect":{"post":{"operationId":"startDiscordConnect","summary":"Start adding the ShopFast bot to a server (returns the Discord authorize URL with a signed state)","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"default":"standard","type":"string","enum":["full","standard"]},"as":{"default":"main","type":"string","enum":["main","extra"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartDiscordConnectResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/callback":{"post":{"operationId":"completeDiscordConnect","summary":"Finish the bot install with the code and state Discord sent back","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":4,"maxLength":200},"state":{"type":"string","minLength":10,"maxLength":600},"guildId":{"type":"string","pattern":"^\\d{17,20}$"}},"required":["code","state","guildId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/refresh":{"post":{"operationId":"refreshDiscord","summary":"Reload the server's roles and the bot's permissions","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/mappings/{productId}":{"put":{"operationId":"setDiscordMapping","summary":"Pick the role a product grants (null clears it)","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roleId":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"removeOnRefund":{"type":"boolean"}},"required":["roleId","removeOnRefund"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/retry":{"post":{"operationId":"retryDiscordSync","summary":"Retry failed and pending role grants","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/store/security":{"get":{"operationId":"getSecurity","summary":"Fraud rules, blocklist and recent checkout checks","tags":["security"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read","x-api-key-scope":"security:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/security.","x-store-explicit-path":"/v1/stores/{storeId}/security"}},"/v1/stores/{storeId}/security":{"get":{"operationId":"getSecurityWithStoreId","summary":"Fraud rules, blocklist and recent checkout checks","tags":["security"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read","x-api-key-scope":"security:read","description":"The explicit form of GET /v1/store/security, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/security"}},"/v1/store/security/settings":{"put":{"operationId":"updateFraudSettings","summary":"VPN policy, IP velocity limit, risk thresholds and email rules","tags":["security"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"vpnPolicy":{"type":"string","enum":["allow","review","block"]},"maxOrdersPerIpPerHour":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"reviewScore":{"type":"integer","minimum":1,"maximum":100},"blockScore":{"type":"integer","minimum":1,"maximum":100},"blockDisposableEmail":{"type":"boolean"},"flagCountryMismatch":{"type":"boolean"},"usePlatformBlocklist":{"default":false,"type":"boolean"},"platformListAction":{"default":"block","type":"string","enum":["block","review"]},"torPolicy":{"default":"block","type":"string","enum":["allow","review","block"]},"datacenterPolicy":{"default":"review","type":"string","enum":["allow","review","block"]},"checkEmailMx":{"default":true,"type":"boolean"},"maxCheckoutsPerEmailPerDay":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"maxCheckoutsPerDevicePerDay":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"reviewNewAccountsDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["vpnPolicy","maxOrdersPerIpPerHour","reviewScore","blockScore","blockDisposableEmail","flagCountryMismatch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write","x-api-key-scope":"security:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/security/settings.","x-store-explicit-path":"/v1/stores/{storeId}/security/settings"}},"/v1/stores/{storeId}/security/settings":{"put":{"operationId":"updateFraudSettingsWithStoreId","summary":"VPN policy, IP velocity limit, risk thresholds and email rules","tags":["security"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"vpnPolicy":{"type":"string","enum":["allow","review","block"]},"maxOrdersPerIpPerHour":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"reviewScore":{"type":"integer","minimum":1,"maximum":100},"blockScore":{"type":"integer","minimum":1,"maximum":100},"blockDisposableEmail":{"type":"boolean"},"flagCountryMismatch":{"type":"boolean"},"usePlatformBlocklist":{"default":false,"type":"boolean"},"platformListAction":{"default":"block","type":"string","enum":["block","review"]},"torPolicy":{"default":"block","type":"string","enum":["allow","review","block"]},"datacenterPolicy":{"default":"review","type":"string","enum":["allow","review","block"]},"checkEmailMx":{"default":true,"type":"boolean"},"maxCheckoutsPerEmailPerDay":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"maxCheckoutsPerDevicePerDay":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"reviewNewAccountsDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["vpnPolicy","maxOrdersPerIpPerHour","reviewScore","blockScore","blockDisposableEmail","flagCountryMismatch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write","x-api-key-scope":"security:write","description":"The explicit form of PUT /v1/store/security/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/security/settings"}},"/v1/store/security/blocklist":{"post":{"operationId":"addBlocklistEntries","summary":"Block emails, email domains, IPs, IP ranges or countries (values are normalized; duplicates skipped)","tags":["security"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["email","email_domain","ip","ip_range","country","asn","device","discord_id","card_fingerprint"]},"values":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","minLength":2,"maxLength":254}},"reason":{"type":"string","maxLength":200}},"required":["kind","values","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBlocklistEntriesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write","x-api-key-scope":"security:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/security/blocklist.","x-store-explicit-path":"/v1/stores/{storeId}/security/blocklist"}},"/v1/stores/{storeId}/security/blocklist":{"post":{"operationId":"addBlocklistEntriesWithStoreId","summary":"Block emails, email domains, IPs, IP ranges or countries (values are normalized; duplicates skipped)","tags":["security"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["email","email_domain","ip","ip_range","country","asn","device","discord_id","card_fingerprint"]},"values":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","minLength":2,"maxLength":254}},"reason":{"type":"string","maxLength":200}},"required":["kind","values","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBlocklistEntriesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write","x-api-key-scope":"security:write","description":"The explicit form of POST /v1/store/security/blocklist, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/security/blocklist"}},"/v1/store/security/blocklist/{entryId}":{"delete":{"operationId":"removeBlocklistEntry","summary":"Unblock one entry","tags":["security"],"security":[{"apiKey":[]}],"parameters":[{"name":"entryId","in":"path","required":true,"schema":{"type":"string","pattern":"^blk_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write","x-api-key-scope":"security:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/security/blocklist/{entryId}.","x-store-explicit-path":"/v1/stores/{storeId}/security/blocklist/{entryId}"}},"/v1/stores/{storeId}/security/blocklist/{entryId}":{"delete":{"operationId":"removeBlocklistEntryWithStoreId","summary":"Unblock one entry","tags":["security"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"entryId","in":"path","required":true,"schema":{"type":"string","pattern":"^blk_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write","x-api-key-scope":"security:write","description":"The explicit form of DELETE /v1/store/security/blocklist/{entryId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/security/blocklist/{entryId}"}},"/v1/store/security/test":{"post":{"operationId":"testFraudCheck","summary":"Run the fraud rules on a pretend checkout (logged as a test, never counted toward limits)","tags":["security"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"ip":{"type":"string","minLength":3,"maxLength":45},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"ipCountry":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"required":["email","ip","country","ipCountry"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudCheck"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read","x-api-key-scope":"security:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/security/test.","x-store-explicit-path":"/v1/stores/{storeId}/security/test"}},"/v1/stores/{storeId}/security/test":{"post":{"operationId":"testFraudCheckWithStoreId","summary":"Run the fraud rules on a pretend checkout (logged as a test, never counted toward limits)","tags":["security"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"ip":{"type":"string","minLength":3,"maxLength":45},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"ipCountry":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"required":["email","ip","country","ipCountry"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudCheck"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read","x-api-key-scope":"security:write","description":"The explicit form of POST /v1/store/security/test, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/security/test"}},"/v1/stores/{storeId}/billing":{"get":{"operationId":"getBilling","summary":"Your ShopFast plan, fees, the plans you can switch to and monthly statements from the ledger","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/stores/{storeId}/billing/plan":{"put":{"operationId":"changePlan","summary":"Switch plans (the new plan must allow the store's payment model). New fees apply to new orders.","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planId":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},"now":{"default":false,"type":"boolean"}},"required":["planId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/stores/{storeId}/billing/statement":{"get":{"operationId":"exportStatement","summary":"Platform fees charged, one row per ledger entry, as CSV (one month or everything)","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"month","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/stores/{storeId}/imports":{"get":{"operationId":"listImports","summary":"Past and running imports with progress, newest first (or by file, status or counts), at most 50","tags":["imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["when","file","status","rows","created","skipped","failed"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read"},"post":{"operationId":"startImport","summary":"Start the import as a background job","tags":["imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"type":"string","enum":["products","customers","orders","license_keys"]},"format":{"type":"string","enum":["csv","json"]},"fileName":{"type":"string","minLength":1,"maxLength":200},"content":{"type":"string","minLength":1,"maxLength":4000000},"mapping":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}},"required":["entity","format","fileName","content","mapping"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/imports/preview":{"post":{"operationId":"previewImport","summary":"Read a file: columns, sample rows and a suggested field mapping","tags":["imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"type":"string","enum":["products","customers","orders","license_keys"]},"format":{"type":"string","enum":["csv","json"]},"fileName":{"type":"string","minLength":1,"maxLength":200},"content":{"type":"string","minLength":1,"maxLength":4000000}},"required":["entity","format","fileName","content"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPreview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/imports/dry-run":{"post":{"operationId":"dryRunImport","summary":"Validate every row against the mapping without writing anything","tags":["imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"type":"string","enum":["products","customers","orders","license_keys"]},"format":{"type":"string","enum":["csv","json"]},"fileName":{"type":"string","minLength":1,"maxLength":200},"content":{"type":"string","minLength":1,"maxLength":4000000},"mapping":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}},"required":["entity","format","fileName","content","mapping"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/imports/{importId}":{"get":{"operationId":"getImport","summary":"One import with progress and errors","tags":["imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^imp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJob"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read"}},"/v1/store/emails":{"get":{"operationId":"listEmailTemplates","summary":"Transactional email templates with branding and 30-day send counts","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/emails.","x-store-explicit-path":"/v1/stores/{storeId}/emails"}},"/v1/stores/{storeId}/emails":{"get":{"operationId":"listEmailTemplatesWithStoreId","summary":"Transactional email templates with branding and 30-day send counts","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/emails, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails"}},"/v1/store/emails/{kind}":{"put":{"operationId":"updateEmailTemplate","summary":"Save a template (unknown variables are rejected)","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"subject":{"type":"string","minLength":1,"maxLength":200},"heading":{"type":"string","maxLength":200},"body":{"type":"string","maxLength":10000},"buttonLabel":{"type":"string","maxLength":60},"footer":{"type":"string","maxLength":1000}},"required":["enabled","subject","heading","body","buttonLabel","footer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/emails/{kind}.","x-store-explicit-path":"/v1/stores/{storeId}/emails/{kind}"},"delete":{"operationId":"resetEmailTemplate","summary":"Go back to the ShopFast default","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/emails/{kind}.","x-store-explicit-path":"/v1/stores/{storeId}/emails/{kind}"}},"/v1/stores/{storeId}/emails/{kind}":{"put":{"operationId":"updateEmailTemplateWithStoreId","summary":"Save a template (unknown variables are rejected)","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"subject":{"type":"string","minLength":1,"maxLength":200},"heading":{"type":"string","maxLength":200},"body":{"type":"string","maxLength":10000},"buttonLabel":{"type":"string","maxLength":60},"footer":{"type":"string","maxLength":1000}},"required":["enabled","subject","heading","body","buttonLabel","footer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/emails/{kind}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails/{kind}"},"delete":{"operationId":"resetEmailTemplateWithStoreId","summary":"Go back to the ShopFast default","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/emails/{kind}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails/{kind}"}},"/v1/store/emails/{kind}/test":{"post":{"operationId":"sendTestEmail","summary":"Send the template (or unsaved edits) with sample values to your own email","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"subject":{"type":"string","minLength":1,"maxLength":200},"heading":{"type":"string","maxLength":200},"body":{"type":"string","maxLength":10000},"buttonLabel":{"type":"string","maxLength":60},"footer":{"type":"string","maxLength":1000}},"required":["enabled","subject","heading","body","buttonLabel","footer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTestEmailResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/emails/{kind}/test.","x-store-explicit-path":"/v1/stores/{storeId}/emails/{kind}/test"}},"/v1/stores/{storeId}/emails/{kind}/test":{"post":{"operationId":"sendTestEmailWithStoreId","summary":"Send the template (or unsaved edits) with sample values to your own email","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"subject":{"type":"string","minLength":1,"maxLength":200},"heading":{"type":"string","maxLength":200},"body":{"type":"string","maxLength":10000},"buttonLabel":{"type":"string","maxLength":60},"footer":{"type":"string","maxLength":1000}},"required":["enabled","subject","heading","body","buttonLabel","footer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTestEmailResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/emails/{kind}/test, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails/{kind}/test"}},"/v1/me/profile":{"get":{"operationId":"getProfile","summary":"Your name, email, two-factor status and signed-in devices","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"patch":{"operationId":"updateProfile","summary":"Change your name","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/email":{"post":{"operationId":"requestEmailChange","summary":"Send a confirmation link to a new email address","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"password":{"type":"string","minLength":1,"maxLength":200}},"required":["email","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/email/confirm":{"post":{"operationId":"confirmEmailChange","summary":"Confirm the new email with the link from the message","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/password":{"put":{"operationId":"changePassword","summary":"Change your password; every other session is signed out","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"currentPassword":{"type":"string","minLength":1,"maxLength":200},"newPassword":{"type":"string","minLength":10,"maxLength":200}},"required":["currentPassword","newPassword"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/2fa/setup":{"post":{"operationId":"startTotp","summary":"Start two-factor setup: a new secret to scan","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","minLength":1,"maxLength":200}},"required":["password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotpSetup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/2fa/enable":{"post":{"operationId":"enableTotp","summary":"Turn on two-factor with a code from the app; returns recovery codes once","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecoveryCodes"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/2fa/disable":{"post":{"operationId":"disableTotp","summary":"Turn off two-factor (password and a current code)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","minLength":1,"maxLength":200},"code":{"type":"string","pattern":"^(?:\\d{6}|[a-z0-9]{4}-[a-z0-9]{4})$"}},"required":["password","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/2fa/recovery-codes":{"post":{"operationId":"regenerateRecoveryCodes","summary":"Replace your recovery codes (old ones stop working)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecoveryCodes"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/google/disconnect":{"post":{"operationId":"disconnectGoogle","summary":"Stop signing in with Google. Needs your password, so the account always keeps a way in.","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","minLength":1,"maxLength":200}},"required":["password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/sessions/{sessionId}":{"delete":{"operationId":"revokeSession","summary":"Sign out one device","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{16}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/sessions/revoke-others":{"post":{"operationId":"revokeOtherSessions","summary":"Sign out every device except this one","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/login/2fa":{"post":{"operationId":"loginSecondFactor","summary":"Finish signing in with a two-factor or recovery code (after login answered with a challenge)","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"challenge":{"type":"string","minLength":20,"maxLength":400},"code":{"type":"string","pattern":"^(?:\\d{6}|[a-z0-9]{4}-[a-z0-9]{4})$"}},"required":["challenge","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginSecondFactorResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/audit":{"get":{"operationId":"adminListAudit","summary":"Every admin change with before and after, newest first","tags":["admin audit"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"target","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["plan","store","gateway","settings","payout","admin_user","announcement","platform_blocklist","pay_application","feature_flag","template","template_developer","desk","community","abuse_report","user","blog_post","plan_voucher"]},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["plan.create","plan.update","store.plan","store.fee_override","store.status","gateway.update","settings.update","payouts.run","payout.mark","admin.invite","admin.invite_revoke","admin.role","admin.deactivate","admin.reactivate","admin.join","announcement.create","announcement.update","announcement.archive","support.view_start","support.view_end","plan_invoice.mark_paid","admin.mfa_enroll","admin.mfa_reset","platform_blocklist.add","platform_blocklist.remove","pay.mode","pay.defaults","pay_application.approve","pay_application.reject","pay_application.request_info","pay_application.document_view","pay.limits","pay.access","pay.payout_hold","pay.manual_payout","pay.flags","feature.global","feature.grant","feature.revoke","pay.method_caps","ai_credits.adjust","template.developer_invite","template.invite_revoke","template.developer_update","template.visibility","template.release_withdraw","template.release_review","template.release_discard","template.reorder","template.default","desk.open","desk.settings","community.connect","community.disconnect","community.setup","community.settings","community.moderate","community.post","community.incident","community.verification","community.restore","abuse_report.decide","user.password_reset","user.email_change","user.confirmation_resend","user.email_confirm","user.two_factor_reset","user.google_unlink","user.sign_out","user.lock","user.unlock","user.rename","user.note","user.export","store.member_role","store.member_remove","store.owner_transfer","store.handle","store.test_mode","store.domain_remove","store.product_takedown","store.product_restore","store.cache_purge","store.search_rebuild","store.note","store.tax_category","store.referral_remove","user.replay_view","user.activity_exclude","activity.settings","user.impersonate","user.impersonate_end","blog.create","blog.update","blog.publish","blog.unpublish","blog.delete","blog.media","store.plan_limits","store.trial","plan_invoice.void","plan_voucher.create","plan_voucher.update"]},{"type":"null"}]}},{"name":"adminId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^adm_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","admin","action","target","summary"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListAuditResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/audit/export":{"get":{"operationId":"adminExportAudit","summary":"The filtered audit log as CSV (up to 10,000 rows)","tags":["admin audit"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"target","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["plan","store","gateway","settings","payout","admin_user","announcement","platform_blocklist","pay_application","feature_flag","template","template_developer","desk","community","abuse_report","user","blog_post","plan_voucher"]},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["plan.create","plan.update","store.plan","store.fee_override","store.status","gateway.update","settings.update","payouts.run","payout.mark","admin.invite","admin.invite_revoke","admin.role","admin.deactivate","admin.reactivate","admin.join","announcement.create","announcement.update","announcement.archive","support.view_start","support.view_end","plan_invoice.mark_paid","admin.mfa_enroll","admin.mfa_reset","platform_blocklist.add","platform_blocklist.remove","pay.mode","pay.defaults","pay_application.approve","pay_application.reject","pay_application.request_info","pay_application.document_view","pay.limits","pay.access","pay.payout_hold","pay.manual_payout","pay.flags","feature.global","feature.grant","feature.revoke","pay.method_caps","ai_credits.adjust","template.developer_invite","template.invite_revoke","template.developer_update","template.visibility","template.release_withdraw","template.release_review","template.release_discard","template.reorder","template.default","desk.open","desk.settings","community.connect","community.disconnect","community.setup","community.settings","community.moderate","community.post","community.incident","community.verification","community.restore","abuse_report.decide","user.password_reset","user.email_change","user.confirmation_resend","user.email_confirm","user.two_factor_reset","user.google_unlink","user.sign_out","user.lock","user.unlock","user.rename","user.note","user.export","store.member_role","store.member_remove","store.owner_transfer","store.handle","store.test_mode","store.domain_remove","store.product_takedown","store.product_restore","store.cache_purge","store.search_rebuild","store.note","store.tax_category","store.referral_remove","user.replay_view","user.activity_exclude","activity.settings","user.impersonate","user.impersonate_end","blog.create","blog.update","blog.publish","blog.unpublish","blog.delete","blog.media","store.plan_limits","store.trial","plan_invoice.void","plan_voucher.create","plan_voucher.update"]},{"type":"null"}]}},{"name":"adminId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^adm_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/admins":{"get":{"operationId":"adminListAdmins","summary":"Admin users and pending admin invites","tags":["admin admins"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListAdminsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/admins/invites":{"post":{"operationId":"adminInviteAdmin","summary":"Owner only: invite an admin by email (link valid 72 hours)","tags":["admin admins"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"name":{"type":"string","minLength":1,"maxLength":120},"role":{"type":"string","enum":["owner","finance","support","agent"]}},"required":["email","name","role"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminInviteAdminResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/admins/invites/{inviteId}":{"delete":{"operationId":"adminRevokeInvite","summary":"Owner only: cancel an admin invite","tags":["admin admins"],"security":[{"adminSession":[]}],"parameters":[{"name":"inviteId","in":"path","required":true,"schema":{"type":"string","pattern":"^ainv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/admins/{adminId}":{"put":{"operationId":"adminUpdateAdmin","summary":"Owner only: change an admin's role, or deactivate or reactivate them","tags":["admin admins"],"security":[{"adminSession":[]}],"parameters":[{"name":"adminId","in":"path","required":true,"schema":{"type":"string","pattern":"^adm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["owner","finance","support","agent"]},"active":{"type":"boolean"},"reason":{"type":"string","maxLength":280}},"required":["role","active","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/invites/{token}":{"get":{"operationId":"adminGetInvite","summary":"What an admin invite is for","tags":["admin invites"],"security":[],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminInvitePreview"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/invites/{token}/accept":{"post":{"operationId":"adminAcceptInvite","summary":"Set a password and join as an admin, then set up two-factor sign-in","tags":["admin invites"],"security":[],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","minLength":12,"maxLength":200}},"required":["password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAcceptInviteResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/customers":{"get":{"operationId":"listCustomers","summary":"Customers with spend, segments and tab counts","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","new","returning","high_value","at_risk","blocked"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"recent","type":"string","enum":["recent","spent","orders","name","first","country"]}},{"name":"dir","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["asc","desc"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/customers.","x-store-explicit-path":"/v1/stores/{storeId}/customers"}},"/v1/stores/{storeId}/customers":{"get":{"operationId":"listCustomersWithStoreId","summary":"Customers with spend, segments and tab counts","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","new","returning","high_value","at_risk","blocked"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"recent","type":"string","enum":["recent","spent","orders","name","first","country"]}},{"name":"dir","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["asc","desc"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/customers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers"}},"/v1/store/customers/export":{"get":{"operationId":"exportCustomers","summary":"Every customer matching the filters, as CSV","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","new","returning","high_value","at_risk","blocked"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrowthCsv"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/customers/export.","x-store-explicit-path":"/v1/stores/{storeId}/customers/export"}},"/v1/stores/{storeId}/customers/export":{"get":{"operationId":"exportCustomersWithStoreId","summary":"Every customer matching the filters, as CSV","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","new","returning","high_value","at_risk","blocked"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrowthCsv"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/customers/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/export"}},"/v1/store/customers/duplicates":{"get":{"operationId":"listCustomerDuplicates","summary":"Pairs of customers that look like the same person","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomerDuplicatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/customers/duplicates.","x-store-explicit-path":"/v1/stores/{storeId}/customers/duplicates"}},"/v1/stores/{storeId}/customers/duplicates":{"get":{"operationId":"listCustomerDuplicatesWithStoreId","summary":"Pairs of customers that look like the same person","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomerDuplicatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/customers/duplicates, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/duplicates"}},"/v1/store/customers/{customerId}":{"get":{"operationId":"getCustomer","summary":"A customer with orders, products, licenses, notes and emails","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/customers/{customerId}.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}"},"patch":{"operationId":"updateCustomer","summary":"Set a customer's tags","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\p{L}\\p{N} _-]+$"}}},"required":["tags"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/customers/{customerId}.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}"}},"/v1/stores/{storeId}/customers/{customerId}":{"get":{"operationId":"getCustomerWithStoreId","summary":"A customer with orders, products, licenses, notes and emails","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/customers/{customerId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}"},"patch":{"operationId":"updateCustomerWithStoreId","summary":"Set a customer's tags","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\p{L}\\p{N} _-]+$"}}},"required":["tags"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of PATCH /v1/store/customers/{customerId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}"}},"/v1/store/customers/{customerId}/block":{"put":{"operationId":"setCustomerBlocked","summary":"Block or unblock a customer from checking out","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"blocked":{"type":"boolean"},"reason":{"default":"","type":"string","maxLength":280}},"required":["blocked"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/customers/{customerId}/block.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}/block"}},"/v1/stores/{storeId}/customers/{customerId}/block":{"put":{"operationId":"setCustomerBlockedWithStoreId","summary":"Block or unblock a customer from checking out","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"blocked":{"type":"boolean"},"reason":{"default":"","type":"string","maxLength":280}},"required":["blocked"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of PUT /v1/store/customers/{customerId}/block, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}/block"}},"/v1/store/customers/{customerId}/notes":{"post":{"operationId":"addCustomerNote","summary":"Add a private note","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/customers/{customerId}/notes.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}/notes"}},"/v1/stores/{storeId}/customers/{customerId}/notes":{"post":{"operationId":"addCustomerNoteWithStoreId","summary":"Add a private note","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of POST /v1/store/customers/{customerId}/notes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}/notes"}},"/v1/store/customers/{customerId}/notes/{noteId}":{"delete":{"operationId":"deleteCustomerNote","summary":"Delete a note","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"noteId","in":"path","required":true,"schema":{"type":"string","pattern":"^cnote_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/customers/{customerId}/notes/{noteId}.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}/notes/{noteId}"}},"/v1/stores/{storeId}/customers/{customerId}/notes/{noteId}":{"delete":{"operationId":"deleteCustomerNoteWithStoreId","summary":"Delete a note","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"noteId","in":"path","required":true,"schema":{"type":"string","pattern":"^cnote_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of DELETE /v1/store/customers/{customerId}/notes/{noteId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}/notes/{noteId}"}},"/v1/store/customers/{customerId}/merge":{"post":{"operationId":"mergeCustomers","summary":"Merge another customer into this one: orders, reviews, notes, tags and emails move over","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceId":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["sourceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/customers/{customerId}/merge.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}/merge"}},"/v1/stores/{storeId}/customers/{customerId}/merge":{"post":{"operationId":"mergeCustomersWithStoreId","summary":"Merge another customer into this one: orders, reviews, notes, tags and emails move over","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceId":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["sourceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of POST /v1/store/customers/{customerId}/merge, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}/merge"}},"/v1/store/reviews":{"get":{"operationId":"listReviews","summary":"The moderation queue with counts and the rating summary","tags":["reviews"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","pending","needs_reply","low_ratings","flagged","hidden"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"rating","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReviewsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/reviews.","x-store-explicit-path":"/v1/stores/{storeId}/reviews"}},"/v1/stores/{storeId}/reviews":{"get":{"operationId":"listReviewsWithStoreId","summary":"The moderation queue with counts and the rating summary","tags":["reviews"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","pending","needs_reply","low_ratings","flagged","hidden"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"rating","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReviewsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/reviews, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reviews"}},"/v1/store/reviews/{reviewId}/moderate":{"post":{"operationId":"moderateReview","summary":"Approve, hide, flag or unflag a review","tags":["reviews"],"security":[{"apiKey":[]}],"parameters":[{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^rev_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["approve","hide","flag","unflag"]},"reason":{"default":"","type":"string","maxLength":200}},"required":["action"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/reviews/{reviewId}/moderate.","x-store-explicit-path":"/v1/stores/{storeId}/reviews/{reviewId}/moderate"}},"/v1/stores/{storeId}/reviews/{reviewId}/moderate":{"post":{"operationId":"moderateReviewWithStoreId","summary":"Approve, hide, flag or unflag a review","tags":["reviews"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^rev_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["approve","hide","flag","unflag"]},"reason":{"default":"","type":"string","maxLength":200}},"required":["action"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of POST /v1/store/reviews/{reviewId}/moderate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reviews/{reviewId}/moderate"}},"/v1/store/reviews/{reviewId}/reply":{"put":{"operationId":"replyReview","summary":"Reply in public (null removes the reply)","tags":["reviews"],"security":[{"apiKey":[]}],"parameters":[{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^rev_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reply":{"anyOf":[{"type":"string","minLength":1,"maxLength":1000},{"type":"null"}]}},"required":["reply"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/reviews/{reviewId}/reply.","x-store-explicit-path":"/v1/stores/{storeId}/reviews/{reviewId}/reply"}},"/v1/stores/{storeId}/reviews/{reviewId}/reply":{"put":{"operationId":"replyReviewWithStoreId","summary":"Reply in public (null removes the reply)","tags":["reviews"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^rev_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reply":{"anyOf":[{"type":"string","minLength":1,"maxLength":1000},{"type":"null"}]}},"required":["reply"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of PUT /v1/store/reviews/{reviewId}/reply, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reviews/{reviewId}/reply"}},"/v1/stores/{storeId}/store-reviews":{"get":{"operationId":"listStoreReviews","summary":"Reviews of the store itself (imported vouches), pinned first then newest, with counts","tags":["store-reviews"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","published","hidden"]}},{"name":"rating","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStoreReviewsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"reviews:read"}},"/v1/stores/{storeId}/store-reviews/{reviewId}/moderate":{"post":{"operationId":"moderateStoreReview","summary":"Show, hide, pin or unpin a review of the store","tags":["store-reviews"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^srv_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["publish","hide","pin","unpin"]}},"required":["action"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerStoreReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"reviews:write"}},"/v1/stores/{storeId}/store-reviews/{reviewId}":{"delete":{"operationId":"deleteStoreReview","summary":"Delete a review of the store for good","tags":["store-reviews"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^srv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"reviews:write"}},"/v1/store/review-settings":{"get":{"operationId":"getReviewSettings","summary":"Review requests and moderation rules","tags":["review-settings"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/review-settings.","x-store-explicit-path":"/v1/stores/{storeId}/review-settings"},"put":{"operationId":"updateReviewSettings","summary":"Update review requests and moderation rules","tags":["review-settings"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoRequest":{"default":true,"type":"boolean"},"requestDelayDays":{"default":3,"type":"integer","minimum":0,"maximum":60},"moderation":{"default":"auto_publish","type":"string","enum":["auto_publish","manual"]},"autoPublishMinRating":{"default":4,"type":"integer","minimum":1,"maximum":5},"reward":{"default":{},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"type":{"default":"percent","type":"string","enum":["percent","fixed"]},"value":{"default":1000,"type":"integer","minimum":1,"maximum":10000000},"minRating":{"default":4,"type":"integer","minimum":1,"maximum":5},"expiryDays":{"default":30,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/review-settings.","x-store-explicit-path":"/v1/stores/{storeId}/review-settings"}},"/v1/stores/{storeId}/review-settings":{"get":{"operationId":"getReviewSettingsWithStoreId","summary":"Review requests and moderation rules","tags":["review-settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/review-settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/review-settings"},"put":{"operationId":"updateReviewSettingsWithStoreId","summary":"Update review requests and moderation rules","tags":["review-settings"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoRequest":{"default":true,"type":"boolean"},"requestDelayDays":{"default":3,"type":"integer","minimum":0,"maximum":60},"moderation":{"default":"auto_publish","type":"string","enum":["auto_publish","manual"]},"autoPublishMinRating":{"default":4,"type":"integer","minimum":1,"maximum":5},"reward":{"default":{},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"type":{"default":"percent","type":"string","enum":["percent","fixed"]},"value":{"default":1000,"type":"integer","minimum":1,"maximum":10000000},"minRating":{"default":4,"type":"integer","minimum":1,"maximum":5},"expiryDays":{"default":30,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"customers:write","description":"The explicit form of PUT /v1/store/review-settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/review-settings"}},"/v1/store/orders/{orderId}/review-request":{"post":{"operationId":"sendReviewRequest","summary":"Email the buyer a review request now","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReviewRequestResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/review-request.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/review-request"}},"/v1/stores/{storeId}/orders/{orderId}/review-request":{"post":{"operationId":"sendReviewRequestWithStoreId","summary":"Email the buyer a review request now","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReviewRequestResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/review-request, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/review-request"}},"/v1/storefront/stores/{storeId}/review-form":{"get":{"operationId":"reviewForm","summary":"The items a buyer can review, from the review email token or the order page checkout id","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"token","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":400},{"type":"null"}]}},{"name":"session","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"access","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewForm"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/disputes":{"get":{"operationId":"listDisputes","summary":"Chargebacks and buyer claims in one queue","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"open","type":"string","enum":["open","needs_response","under_review","won","lost","claims","all"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["chargeback","claim"]},{"type":"null"}]}},{"name":"reason","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["fraudulent","not_received","not_as_described","not_working","duplicate","unrecognized","credit_not_processed","subscription_canceled","wrong_item","general","other"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"due","type":"string","enum":["due","order","customer","type","reason","amount","status","opened"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDisputesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/disputes.","x-store-explicit-path":"/v1/stores/{storeId}/disputes"}},"/v1/stores/{storeId}/disputes":{"get":{"operationId":"listDisputesWithStoreId","summary":"Chargebacks and buyer claims in one queue","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"open","type":"string","enum":["open","needs_response","under_review","won","lost","claims","all"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["chargeback","claim"]},{"type":"null"}]}},{"name":"reason","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["fraudulent","not_received","not_as_described","not_working","duplicate","unrecognized","credit_not_processed","subscription_canceled","wrong_item","general","other"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"due","type":"string","enum":["due","order","customer","type","reason","amount","status","opened"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDisputesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/disputes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes"}},"/v1/store/disputes/{disputeId}":{"get":{"operationId":"getDispute","summary":"A dispute with its evidence, timeline and ledger effect","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/disputes/{disputeId}.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}"}},"/v1/stores/{storeId}/disputes/{disputeId}":{"get":{"operationId":"getDisputeWithStoreId","summary":"A dispute with its evidence, timeline and ledger effect","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/disputes/{disputeId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}"}},"/v1/store/disputes/{disputeId}/evidence":{"put":{"operationId":"saveDisputeEvidence","summary":"Save the written part of the evidence","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"object","properties":{"productDescription":{"default":"","type":"string","maxLength":5000},"refundPolicy":{"default":"","type":"string","maxLength":5000},"customerCommunication":{"default":"","type":"string","maxLength":10000},"refusalExplanation":{"default":"","type":"string","maxLength":5000},"additionalNotes":{"default":"","type":"string","maxLength":10000}}}},"required":["text"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/disputes/{disputeId}/evidence.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/evidence"}},"/v1/stores/{storeId}/disputes/{disputeId}/evidence":{"put":{"operationId":"saveDisputeEvidenceWithStoreId","summary":"Save the written part of the evidence","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"object","properties":{"productDescription":{"default":"","type":"string","maxLength":5000},"refundPolicy":{"default":"","type":"string","maxLength":5000},"customerCommunication":{"default":"","type":"string","maxLength":10000},"refusalExplanation":{"default":"","type":"string","maxLength":5000},"additionalNotes":{"default":"","type":"string","maxLength":10000}}}},"required":["text"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of PUT /v1/store/disputes/{disputeId}/evidence, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/evidence"}},"/v1/store/disputes/{disputeId}/submit":{"post":{"operationId":"submitDisputeEvidence","summary":"Send the evidence package to the processor","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/disputes/{disputeId}/submit.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/submit"}},"/v1/stores/{storeId}/disputes/{disputeId}/submit":{"post":{"operationId":"submitDisputeEvidenceWithStoreId","summary":"Send the evidence package to the processor","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/disputes/{disputeId}/submit, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/submit"}},"/v1/store/disputes/{disputeId}/accept":{"post":{"operationId":"acceptDispute","summary":"Accept a chargeback (counts as lost)","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/disputes/{disputeId}/accept.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/accept"}},"/v1/stores/{storeId}/disputes/{disputeId}/accept":{"post":{"operationId":"acceptDisputeWithStoreId","summary":"Accept a chargeback (counts as lost)","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/disputes/{disputeId}/accept, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/accept"}},"/v1/store/disputes/{disputeId}/reply":{"post":{"operationId":"replyDispute","summary":"Reply to the buyer of a claim (emailed) or add a private note","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000},"internal":{"default":false,"type":"boolean"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/disputes/{disputeId}/reply.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/reply"}},"/v1/stores/{storeId}/disputes/{disputeId}/reply":{"post":{"operationId":"replyDisputeWithStoreId","summary":"Reply to the buyer of a claim (emailed) or add a private note","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000},"internal":{"default":false,"type":"boolean"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/disputes/{disputeId}/reply, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/reply"}},"/v1/store/disputes/{disputeId}/resolve":{"post":{"operationId":"resolveClaim","summary":"Close a claim: refund, replace or reject","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resolution":{"type":"string","enum":["refunded","replaced","rejected","withdrawn"]},"note":{"default":"","type":"string","maxLength":2000}},"required":["resolution"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/disputes/{disputeId}/resolve.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/resolve"}},"/v1/stores/{storeId}/disputes/{disputeId}/resolve":{"post":{"operationId":"resolveClaimWithStoreId","summary":"Close a claim: refund, replace or reject","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resolution":{"type":"string","enum":["refunded","replaced","rejected","withdrawn"]},"note":{"default":"","type":"string","maxLength":2000}},"required":["resolution"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/disputes/{disputeId}/resolve, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/resolve"}},"/v1/store/orders/{orderId}/simulate-dispute":{"post":{"operationId":"simulateDispute","summary":"Sandbox and test orders only: the processor opens a chargeback (signed webhook through the real pipeline)","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"default":"fraudulent","type":"string","enum":["fraudulent","not_received","not_as_described","not_working","duplicate","unrecognized","credit_not_processed","subscription_canceled","wrong_item","general","other"]},"stage":{"default":"chargeback","type":"string","enum":["chargeback","inquiry"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/simulate-dispute.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/simulate-dispute"}},"/v1/stores/{storeId}/orders/{orderId}/simulate-dispute":{"post":{"operationId":"simulateDisputeWithStoreId","summary":"Sandbox and test orders only: the processor opens a chargeback (signed webhook through the real pipeline)","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"default":"fraudulent","type":"string","enum":["fraudulent","not_received","not_as_described","not_working","duplicate","unrecognized","credit_not_processed","subscription_canceled","wrong_item","general","other"]},"stage":{"default":"chargeback","type":"string","enum":["chargeback","inquiry"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/simulate-dispute, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/simulate-dispute"}},"/v1/store/disputes/{disputeId}/simulate-outcome":{"post":{"operationId":"simulateDisputeOutcome","summary":"Sandbox disputes only: the processor decides the dispute","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"type":"string","enum":["won","lost"]}},"required":["outcome"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/disputes/{disputeId}/simulate-outcome.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/simulate-outcome"}},"/v1/stores/{storeId}/disputes/{disputeId}/simulate-outcome":{"post":{"operationId":"simulateDisputeOutcomeWithStoreId","summary":"Sandbox disputes only: the processor decides the dispute","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"type":"string","enum":["won","lost"]}},"required":["outcome"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/disputes/{disputeId}/simulate-outcome, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/simulate-outcome"}},"/v1/store/disputes/{disputeId}/escalate":{"post":{"operationId":"escalateDispute","summary":"Ask PayPal to decide an inquiry; it becomes a claim","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","minLength":1,"maxLength":2000}},"required":["note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"disputes:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/disputes/{disputeId}/escalate.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/escalate"}},"/v1/stores/{storeId}/disputes/{disputeId}/escalate":{"post":{"operationId":"escalateDisputeWithStoreId","summary":"Ask PayPal to decide an inquiry; it becomes a claim","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","minLength":1,"maxLength":2000}},"required":["note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"disputes:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/disputes/{disputeId}/escalate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/escalate"}},"/v1/store/disputes/{disputeId}/refresh":{"post":{"operationId":"refreshDispute","summary":"Pull the case, its stage and its messages from PayPal again","tags":["disputes"],"security":[{"apiKey":[]}],"parameters":[{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"disputes:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/disputes/{disputeId}/refresh.","x-store-explicit-path":"/v1/stores/{storeId}/disputes/{disputeId}/refresh"}},"/v1/stores/{storeId}/disputes/{disputeId}/refresh":{"post":{"operationId":"refreshDisputeWithStoreId","summary":"Pull the case, its stage and its messages from PayPal again","tags":["disputes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"disputeId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"disputes:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/disputes/{disputeId}/refresh, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/disputes/{disputeId}/refresh"}},"/v1/stores/{storeId}/dispute-settings":{"get":{"operationId":"getDisputeSettings","summary":"Dispute rules (auto-block on chargeback)","tags":["dispute-settings"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"disputes:read"},"put":{"operationId":"updateDisputeSettings","summary":"Update the dispute rules","tags":["dispute-settings"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoBlockOnChargeback":{"default":false,"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"disputes:write"}},"/v1/storefront/checkouts/{sessionId}/claims":{"post":{"operationId":"createClaim","summary":"The buyer reports a problem with their order","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"},"reason":{"type":"string","enum":["not_received","not_working","not_as_described","wrong_item","other"]},"message":{"type":"string","minLength":10,"maxLength":2000}},"required":["access","reason","message"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerClaim"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}/claim/reply":{"post":{"operationId":"replyClaim","summary":"The buyer adds to their claim","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"},"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["access","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerClaim"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}/views":{"post":{"operationId":"trackOrderView","summary":"Delivery evidence: the buyer opened their order page","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["access"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/affiliate-program":{"get":{"operationId":"getAffiliateProgram","summary":"Program settings and totals","tags":["affiliate-program"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgram"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/affiliate-program.","x-store-explicit-path":"/v1/stores/{storeId}/affiliate-program"},"put":{"operationId":"updateAffiliateProgram","summary":"Commission, cookie window, approval and payout rules","tags":["affiliate-program"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"commissionBps":{"default":1000,"type":"integer","minimum":0,"maximum":10000},"cookieDays":{"default":30,"type":"integer","minimum":1,"maximum":365},"approval":{"default":"manual","type":"string","enum":["auto","manual"]},"holdDays":{"default":14,"type":"integer","minimum":0,"maximum":120},"minPayoutMinor":{"default":2500,"type":"integer","minimum":0,"maximum":9007199254740991},"terms":{"default":"Earn a commission on every paid order you refer. Self-referrals and refunded orders do not count.","type":"string","maxLength":4000},"newCustomersOnly":{"default":false,"type":"boolean"},"reward":{"default":"cash","type":"string","enum":["cash","store_credit"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgram"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/affiliate-program.","x-store-explicit-path":"/v1/stores/{storeId}/affiliate-program"}},"/v1/stores/{storeId}/affiliate-program":{"get":{"operationId":"getAffiliateProgramWithStoreId","summary":"Program settings and totals","tags":["affiliate-program"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgram"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/affiliate-program, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/affiliate-program"},"put":{"operationId":"updateAffiliateProgramWithStoreId","summary":"Commission, cookie window, approval and payout rules","tags":["affiliate-program"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"commissionBps":{"default":1000,"type":"integer","minimum":0,"maximum":10000},"cookieDays":{"default":30,"type":"integer","minimum":1,"maximum":365},"approval":{"default":"manual","type":"string","enum":["auto","manual"]},"holdDays":{"default":14,"type":"integer","minimum":0,"maximum":120},"minPayoutMinor":{"default":2500,"type":"integer","minimum":0,"maximum":9007199254740991},"terms":{"default":"Earn a commission on every paid order you refer. Self-referrals and refunded orders do not count.","type":"string","maxLength":4000},"newCustomersOnly":{"default":false,"type":"boolean"},"reward":{"default":"cash","type":"string","enum":["cash","store_credit"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgram"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PUT /v1/store/affiliate-program, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/affiliate-program"}},"/v1/store/affiliates":{"get":{"operationId":"listAffiliates","summary":"Affiliates with clicks, conversions and what you owe","tags":["affiliates"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","pending","paused"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"status","type":"string","enum":["affiliate","code","rate","clicks","orders","conversion","revenue","owed","paid","status","created"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAffiliatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/affiliates.","x-store-explicit-path":"/v1/stores/{storeId}/affiliates"},"post":{"operationId":"createAffiliate","summary":"Add an affiliate (emailed their link)","tags":["affiliates"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"code":{"anyOf":[{"type":"string","minLength":3,"maxLength":24,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"commissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"payoutEmail":{"default":null,"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"newCustomersOnly":{"default":null,"type":["boolean","null"]},"reward":{"default":null,"anyOf":[{"type":"string","enum":["cash","store_credit"]},{"type":"null"}]}},"required":["name","email","code","commissionBps"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/affiliates.","x-store-explicit-path":"/v1/stores/{storeId}/affiliates"}},"/v1/stores/{storeId}/affiliates":{"get":{"operationId":"listAffiliatesWithStoreId","summary":"Affiliates with clicks, conversions and what you owe","tags":["affiliates"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","pending","paused"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"status","type":"string","enum":["affiliate","code","rate","clicks","orders","conversion","revenue","owed","paid","status","created"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAffiliatesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/affiliates, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/affiliates"},"post":{"operationId":"createAffiliateWithStoreId","summary":"Add an affiliate (emailed their link)","tags":["affiliates"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"code":{"anyOf":[{"type":"string","minLength":3,"maxLength":24,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"commissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"payoutEmail":{"default":null,"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"newCustomersOnly":{"default":null,"type":["boolean","null"]},"reward":{"default":null,"anyOf":[{"type":"string","enum":["cash","store_credit"]},{"type":"null"}]}},"required":["name","email","code","commissionBps"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/affiliates, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/affiliates"}},"/v1/store/affiliates/{affiliateId}":{"get":{"operationId":"getAffiliate","summary":"One affiliate with commissions and payouts","tags":["affiliates"],"security":[{"apiKey":[]}],"parameters":[{"name":"affiliateId","in":"path","required":true,"schema":{"type":"string","pattern":"^aff_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/affiliates/{affiliateId}.","x-store-explicit-path":"/v1/stores/{storeId}/affiliates/{affiliateId}"},"patch":{"operationId":"updateAffiliate","summary":"Approve, pause or change an affiliate","tags":["affiliates"],"security":[{"apiKey":[]}],"parameters":[{"name":"affiliateId","in":"path","required":true,"schema":{"type":"string","pattern":"^aff_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending","active","paused","rejected"]},"commissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"note":{"type":"string","maxLength":2000},"payoutEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":120},"newCustomersOnly":{"type":["boolean","null"]},"reward":{"anyOf":[{"type":"string","enum":["cash","store_credit"]},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/affiliates/{affiliateId}.","x-store-explicit-path":"/v1/stores/{storeId}/affiliates/{affiliateId}"}},"/v1/stores/{storeId}/affiliates/{affiliateId}":{"get":{"operationId":"getAffiliateWithStoreId","summary":"One affiliate with commissions and payouts","tags":["affiliates"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"affiliateId","in":"path","required":true,"schema":{"type":"string","pattern":"^aff_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/affiliates/{affiliateId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/affiliates/{affiliateId}"},"patch":{"operationId":"updateAffiliateWithStoreId","summary":"Approve, pause or change an affiliate","tags":["affiliates"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"affiliateId","in":"path","required":true,"schema":{"type":"string","pattern":"^aff_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending","active","paused","rejected"]},"commissionBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"note":{"type":"string","maxLength":2000},"payoutEmail":{"anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":120},"newCustomersOnly":{"type":["boolean","null"]},"reward":{"anyOf":[{"type":"string","enum":["cash","store_credit"]},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PATCH /v1/store/affiliates/{affiliateId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/affiliates/{affiliateId}"}},"/v1/store/affiliates/{affiliateId}/payouts":{"post":{"operationId":"payAffiliate","summary":"Pay every approved commission: from your ShopFast balance, or record a payment you made yourself","tags":["affiliates"],"security":[{"apiKey":[]}],"parameters":[{"name":"affiliateId","in":"path","required":true,"schema":{"type":"string","pattern":"^aff_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["balance","external"]},"reference":{"default":"","type":"string","maxLength":120}},"required":["method"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/affiliates/{affiliateId}/payouts.","x-store-explicit-path":"/v1/stores/{storeId}/affiliates/{affiliateId}/payouts"}},"/v1/stores/{storeId}/affiliates/{affiliateId}/payouts":{"post":{"operationId":"payAffiliateWithStoreId","summary":"Pay every approved commission: from your ShopFast balance, or record a payment you made yourself","tags":["affiliates"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"affiliateId","in":"path","required":true,"schema":{"type":"string","pattern":"^aff_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["balance","external"]},"reference":{"default":"","type":"string","maxLength":120}},"required":["method"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/affiliates/{affiliateId}/payouts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/affiliates/{affiliateId}/payouts"}},"/v1/storefront/stores/{storeId}/affiliate-program":{"get":{"operationId":"affiliateProgramPublic","summary":"What the storefront sign-up page shows about the program","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgramPublicResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/affiliates":{"post":{"operationId":"affiliateSignup","summary":"Join the affiliate program from the storefront","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"website":{"default":"","type":"string","maxLength":300},"message":{"default":"","type":"string","maxLength":1000}},"required":["name","email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateSignupResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/affiliate-portal":{"get":{"operationId":"affiliatePortal","summary":"An affiliate's own stats (signed link from their email)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"token","in":"query","required":true,"schema":{"type":"string","minLength":20,"maxLength":400}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliatePortalResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/visits":{"post":{"operationId":"trackVisit","summary":"Storefront: a visit with a referral code, UTM tags or an outside referrer","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","maxLength":500},"landing":{"default":true,"type":"boolean"},"productView":{"default":false,"type":"boolean"},"pageView":{"default":false,"type":"boolean"},"event":{"default":null,"anyOf":[{"type":"string","enum":["add_to_cart","checkout"]},{"type":"null"}]},"referrerHost":{"anyOf":[{"type":"string","maxLength":253},{"type":"null"}]},"utmSource":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"utmMedium":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"utmCampaign":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"utmTerm":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"utmContent":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"ref":{"anyOf":[{"type":"string","minLength":3,"maxLength":24,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]}},"required":["path","referrerHost","utmSource","utmMedium","utmCampaign","ref"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackVisitResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/attributions":{"post":{"operationId":"attributeCheckout","summary":"Storefront: tie an open checkout to the referral code and campaign that brought the buyer","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"default":null,"anyOf":[{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"cartId":{"default":null,"anyOf":[{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"ref":{"anyOf":[{"type":"string","minLength":3,"maxLength":24,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"utmSource":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"utmMedium":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"utmCampaign":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"referrerHost":{"anyOf":[{"type":"string","maxLength":253},{"type":"null"}]},"landingPath":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"utmTerm":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"utmContent":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},"required":["ref","utmSource","utmMedium","utmCampaign","referrerHost","landingPath"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/promotions":{"get":{"operationId":"listPromotions","summary":"Sale campaigns with results","tags":["promotions"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","running","scheduled","ended","draft"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPromotionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/promotions.","x-store-explicit-path":"/v1/stores/{storeId}/promotions"},"post":{"operationId":"createPromotion","summary":"Schedule a sale","tags":["promotions"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"percentOffBps":{"type":"integer","minimum":100,"maximum":9000},"target":{"type":"string","enum":["all","collections","products","categories"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"stacking":{"type":"string","enum":["stack","exclusive"]},"banner":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"{percent} off for a limited time","type":"string","maxLength":120},"tone":{"default":"accent","type":"string","enum":["accent","ink","canvas"]},"countdown":{"default":true,"type":"boolean"},"link":{"default":"","type":"string","maxLength":300,"pattern":"^(?:|\\/[^\\s]*)$"}}},"enabled":{"type":"boolean"}},"required":["name","percentOffBps","target","collectionIds","productIds","startsAt","endsAt","stacking","banner","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/promotions.","x-store-explicit-path":"/v1/stores/{storeId}/promotions"}},"/v1/stores/{storeId}/promotions":{"get":{"operationId":"listPromotionsWithStoreId","summary":"Sale campaigns with results","tags":["promotions"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","running","scheduled","ended","draft"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPromotionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/promotions, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/promotions"},"post":{"operationId":"createPromotionWithStoreId","summary":"Schedule a sale","tags":["promotions"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"percentOffBps":{"type":"integer","minimum":100,"maximum":9000},"target":{"type":"string","enum":["all","collections","products","categories"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"stacking":{"type":"string","enum":["stack","exclusive"]},"banner":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"{percent} off for a limited time","type":"string","maxLength":120},"tone":{"default":"accent","type":"string","enum":["accent","ink","canvas"]},"countdown":{"default":true,"type":"boolean"},"link":{"default":"","type":"string","maxLength":300,"pattern":"^(?:|\\/[^\\s]*)$"}}},"enabled":{"type":"boolean"}},"required":["name","percentOffBps","target","collectionIds","productIds","startsAt","endsAt","stacking","banner","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/promotions, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/promotions"}},"/v1/store/promotions/{promotionId}":{"put":{"operationId":"updatePromotion","summary":"Change a sale","tags":["promotions"],"security":[{"apiKey":[]}],"parameters":[{"name":"promotionId","in":"path","required":true,"schema":{"type":"string","pattern":"^prm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"percentOffBps":{"type":"integer","minimum":100,"maximum":9000},"target":{"type":"string","enum":["all","collections","products","categories"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"stacking":{"type":"string","enum":["stack","exclusive"]},"banner":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"{percent} off for a limited time","type":"string","maxLength":120},"tone":{"default":"accent","type":"string","enum":["accent","ink","canvas"]},"countdown":{"default":true,"type":"boolean"},"link":{"default":"","type":"string","maxLength":300,"pattern":"^(?:|\\/[^\\s]*)$"}}},"enabled":{"type":"boolean"}},"required":["name","percentOffBps","target","collectionIds","productIds","startsAt","endsAt","stacking","banner","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/promotions/{promotionId}.","x-store-explicit-path":"/v1/stores/{storeId}/promotions/{promotionId}"},"delete":{"operationId":"deletePromotion","summary":"Delete a draft or scheduled sale","tags":["promotions"],"security":[{"apiKey":[]}],"parameters":[{"name":"promotionId","in":"path","required":true,"schema":{"type":"string","pattern":"^prm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/promotions/{promotionId}.","x-store-explicit-path":"/v1/stores/{storeId}/promotions/{promotionId}"}},"/v1/stores/{storeId}/promotions/{promotionId}":{"put":{"operationId":"updatePromotionWithStoreId","summary":"Change a sale","tags":["promotions"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"promotionId","in":"path","required":true,"schema":{"type":"string","pattern":"^prm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"percentOffBps":{"type":"integer","minimum":100,"maximum":9000},"target":{"type":"string","enum":["all","collections","products","categories"]},"collectionIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"}},"productIds":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"endsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"stacking":{"type":"string","enum":["stack","exclusive"]},"banner":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"{percent} off for a limited time","type":"string","maxLength":120},"tone":{"default":"accent","type":"string","enum":["accent","ink","canvas"]},"countdown":{"default":true,"type":"boolean"},"link":{"default":"","type":"string","maxLength":300,"pattern":"^(?:|\\/[^\\s]*)$"}}},"enabled":{"type":"boolean"}},"required":["name","percentOffBps","target","collectionIds","productIds","startsAt","endsAt","stacking","banner","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PUT /v1/store/promotions/{promotionId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/promotions/{promotionId}"},"delete":{"operationId":"deletePromotionWithStoreId","summary":"Delete a draft or scheduled sale","tags":["promotions"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"promotionId","in":"path","required":true,"schema":{"type":"string","pattern":"^prm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of DELETE /v1/store/promotions/{promotionId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/promotions/{promotionId}"}},"/v1/store/promotions/{promotionId}/end":{"post":{"operationId":"endPromotion","summary":"End a running sale now","tags":["promotions"],"security":[{"apiKey":[]}],"parameters":[{"name":"promotionId","in":"path","required":true,"schema":{"type":"string","pattern":"^prm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/promotions/{promotionId}/end.","x-store-explicit-path":"/v1/stores/{storeId}/promotions/{promotionId}/end"}},"/v1/stores/{storeId}/promotions/{promotionId}/end":{"post":{"operationId":"endPromotionWithStoreId","summary":"End a running sale now","tags":["promotions"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"promotionId","in":"path","required":true,"schema":{"type":"string","pattern":"^prm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/promotions/{promotionId}/end, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/promotions/{promotionId}/end"}},"/v1/store/reseller-program":{"get":{"operationId":"getResellerProgram","summary":"Wholesale settings, tiers and the application link","tags":["reseller-program"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetResellerProgramResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/reseller-program.","x-store-explicit-path":"/v1/stores/{storeId}/reseller-program"},"put":{"operationId":"updateResellerProgram","summary":"Turn wholesale on or off and edit the pitch","tags":["reseller-program"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"pitch":{"default":"Buy license keys in bulk at wholesale prices and resell them to your own customers.","type":"string","maxLength":2000}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResellerProgramResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/reseller-program.","x-store-explicit-path":"/v1/stores/{storeId}/reseller-program"}},"/v1/stores/{storeId}/reseller-program":{"get":{"operationId":"getResellerProgramWithStoreId","summary":"Wholesale settings, tiers and the application link","tags":["reseller-program"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetResellerProgramResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/reseller-program, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reseller-program"},"put":{"operationId":"updateResellerProgramWithStoreId","summary":"Turn wholesale on or off and edit the pitch","tags":["reseller-program"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"pitch":{"default":"Buy license keys in bulk at wholesale prices and resell them to your own customers.","type":"string","maxLength":2000}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResellerProgramResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PUT /v1/store/reseller-program, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reseller-program"}},"/v1/store/reseller-tiers":{"post":{"operationId":"createResellerTier","summary":"Add a pricing tier","tags":["reseller-tiers"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"discountBps":{"type":"integer","minimum":100,"maximum":9000},"minQuantity":{"type":"integer","minimum":1,"maximum":10000}},"required":["name","discountBps","minQuantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerTier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/reseller-tiers.","x-store-explicit-path":"/v1/stores/{storeId}/reseller-tiers"}},"/v1/stores/{storeId}/reseller-tiers":{"post":{"operationId":"createResellerTierWithStoreId","summary":"Add a pricing tier","tags":["reseller-tiers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"discountBps":{"type":"integer","minimum":100,"maximum":9000},"minQuantity":{"type":"integer","minimum":1,"maximum":10000}},"required":["name","discountBps","minQuantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerTier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/reseller-tiers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reseller-tiers"}},"/v1/store/reseller-tiers/{tierId}":{"put":{"operationId":"updateResellerTier","summary":"Change a pricing tier","tags":["reseller-tiers"],"security":[{"apiKey":[]}],"parameters":[{"name":"tierId","in":"path","required":true,"schema":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"discountBps":{"type":"integer","minimum":100,"maximum":9000},"minQuantity":{"type":"integer","minimum":1,"maximum":10000}},"required":["name","discountBps","minQuantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerTier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/reseller-tiers/{tierId}.","x-store-explicit-path":"/v1/stores/{storeId}/reseller-tiers/{tierId}"},"delete":{"operationId":"deleteResellerTier","summary":"Delete a tier nobody is on","tags":["reseller-tiers"],"security":[{"apiKey":[]}],"parameters":[{"name":"tierId","in":"path","required":true,"schema":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/reseller-tiers/{tierId}.","x-store-explicit-path":"/v1/stores/{storeId}/reseller-tiers/{tierId}"}},"/v1/stores/{storeId}/reseller-tiers/{tierId}":{"put":{"operationId":"updateResellerTierWithStoreId","summary":"Change a pricing tier","tags":["reseller-tiers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tierId","in":"path","required":true,"schema":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"discountBps":{"type":"integer","minimum":100,"maximum":9000},"minQuantity":{"type":"integer","minimum":1,"maximum":10000}},"required":["name","discountBps","minQuantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerTier"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PUT /v1/store/reseller-tiers/{tierId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reseller-tiers/{tierId}"},"delete":{"operationId":"deleteResellerTierWithStoreId","summary":"Delete a tier nobody is on","tags":["reseller-tiers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tierId","in":"path","required":true,"schema":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of DELETE /v1/store/reseller-tiers/{tierId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reseller-tiers/{tierId}"}},"/v1/store/resellers":{"get":{"operationId":"listResellers","summary":"Reseller accounts and applications","tags":["resellers"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"approved","type":"string","enum":["approved","pending","suspended","rejected","all"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResellersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/resellers.","x-store-explicit-path":"/v1/stores/{storeId}/resellers"},"post":{"operationId":"createReseller","summary":"Add an approved reseller (emailed their portal link)","tags":["resellers"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"company":{"default":"","type":"string","maxLength":120},"website":{"default":"","type":"string","maxLength":300},"tierId":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["name","email","tierId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/resellers.","x-store-explicit-path":"/v1/stores/{storeId}/resellers"}},"/v1/stores/{storeId}/resellers":{"get":{"operationId":"listResellersWithStoreId","summary":"Reseller accounts and applications","tags":["resellers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"approved","type":"string","enum":["approved","pending","suspended","rejected","all"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResellersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/resellers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resellers"},"post":{"operationId":"createResellerWithStoreId","summary":"Add an approved reseller (emailed their portal link)","tags":["resellers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"company":{"default":"","type":"string","maxLength":120},"website":{"default":"","type":"string","maxLength":300},"tierId":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["name","email","tierId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/resellers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resellers"}},"/v1/store/resellers/{resellerId}/review":{"post":{"operationId":"reviewReseller","summary":"Approve, reject, suspend or reinstate a reseller","tags":["resellers"],"security":[{"apiKey":[]}],"parameters":[{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","reject","suspend","reinstate"]},"tierId":{"default":null,"anyOf":[{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/resellers/{resellerId}/review.","x-store-explicit-path":"/v1/stores/{storeId}/resellers/{resellerId}/review"}},"/v1/stores/{storeId}/resellers/{resellerId}/review":{"post":{"operationId":"reviewResellerWithStoreId","summary":"Approve, reject, suspend or reinstate a reseller","tags":["resellers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","reject","suspend","reinstate"]},"tierId":{"default":null,"anyOf":[{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/resellers/{resellerId}/review, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resellers/{resellerId}/review"}},"/v1/store/resellers/{resellerId}":{"patch":{"operationId":"updateReseller","summary":"Move a reseller to another tier","tags":["resellers"],"security":[{"apiKey":[]}],"parameters":[{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tierId":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["tierId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/resellers/{resellerId}.","x-store-explicit-path":"/v1/stores/{storeId}/resellers/{resellerId}"}},"/v1/stores/{storeId}/resellers/{resellerId}":{"patch":{"operationId":"updateResellerWithStoreId","summary":"Move a reseller to another tier","tags":["resellers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tierId":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["tierId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of PATCH /v1/store/resellers/{resellerId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resellers/{resellerId}"}},"/v1/store/reseller-orders":{"get":{"operationId":"listResellerOrders","summary":"Bulk orders from resellers","tags":["reseller-orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"resellerId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResellerOrdersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/reseller-orders.","x-store-explicit-path":"/v1/stores/{storeId}/reseller-orders"}},"/v1/stores/{storeId}/reseller-orders":{"get":{"operationId":"listResellerOrdersWithStoreId","summary":"Bulk orders from resellers","tags":["reseller-orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"resellerId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResellerOrdersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/reseller-orders, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reseller-orders"}},"/v1/store/resellers/{resellerId}/orders":{"post":{"operationId":"createResellerOrder","summary":"Create a bulk order at the tier price and get its pay link","tags":["resellers"],"security":[{"apiKey":[]}],"parameters":[{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"quantity":{"type":"integer","minimum":1,"maximum":10000}},"required":["productId","quantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerOrder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/resellers/{resellerId}/orders.","x-store-explicit-path":"/v1/stores/{storeId}/resellers/{resellerId}/orders"}},"/v1/stores/{storeId}/resellers/{resellerId}/orders":{"post":{"operationId":"createResellerOrderWithStoreId","summary":"Create a bulk order at the tier price and get its pay link","tags":["resellers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"quantity":{"type":"integer","minimum":1,"maximum":10000}},"required":["productId","quantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerOrder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/resellers/{resellerId}/orders, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resellers/{resellerId}/orders"}},"/v1/store/reseller-orders/{resellerOrderId}/cancel":{"post":{"operationId":"cancelResellerOrder","summary":"Cancel an unpaid bulk order","tags":["reseller-orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"resellerOrderId","in":"path","required":true,"schema":{"type":"string","pattern":"^rso_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerOrder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/reseller-orders/{resellerOrderId}/cancel.","x-store-explicit-path":"/v1/stores/{storeId}/reseller-orders/{resellerOrderId}/cancel"}},"/v1/stores/{storeId}/reseller-orders/{resellerOrderId}/cancel":{"post":{"operationId":"cancelResellerOrderWithStoreId","summary":"Cancel an unpaid bulk order","tags":["reseller-orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"resellerOrderId","in":"path","required":true,"schema":{"type":"string","pattern":"^rso_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerOrder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/reseller-orders/{resellerOrderId}/cancel, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/reseller-orders/{resellerOrderId}/cancel"}},"/v1/storefront/stores/{storeId}/wholesale-program":{"get":{"operationId":"wholesaleProgramPublic","summary":"What the storefront wholesale page shows","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleProgramPublicResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/resellers":{"post":{"operationId":"resellerApply","summary":"Apply for a wholesale account","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"company":{"type":"string","minLength":1,"maxLength":120},"website":{"default":"","type":"string","maxLength":300},"message":{"default":"","type":"string","maxLength":2000}},"required":["name","email","company"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerApplyResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/wholesale":{"get":{"operationId":"wholesaleCatalog","summary":"An approved reseller's prices and bulk orders (signed link)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"token","in":"query","required":true,"schema":{"type":"string","minLength":20,"maxLength":400}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleCatalog"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/wholesale/orders":{"post":{"operationId":"wholesaleOrder","summary":"A reseller starts a bulk order at their tier price","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":400},"productId":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"quantity":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"resellerOrderId":{"default":null,"anyOf":[{"type":"string","pattern":"^rso_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleOrderResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/notifications":{"get":{"operationId":"listNotifications","summary":"The inbox, newest first, with your read state","tags":["notifications"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","unread","orders","support","stock","disputes","reviews","payouts","system","announcements"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotificationsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/notifications/summary":{"get":{"operationId":"notificationSummary","summary":"Unread count and the latest few, for the top bar bell","tags":["notifications"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationSummaryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/notifications/read":{"post":{"operationId":"markNotifications","summary":"Mark notifications read or unread (or all read)","tags":["notifications"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^inb_[0-9a-hjkmnp-tv-z]{20}$"}},"all":{"default":false,"type":"boolean"},"read":{"default":true,"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkNotificationsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/analytics/overview":{"get":{"operationId":"getGrowthOverview","summary":"Home KPIs, series, funnel and top lists for any date preset","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrowthOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/overview.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/overview"}},"/v1/stores/{storeId}/analytics/overview":{"get":{"operationId":"getGrowthOverviewWithStoreId","summary":"Home KPIs, series, funnel and top lists for any date preset","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrowthOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/overview, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/overview"}},"/v1/store/analytics/sales":{"get":{"operationId":"getSalesAnalytics","summary":"Gross to net, refunds, disputes, methods and hours","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/sales.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/sales"}},"/v1/stores/{storeId}/analytics/sales":{"get":{"operationId":"getSalesAnalyticsWithStoreId","summary":"Gross to net, refunds, disputes, methods and hours","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/sales, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/sales"}},"/v1/store/analytics/products":{"get":{"operationId":"getProductAnalytics","summary":"Per-product units, revenue, refunds and ratings","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/products.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/products"}},"/v1/stores/{storeId}/analytics/products":{"get":{"operationId":"getProductAnalyticsWithStoreId","summary":"Per-product units, revenue, refunds and ratings","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/products, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/products"}},"/v1/store/analytics/customers":{"get":{"operationId":"getCustomerAnalytics","summary":"New and returning customers, lifetime value, top buyers","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"customer","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"topSort","in":"query","required":false,"schema":{"default":"spent","type":"string","enum":["customer","country","orders","spent"]}},{"name":"topDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"countriesSort","in":"query","required":false,"schema":{"default":"revenue","type":"string","enum":["country","customers","revenue"]}},{"name":"countriesDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/customers.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/customers"}},"/v1/stores/{storeId}/analytics/customers":{"get":{"operationId":"getCustomerAnalyticsWithStoreId","summary":"New and returning customers, lifetime value, top buyers","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"customer","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"topSort","in":"query","required":false,"schema":{"default":"spent","type":"string","enum":["customer","country","orders","spent"]}},{"name":"topDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"countriesSort","in":"query","required":false,"schema":{"default":"revenue","type":"string","enum":["country","customers","revenue"]}},{"name":"countriesDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/customers, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/customers"}},"/v1/store/analytics/traffic":{"get":{"operationId":"getTrafficAnalytics","summary":"Visitors, the funnel, sources, referrers and landing pages","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrafficAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/traffic.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/traffic"}},"/v1/stores/{storeId}/analytics/traffic":{"get":{"operationId":"getTrafficAnalyticsWithStoreId","summary":"Visitors, the funnel, sources, referrers and landing pages","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrafficAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/traffic, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/traffic"}},"/v1/store/analytics/campaigns":{"get":{"operationId":"getCampaignAnalytics","summary":"UTM campaigns, promotions and affiliates","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"details","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"detailsSort","in":"query","required":false,"schema":{"default":"visitors","type":"string","enum":["campaign","term","content","visitors","orders","revenue"]}},{"name":"detailsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/campaigns.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/campaigns"}},"/v1/stores/{storeId}/analytics/campaigns":{"get":{"operationId":"getCampaignAnalyticsWithStoreId","summary":"UTM campaigns, promotions and affiliates","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"details","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"detailsSort","in":"query","required":false,"schema":{"default":"visitors","type":"string","enum":["campaign","term","content","visitors","orders","revenue"]}},{"name":"detailsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/campaigns, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/campaigns"}},"/v1/store/analytics/export":{"get":{"operationId":"exportAnalytics","summary":"One analytics tab as CSV","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"tab","in":"query","required":true,"schema":{"type":"string","enum":["overview","sales","products","customers","traffic","campaigns"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrowthCsv"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/export.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/export"}},"/v1/stores/{storeId}/analytics/export":{"get":{"operationId":"exportAnalyticsWithStoreId","summary":"One analytics tab as CSV","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"tab","in":"query","required":true,"schema":{"type":"string","enum":["overview","sales","products","customers","traffic","campaigns"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrowthCsv"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/export"}},"/v1/store/resell-partners":{"get":{"operationId":"listResellPartnerships","summary":"Store-to-store resell requests you received or sent, with units supplied and money moved","tags":["resell-partners"],"security":[{"apiKey":[]}],"parameters":[{"name":"side","in":"query","required":false,"schema":{"default":"received","type":"string","enum":["received","sent"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResellPartnershipsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/resell-partners.","x-store-explicit-path":"/v1/stores/{storeId}/resell-partners"},"post":{"operationId":"createResellRequest","summary":"Ask another store to let you resell its products at a discount","tags":["resell-partners"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","minLength":2,"maxLength":63,"pattern":"^[a-z0-9-]+$"},"discountBps":{"type":"integer","minimum":100,"maximum":10000},"productIds":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"message":{"default":"","type":"string","maxLength":1000}},"required":["handle","discountBps","productIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellPartnership"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/resell-partners.","x-store-explicit-path":"/v1/stores/{storeId}/resell-partners"}},"/v1/stores/{storeId}/resell-partners":{"get":{"operationId":"listResellPartnershipsWithStoreId","summary":"Store-to-store resell requests you received or sent, with units supplied and money moved","tags":["resell-partners"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"side","in":"query","required":false,"schema":{"default":"received","type":"string","enum":["received","sent"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResellPartnershipsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/resell-partners, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resell-partners"},"post":{"operationId":"createResellRequestWithStoreId","summary":"Ask another store to let you resell its products at a discount","tags":["resell-partners"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","minLength":2,"maxLength":63,"pattern":"^[a-z0-9-]+$"},"discountBps":{"type":"integer","minimum":100,"maximum":10000},"productIds":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"message":{"default":"","type":"string","maxLength":1000}},"required":["handle","discountBps","productIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellPartnership"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/resell-partners, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resell-partners"}},"/v1/store/resell-partners/supplier":{"get":{"operationId":"findResellSupplier","summary":"A store by its address and the key and serial products it can supply","tags":["resell-partners"],"security":[{"apiKey":[]}],"parameters":[{"name":"handle","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":63,"pattern":"^[a-z0-9-]+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindResellSupplierResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/resell-partners/supplier.","x-store-explicit-path":"/v1/stores/{storeId}/resell-partners/supplier"}},"/v1/stores/{storeId}/resell-partners/supplier":{"get":{"operationId":"findResellSupplierWithStoreId","summary":"A store by its address and the key and serial products it can supply","tags":["resell-partners"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"handle","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":63,"pattern":"^[a-z0-9-]+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindResellSupplierResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/resell-partners/supplier, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resell-partners/supplier"}},"/v1/store/resell-partners/{partnershipId}/decision":{"post":{"operationId":"decideResellPartnership","summary":"Accept or reject a request (supplier), cancel it (reseller), or end a partnership (either side)","tags":["resell-partners"],"security":[{"apiKey":[]}],"parameters":[{"name":"partnershipId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["accept","reject","cancel","end"]}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellPartnership"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/resell-partners/{partnershipId}/decision.","x-store-explicit-path":"/v1/stores/{storeId}/resell-partners/{partnershipId}/decision"}},"/v1/stores/{storeId}/resell-partners/{partnershipId}/decision":{"post":{"operationId":"decideResellPartnershipWithStoreId","summary":"Accept or reject a request (supplier), cancel it (reseller), or end a partnership (either side)","tags":["resell-partners"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"partnershipId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["accept","reject","cancel","end"]}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellPartnership"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/resell-partners/{partnershipId}/decision, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resell-partners/{partnershipId}/decision"}},"/v1/store/resell-partners/{partnershipId}/listings":{"post":{"operationId":"createResellListing","summary":"List a supplier's product in your store at your price (keys come from the supplier)","tags":["resell-partners"],"security":[{"apiKey":[]}],"parameters":[{"name":"partnershipId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"supplierProductId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"priceMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"name":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["supplierProductId","priceMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellPartnership"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/resell-partners/{partnershipId}/listings.","x-store-explicit-path":"/v1/stores/{storeId}/resell-partners/{partnershipId}/listings"}},"/v1/stores/{storeId}/resell-partners/{partnershipId}/listings":{"post":{"operationId":"createResellListingWithStoreId","summary":"List a supplier's product in your store at your price (keys come from the supplier)","tags":["resell-partners"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"partnershipId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"supplierProductId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"priceMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"name":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["supplierProductId","priceMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellPartnership"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/resell-partners/{partnershipId}/listings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resell-partners/{partnershipId}/listings"}},"/v1/store/orders/stats":{"get":{"operationId":"getOrderStats","summary":"Orders and revenue per status for today, 7 days, 4 weeks or all time (KPI cards)","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"period","in":"query","required":false,"schema":{"default":"7d","type":"string","enum":["today","7d","4w","all"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStats"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/orders/stats.","x-store-explicit-path":"/v1/stores/{storeId}/orders/stats"}},"/v1/stores/{storeId}/orders/stats":{"get":{"operationId":"getOrderStatsWithStoreId","summary":"Orders and revenue per status for today, 7 days, 4 weeks or all time (KPI cards)","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"period","in":"query","required":false,"schema":{"default":"7d","type":"string","enum":["today","7d","4w","all"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderStats"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/orders/stats, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/stats"}},"/v1/store/orders/export":{"get":{"operationId":"exportOrders","summary":"Every order matching the tab, search and filters, as CSV or JSON (up to 10,000 rows)","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"format","in":"query","required":false,"schema":{"default":"csv","type":"string","enum":["csv","json"]}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","pending","paid","fulfilled","refunded","disputed","failed","partially_refunded"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"method","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},{"type":"null"}]}},{"name":"provider","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},{"type":"null"}]}},{"name":"statuses","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200,"pattern":"^[a-z_]+(?:,[a-z_]+)*$"},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"minTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"maxTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"discordId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},{"name":"key","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},{"name":"paymentId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","number","customer","product","amount","method","country","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/orders/export.","x-store-explicit-path":"/v1/stores/{storeId}/orders/export"}},"/v1/stores/{storeId}/orders/export":{"get":{"operationId":"exportOrdersWithStoreId","summary":"Every order matching the tab, search and filters, as CSV or JSON (up to 10,000 rows)","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"format","in":"query","required":false,"schema":{"default":"csv","type":"string","enum":["csv","json"]}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","pending","paid","fulfilled","refunded","disputed","failed","partially_refunded"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"method","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},{"type":"null"}]}},{"name":"provider","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},{"type":"null"}]}},{"name":"statuses","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200,"pattern":"^[a-z_]+(?:,[a-z_]+)*$"},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"minTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"maxTotalMinor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"discordId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"country","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},{"name":"key","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},{"name":"paymentId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","number","customer","product","amount","method","country","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/orders/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/export"}},"/v1/store/orders/{orderId}/refunds":{"post":{"operationId":"createOrderRefund","summary":"Refund part or all of what is left, to the payment method or to store credit. Idempotent per key","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":280},"destination":{"default":"original","type":"string","enum":["original","store_credit"]},"idempotencyKey":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,80}$"},"bonus":{"type":"boolean"}},"required":["amountMinor","reason","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/refunds.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/refunds"}},"/v1/stores/{storeId}/orders/{orderId}/refunds":{"post":{"operationId":"createOrderRefundWithStoreId","summary":"Refund part or all of what is left, to the payment method or to store credit. Idempotent per key","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":280},"destination":{"default":"original","type":"string","enum":["original","store_credit"]},"idempotencyKey":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,80}$"},"bonus":{"type":"boolean"}},"required":["amountMinor","reason","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/refunds, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/refunds"}},"/v1/store/orders/{orderId}/notes":{"post":{"operationId":"addOrderNote","summary":"Add a private note to an order","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/notes.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/notes"}},"/v1/stores/{storeId}/orders/{orderId}/notes":{"post":{"operationId":"addOrderNoteWithStoreId","summary":"Add a private note to an order","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/notes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/notes"}},"/v1/store/orders/{orderId}/notes/{noteId}":{"delete":{"operationId":"deleteOrderNote","summary":"Delete a note","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"noteId","in":"path","required":true,"schema":{"type":"string","pattern":"^ont_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/orders/{orderId}/notes/{noteId}.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/notes/{noteId}"}},"/v1/stores/{storeId}/orders/{orderId}/notes/{noteId}":{"delete":{"operationId":"deleteOrderNoteWithStoreId","summary":"Delete a note","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"noteId","in":"path","required":true,"schema":{"type":"string","pattern":"^ont_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of DELETE /v1/store/orders/{orderId}/notes/{noteId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/notes/{noteId}"}},"/v1/store/orders/{orderId}/block":{"put":{"operationId":"blockOrderBuyer","summary":"Block or unblock the buyer's email and/or checkout IP (the store's fraud blocklist)","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"boolean"},"ip":{"type":"boolean"},"reason":{"default":"","type":"string","maxLength":280}},"required":["email","ip"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/orders/{orderId}/block.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/block"}},"/v1/stores/{storeId}/orders/{orderId}/block":{"put":{"operationId":"blockOrderBuyerWithStoreId","summary":"Block or unblock the buyer's email and/or checkout IP (the store's fraud blocklist)","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"boolean"},"ip":{"type":"boolean"},"reason":{"default":"","type":"string","maxLength":280}},"required":["email","ip"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:write","x-api-key-scope":"orders:write","description":"The explicit form of PUT /v1/store/orders/{orderId}/block, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/block"}},"/v1/store/orders/{orderId}/replace-keys":{"post":{"operationId":"replaceOrderKeys","summary":"Revoke delivered keys and deliver fresh ones from the pool (the buyer is emailed the new keys)","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyIds":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}},"reason":{"default":"","type":"string","maxLength":280},"notify":{"default":true,"type":"boolean"}},"required":["keyIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/replace-keys.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/replace-keys"}},"/v1/stores/{storeId}/orders/{orderId}/replace-keys":{"post":{"operationId":"replaceOrderKeysWithStoreId","summary":"Revoke delivered keys and deliver fresh ones from the pool (the buyer is emailed the new keys)","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyIds":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}},"reason":{"default":"","type":"string","maxLength":280},"notify":{"default":true,"type":"boolean"}},"required":["keyIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/replace-keys, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/replace-keys"}},"/v1/store/checkouts":{"get":{"operationId":"listCheckouts","summary":"Checkouts waiting for the buyer's own payment, abandoned ones, or ones still open at a provider","tags":["checkouts"],"security":[{"apiKey":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"default":"awaiting_payment","type":"string","enum":["awaiting_payment","abandoned","in_progress"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"provider","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","expires","buyer","items","total","how"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCheckoutsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/checkouts.","x-store-explicit-path":"/v1/stores/{storeId}/checkouts"}},"/v1/stores/{storeId}/checkouts":{"get":{"operationId":"listCheckoutsWithStoreId","summary":"Checkouts waiting for the buyer's own payment, abandoned ones, or ones still open at a provider","tags":["checkouts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"state","in":"query","required":false,"schema":{"default":"awaiting_payment","type":"string","enum":["awaiting_payment","abandoned","in_progress"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"provider","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","expires","buyer","items","total","how"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCheckoutsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/checkouts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/checkouts"}},"/v1/store/checkouts/{sessionId}":{"get":{"operationId":"getCheckout","summary":"One checkout that is not an order: awaiting payment, abandoned or still open at a provider","tags":["checkouts"],"security":[{"apiKey":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/checkouts/{sessionId}.","x-store-explicit-path":"/v1/stores/{storeId}/checkouts/{sessionId}"}},"/v1/stores/{storeId}/checkouts/{sessionId}":{"get":{"operationId":"getCheckoutWithStoreId","summary":"One checkout that is not an order: awaiting payment, abandoned or still open at a provider","tags":["checkouts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/checkouts/{sessionId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/checkouts/{sessionId}"}},"/v1/store/checkouts/{sessionId}/mark-paid":{"post":{"operationId":"markCheckoutPaid","summary":"Manual methods: record that the buyer paid. Creates the order and starts delivery","tags":["checkouts"],"security":[{"apiKey":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/checkouts/{sessionId}/mark-paid.","x-store-explicit-path":"/v1/stores/{storeId}/checkouts/{sessionId}/mark-paid"}},"/v1/stores/{storeId}/checkouts/{sessionId}/mark-paid":{"post":{"operationId":"markCheckoutPaidWithStoreId","summary":"Manual methods: record that the buyer paid. Creates the order and starts delivery","tags":["checkouts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/checkouts/{sessionId}/mark-paid, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/checkouts/{sessionId}/mark-paid"}},"/v1/store/checkouts/{sessionId}/cancel":{"post":{"operationId":"cancelCheckout","summary":"Close a checkout that will not be paid (releases held stock, gift card balance and store credit). A buyer waiting to pay hears why","tags":["checkouts"],"security":[{"apiKey":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"default":{"reason":""},"type":"object","properties":{"reason":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/checkouts/{sessionId}/cancel.","x-store-explicit-path":"/v1/stores/{storeId}/checkouts/{sessionId}/cancel"}},"/v1/stores/{storeId}/checkouts/{sessionId}/cancel":{"post":{"operationId":"cancelCheckoutWithStoreId","summary":"Close a checkout that will not be paid (releases held stock, gift card balance and store credit). A buyer waiting to pay hears why","tags":["checkouts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"default":{"reason":""},"type":"object","properties":{"reason":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/checkouts/{sessionId}/cancel, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/checkouts/{sessionId}/cancel"}},"/v1/store/customers/{customerId}/credit":{"get":{"operationId":"getCustomerCredit","summary":"A customer's store credit balance and history","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCredit"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:read","x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/customers/{customerId}/credit.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}/credit"},"post":{"operationId":"adjustCustomerCredit","summary":"Add or take off store credit","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":-100000000,"maximum":100000000},"note":{"default":"","type":"string","maxLength":280}},"required":["amountMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCredit"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:write","x-api-key-scope":"customers:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/customers/{customerId}/credit.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}/credit"}},"/v1/stores/{storeId}/customers/{customerId}/credit":{"get":{"operationId":"getCustomerCreditWithStoreId","summary":"A customer's store credit balance and history","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCredit"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:read","x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/customers/{customerId}/credit, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}/credit"},"post":{"operationId":"adjustCustomerCreditWithStoreId","summary":"Add or take off store credit","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":-100000000,"maximum":100000000},"note":{"default":"","type":"string","maxLength":280}},"required":["amountMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCredit"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:write","x-api-key-scope":"customers:write","description":"The explicit form of POST /v1/store/customers/{customerId}/credit, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}/credit"}},"/v1/store/gateways/manual":{"get":{"operationId":"listManualMethods","summary":"Manual payment methods (own gateway stores)","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListManualMethodsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/gateways/manual.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/manual"},"post":{"operationId":"createManualMethod","summary":"Add a manual payment method (an enabled one moves a store ShopFast Pay cannot serve to its own gateways)","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"instructions":{"type":"string","minLength":1,"maxLength":2000},"enabled":{"type":"boolean"},"payWithinHours":{"default":72,"type":"integer","minimum":1,"maximum":720}},"required":["name","instructions","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManualMethodResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gateways/manual.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/manual"}},"/v1/stores/{storeId}/gateways/manual":{"get":{"operationId":"listManualMethodsWithStoreId","summary":"Manual payment methods (own gateway stores)","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListManualMethodsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The explicit form of GET /v1/store/gateways/manual, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/manual"},"post":{"operationId":"createManualMethodWithStoreId","summary":"Add a manual payment method (an enabled one moves a store ShopFast Pay cannot serve to its own gateways)","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"instructions":{"type":"string","minLength":1,"maxLength":2000},"enabled":{"type":"boolean"},"payWithinHours":{"default":72,"type":"integer","minimum":1,"maximum":720}},"required":["name","instructions","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManualMethodResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/gateways/manual, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/manual"}},"/v1/store/gateways/manual/{methodId}":{"put":{"operationId":"updateManualMethod","summary":"Change a manual payment method","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[{"name":"methodId","in":"path","required":true,"schema":{"type":"string","pattern":"^mpm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"instructions":{"type":"string","minLength":1,"maxLength":2000},"enabled":{"type":"boolean"},"payWithinHours":{"default":72,"type":"integer","minimum":1,"maximum":720}},"required":["name","instructions","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateManualMethodResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/gateways/manual/{methodId}.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/manual/{methodId}"},"delete":{"operationId":"deleteManualMethod","summary":"Remove a manual payment method (checkouts already waiting keep their instructions)","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[{"name":"methodId","in":"path","required":true,"schema":{"type":"string","pattern":"^mpm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/gateways/manual/{methodId}.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/manual/{methodId}"}},"/v1/stores/{storeId}/gateways/manual/{methodId}":{"put":{"operationId":"updateManualMethodWithStoreId","summary":"Change a manual payment method","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"methodId","in":"path","required":true,"schema":{"type":"string","pattern":"^mpm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"instructions":{"type":"string","minLength":1,"maxLength":2000},"enabled":{"type":"boolean"},"payWithinHours":{"default":72,"type":"integer","minimum":1,"maximum":720}},"required":["name","instructions","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateManualMethodResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of PUT /v1/store/gateways/manual/{methodId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/manual/{methodId}"},"delete":{"operationId":"deleteManualMethodWithStoreId","summary":"Remove a manual payment method (checkouts already waiting keep their instructions)","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"methodId","in":"path","required":true,"schema":{"type":"string","pattern":"^mpm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of DELETE /v1/store/gateways/manual/{methodId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/manual/{methodId}"}},"/v1/store/gateways/btcpay":{"post":{"operationId":"connectBtcPay","summary":"Connect the seller's BTCPay Server store: checks the key and registers ShopFast's webhook","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"serverUrl":{"type":"string","maxLength":300,"pattern":"^https:\\/\\/"},"btcpayStoreId":{"type":"string","minLength":10,"maxLength":80,"pattern":"^[A-Za-z0-9]+$"},"apiKey":{"type":"string","minLength":20,"maxLength":120,"pattern":"^[A-Za-z0-9]+$"}},"required":["serverUrl","btcpayStoreId","apiKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayConnected"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gateways/btcpay.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/btcpay"}},"/v1/stores/{storeId}/gateways/btcpay":{"post":{"operationId":"connectBtcPayWithStoreId","summary":"Connect the seller's BTCPay Server store: checks the key and registers ShopFast's webhook","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"serverUrl":{"type":"string","maxLength":300,"pattern":"^https:\\/\\/"},"btcpayStoreId":{"type":"string","minLength":10,"maxLength":80,"pattern":"^[A-Za-z0-9]+$"},"apiKey":{"type":"string","minLength":20,"maxLength":120,"pattern":"^[A-Za-z0-9]+$"}},"required":["serverUrl","btcpayStoreId","apiKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayConnected"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/gateways/btcpay, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/btcpay"}},"/v1/store/gateways/{provider}/keys":{"post":{"operationId":"connectKeyedGateway","summary":"Connect a gateway with the seller's own API keys: checks them with the provider, sets up payment events and seals them. A store set to ShopFast Pay that ShopFast Pay cannot serve moves to its own gateways","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z]{2,30}$"},"additionalProperties":{"type":"string","maxLength":400}}},"required":["keys"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayConnected"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gateways/{provider}/keys.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/{provider}/keys"}},"/v1/stores/{storeId}/gateways/{provider}/keys":{"post":{"operationId":"connectKeyedGatewayWithStoreId","summary":"Connect a gateway with the seller's own API keys: checks them with the provider, sets up payment events and seals them. A store set to ShopFast Pay that ShopFast Pay cannot serve moves to its own gateways","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z]{2,30}$"},"additionalProperties":{"type":"string","maxLength":400}}},"required":["keys"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayConnected"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/gateways/{provider}/keys, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/{provider}/keys"}},"/v1/store/gateways/{provider}/settings":{"post":{"operationId":"updateKeyedSettings","summary":"Change a connected gateway's optional settings without reconnecting (Stripe: the publishable key and the payment method configuration): checked with the provider, sealed with the keys","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z]{2,30}$"},"additionalProperties":{"type":"string","maxLength":400}}},"required":["settings"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyedPayOptions"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gateways/{provider}/settings.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/{provider}/settings"}},"/v1/stores/{storeId}/gateways/{provider}/settings":{"post":{"operationId":"updateKeyedSettingsWithStoreId","summary":"Change a connected gateway's optional settings without reconnecting (Stripe: the publishable key and the payment method configuration): checked with the provider, sealed with the keys","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z]{2,30}$"},"additionalProperties":{"type":"string","maxLength":400}}},"required":["settings"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyedPayOptions"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/gateways/{provider}/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/{provider}/settings"}},"/v1/store/gateways/{provider}/options/refresh":{"post":{"operationId":"refreshKeyedOptions","summary":"Read the ways to pay the seller turned on at the provider again (Stripe's payment method configuration) and offer them at checkout","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyedPayOptions"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gateways/{provider}/options/refresh.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/{provider}/options/refresh"}},"/v1/stores/{storeId}/gateways/{provider}/options/refresh":{"post":{"operationId":"refreshKeyedOptionsWithStoreId","summary":"Read the ways to pay the seller turned on at the provider again (Stripe's payment method configuration) and offer them at checkout","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyedPayOptions"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/gateways/{provider}/options/refresh, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/{provider}/options/refresh"}},"/v1/store/gateways/shopify/authorize":{"get":{"operationId":"shopifyAuthorizeUrl","summary":"Shopify's page where the seller approves their own app (after connecting its keys). Its state works 15 minutes, for this store and member","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShopifyAuthorizeUrlResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/gateways/shopify/authorize.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/shopify/authorize"}},"/v1/stores/{storeId}/gateways/shopify/authorize":{"get":{"operationId":"shopifyAuthorizeUrlWithStoreId","summary":"Shopify's page where the seller approves their own app (after connecting its keys). Its state works 15 minutes, for this store and member","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShopifyAuthorizeUrlResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:read","description":"The explicit form of GET /v1/store/gateways/shopify/authorize, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/shopify/authorize"}},"/v1/store/gateways/shopify/callback":{"post":{"operationId":"completeShopifyConnect","summary":"Finish connecting Shopify with the query Shopify sent to /settings/payments/shopify: checks it, takes the app's token and adds ShopFast's webhooks","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,256}$"},"hmac":{"type":"string","pattern":"^[0-9a-fA-F]{64}$"},"shop":{"type":"string","maxLength":255,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]*\\.myshopify\\.com$"},"state":{"type":"string","minLength":1,"maxLength":1000},"timestamp":{"type":"string","pattern":"^\\d{1,12}$"},"host":{"default":null,"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["code","hmac","shop","state","timestamp"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayConnected"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gateways/shopify/callback.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/shopify/callback"}},"/v1/stores/{storeId}/gateways/shopify/callback":{"post":{"operationId":"completeShopifyConnectWithStoreId","summary":"Finish connecting Shopify with the query Shopify sent to /settings/payments/shopify: checks it, takes the app's token and adds ShopFast's webhooks","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,256}$"},"hmac":{"type":"string","pattern":"^[0-9a-fA-F]{64}$"},"shop":{"type":"string","maxLength":255,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]*\\.myshopify\\.com$"},"state":{"type":"string","minLength":1,"maxLength":1000},"timestamp":{"type":"string","pattern":"^\\d{1,12}$"},"host":{"default":null,"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["code","hmac","shop","state","timestamp"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayConnected"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/gateways/shopify/callback, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/shopify/callback"}},"/v1/store/gateways/{provider}":{"delete":{"operationId":"disconnectGateway","summary":"Disconnect a gateway: new checkouts stop using it; paid orders and refunds keep working where the provider allows","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisconnectGatewayResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/gateways/{provider}.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/{provider}"}},"/v1/stores/{storeId}/gateways/{provider}":{"delete":{"operationId":"disconnectGatewayWithStoreId","summary":"Disconnect a gateway: new checkouts stop using it; paid orders and refunds keep working where the provider allows","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisconnectGatewayResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of DELETE /v1/store/gateways/{provider}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/{provider}"}},"/v1/store/discounts/{discountId}/analytics":{"get":{"operationId":"getDiscountAnalytics","summary":"Orders, customers, revenue and a daily series for one discount","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/discounts/{discountId}/analytics.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/analytics"}},"/v1/stores/{storeId}/discounts/{discountId}/analytics":{"get":{"operationId":"getDiscountAnalyticsWithStoreId","summary":"Orders, customers, revenue and a daily series for one discount","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/discounts/{discountId}/analytics, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/analytics"}},"/v1/store/discounts/bulk-delete":{"post":{"operationId":"bulkDeleteDiscounts","summary":"Delete the chosen discounts; ones already used in orders are disabled instead so their history stays","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteDiscountsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/discounts/bulk-delete.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/bulk-delete"}},"/v1/stores/{storeId}/discounts/bulk-delete":{"post":{"operationId":"bulkDeleteDiscountsWithStoreId","summary":"Delete the chosen discounts; ones already used in orders are disabled instead so their history stays","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteDiscountsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/discounts/bulk-delete, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/bulk-delete"}},"/v1/store/gift-cards/{giftCardId}/expiry":{"put":{"operationId":"setGiftCardExpiry","summary":"Set or clear (null) the expiry date","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["expiresAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetGiftCardExpiryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/gift-cards/{giftCardId}/expiry.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards/{giftCardId}/expiry"}},"/v1/stores/{storeId}/gift-cards/{giftCardId}/expiry":{"put":{"operationId":"setGiftCardExpiryWithStoreId","summary":"Set or clear (null) the expiry date","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["expiresAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetGiftCardExpiryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of PUT /v1/store/gift-cards/{giftCardId}/expiry, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards/{giftCardId}/expiry"}},"/v1/store/gift-cards/{giftCardId}/share":{"post":{"operationId":"shareGiftCard","summary":"A signed link to the gift card page on the storefront (shows the balance; applies the card to the cart)","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gift-cards/{giftCardId}/share.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards/{giftCardId}/share"}},"/v1/stores/{storeId}/gift-cards/{giftCardId}/share":{"post":{"operationId":"shareGiftCardWithStoreId","summary":"A signed link to the gift card page on the storefront (shows the balance; applies the card to the cart)","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"giftCardId","in":"path","required":true,"schema":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareGiftCardResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/gift-cards/{giftCardId}/share, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards/{giftCardId}/share"}},"/v1/store/gift-cards/products":{"post":{"operationId":"createGiftCardProduct","summary":"Create a product that sells gift cards (one option per amount). Each unit bought issues a card","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"default":"","type":"string","maxLength":2000},"amountsMinor":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"integer","minimum":100,"maximum":100000000}}},"required":["name","amountsMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGiftCardProductResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/gift-cards/products.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards/products"},"get":{"operationId":"listGiftCardProducts","summary":"Products that sell gift cards","tags":["gift-cards"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGiftCardProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/gift-cards/products.","x-store-explicit-path":"/v1/stores/{storeId}/gift-cards/products"}},"/v1/stores/{storeId}/gift-cards/products":{"post":{"operationId":"createGiftCardProductWithStoreId","summary":"Create a product that sells gift cards (one option per amount). Each unit bought issues a card","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"default":"","type":"string","maxLength":2000},"amountsMinor":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"integer","minimum":100,"maximum":100000000}}},"required":["name","amountsMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGiftCardProductResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/gift-cards/products, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards/products"},"get":{"operationId":"listGiftCardProductsWithStoreId","summary":"Products that sell gift cards","tags":["gift-cards"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGiftCardProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/gift-cards/products, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gift-cards/products"}},"/v1/storefront/stores/{storeId}/gift-cards/balance":{"post":{"operationId":"storefrontGiftCardBalance","summary":"Check a gift card balance by code (rate limited)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":8,"maxLength":40,"pattern":"^[A-Za-z0-9 -]+$"}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardBalance"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/gift-cards/links/{token}":{"get":{"operationId":"storefrontGiftCardLink","summary":"A gift card from its signed share link","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"token","in":"path","required":true,"schema":{"type":"string","minLength":20,"maxLength":300}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardBalance"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}/gift-card-link":{"post":{"operationId":"storefrontRedeemGiftCardLink","summary":"Apply a shared gift card to the cart","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":300}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/gateways/{provider}/verify":{"post":{"operationId":"adminVerifyGateway","summary":"Check the loaded keys against the provider (account, webhook secret, partner id). Never returns a key","tags":["admin gateways"],"security":[{"adminSession":[]}],"parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayVerification"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/schedules":{"get":{"operationId":"adminListSchedules","summary":"Recurring platform jobs: payouts, checkout expiry, delivery re-queue","tags":["admin schedules"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListSchedulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/schedules/{name}/run":{"post":{"operationId":"adminRunSchedule","summary":"Run a recurring job now","tags":["admin schedules"],"security":[{"adminSession":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","enum":["payouts","expire_checkouts","requeue_deliveries","prune_data","upload_gc","analytics_rollup","analytics_partitions","analytics_alerts","analytics_reports","trust_maintenance","comms_dispatch","comms_maintenance","licensing","usp_discord","push_cleanup","crypto_watch","h4_community","prune_errors","own_gateway_fees","plan_comps","payment_models","description_html","read_models","ai_welcome_grants","ai_data_retention","shopfast_community","activity_retention","stripe_methods","pay_limits","invoices","referral_rewards","plan_limits"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformSchedule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/audit-log":{"get":{"operationId":"listStoreAudit","summary":"Every change made in the store (dashboard and API keys), newest first (or by who, action or target)","tags":["audit-log"],"security":[{"apiKey":[]}],"parameters":[{"name":"actor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}]},{"type":"null"}]}},{"name":"area","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"targetType","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"targetId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sensitive","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"actorKind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["user","api_key"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","actor","action","target"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStoreAuditResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/audit-log.","x-store-explicit-path":"/v1/stores/{storeId}/audit-log"}},"/v1/stores/{storeId}/audit-log":{"get":{"operationId":"listStoreAuditWithStoreId","summary":"Every change made in the store (dashboard and API keys), newest first (or by who, action or target)","tags":["audit-log"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"actor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}]},{"type":"null"}]}},{"name":"area","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"targetType","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"targetId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sensitive","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"actorKind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["user","api_key"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","actor","action","target"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStoreAuditResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The explicit form of GET /v1/store/audit-log, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/audit-log"}},"/v1/store/audit-log/export":{"get":{"operationId":"exportStoreAudit","summary":"The filtered store audit log as CSV (up to 10,000 rows)","tags":["audit-log"],"security":[{"apiKey":[]}],"parameters":[{"name":"actor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}]},{"type":"null"}]}},{"name":"area","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"targetType","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"targetId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sensitive","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"actorKind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["user","api_key"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStoreAuditResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/audit-log/export.","x-store-explicit-path":"/v1/stores/{storeId}/audit-log/export"}},"/v1/stores/{storeId}/audit-log/export":{"get":{"operationId":"exportStoreAuditWithStoreId","summary":"The filtered store audit log as CSV (up to 10,000 rows)","tags":["audit-log"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"actor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}]},{"type":"null"}]}},{"name":"area","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"targetType","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"targetId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sensitive","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"actorKind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["user","api_key"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStoreAuditResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The explicit form of GET /v1/store/audit-log/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/audit-log/export"}},"/v1/store/orders/{orderId}/resend-delivery":{"post":{"operationId":"resendOrderDelivery","summary":"Email the buyer their receipt again, with their license keys and fresh download links (3 per order per hour)","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendDeliveryResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/resend-delivery.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/resend-delivery"}},"/v1/stores/{storeId}/orders/{orderId}/resend-delivery":{"post":{"operationId":"resendOrderDeliveryWithStoreId","summary":"Email the buyer their receipt again, with their license keys and fresh download links (3 per order per hour)","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendDeliveryResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/resend-delivery, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/resend-delivery"}},"/v1/store/orders/{orderId}/retry-delivery":{"post":{"operationId":"retryOrderDelivery","summary":"Put failed delivery steps back in the queue and run fulfillment again","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/retry-delivery.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/retry-delivery"}},"/v1/stores/{storeId}/orders/{orderId}/retry-delivery":{"post":{"operationId":"retryOrderDeliveryWithStoreId","summary":"Put failed delivery steps back in the queue and run fulfillment again","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/retry-delivery, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/retry-delivery"}},"/v1/store/orders/{orderId}/mark-paid":{"post":{"operationId":"markOrderPaid","summary":"Complete an order that is waiting for a manual payment (your own gateway or a test order): runs delivery like a gateway payment","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/mark-paid.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/mark-paid"}},"/v1/stores/{storeId}/orders/{orderId}/mark-paid":{"post":{"operationId":"markOrderPaidWithStoreId","summary":"Complete an order that is waiting for a manual payment (your own gateway or a test order): runs delivery like a gateway payment","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/mark-paid, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/mark-paid"}},"/v1/openapi.json":{"get":{"operationId":"getOpenApi","summary":"This API as an OpenAPI 3.1 document, generated from the contract","tags":["openapi.json"],"security":[],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiDocument"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/providers":{"get":{"operationId":"getAuthProviders","summary":"Which other ways to sign in are switched on","tags":["auth"],"security":[],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProviders"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/password/forgot":{"post":{"operationId":"forgotPassword","summary":"Email a password reset link (15 minutes, one use). Always answers ok, whether or not the account exists.","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/password/reset/check":{"post":{"operationId":"checkPasswordReset","summary":"Is a reset link still good? (The token goes in the body so it stays out of request logs.)","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPasswordResetResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/password/reset":{"post":{"operationId":"resetPassword","summary":"Set a new password from a reset link. Signs out every device, then signs in here (two-factor still asks for a code).","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"},"password":{"type":"string","minLength":10,"maxLength":200}},"required":["token","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/register":{"post":{"operationId":"registerByInvite","summary":"Create an account from a team invite and join that store. No store of your own is created.","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inviteToken":{"type":"string","minLength":30,"maxLength":100,"pattern":"^[A-Za-z0-9_-]+$"},"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"password":{"type":"string","minLength":10,"maxLength":200}},"required":["inviteToken","name","email","password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterByInviteResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores":{"post":{"operationId":"createStore","summary":"Create another store that you own, on the default plan","tags":["stores"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"handle":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"currency":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"timezone":{"default":null,"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]}},"required":["name","handle","country","currency"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStoreResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/store-handle":{"get":{"operationId":"checkNewStoreHandle","summary":"Is an address free for a new store?","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"handle","in":"query","required":true,"schema":{"type":"string","maxLength":60}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNewStoreHandleResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/access/contacts":{"get":{"operationId":"getAccessContacts","summary":"The owner and admins of this store: who can change your role","tags":["access"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccessContactsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/discord/members":{"get":{"operationId":"listDiscordMembers","summary":"Buyers with a Discord link or a Discord role to receive: account, roles granted, waiting or failed, and server membership","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","linked","waiting","failed"]}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"recent","type":"string","enum":["recent","buyer","discord","server","linked"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordMembersPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"}},"/v1/stores/{storeId}/discord/sync-log":{"get":{"operationId":"listDiscordSyncLog","summary":"Every role the bot granted or removed, newest first (or by customer, order, role or status)","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["succeeded","simulated","pending","failed"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","customer","order","role","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDiscordSyncLogResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"}},"/v1/stores/{storeId}/discord/members/{customerId}/pull":{"post":{"operationId":"pullDiscordMember","summary":"Add a linked buyer to the connected server with their guilds.join grant, then retry their roles","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordMember"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/pull":{"get":{"operationId":"getDiscordPull","summary":"The latest \"Pull all\" run and its progress","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDiscordPullResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"},"post":{"operationId":"startDiscordPull","summary":"Pull every linked buyer into the server (background job; returns the running one if it is already going)","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordPullRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/bot":{"get":{"operationId":"getDiscordBot","summary":"Slash commands, who can run them, teammates linked to Discord and recent command activity","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordBotOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"}},"/v1/stores/{storeId}/discord/bot/activity":{"get":{"operationId":"listDiscordCommands","summary":"Slash commands run in your server, newest first (or by command, who ran it or result). Keys are never logged","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"outcome","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["ok","denied","error"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","command","by","outcome"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDiscordCommandsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"}},"/v1/stores/{storeId}/discord/setup-code":{"post":{"operationId":"createDiscordSetupCode","summary":"A one-time code for /setup in a Discord server (15 minutes; replaces an older one)","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordSetupCode"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/staff/link":{"post":{"operationId":"startDiscordStaffLink","summary":"Link your own Discord account so the bot knows your role (returns the Discord authorize URL)","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartDiscordStaffLinkResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/discord/staff/callback":{"post":{"operationId":"completeDiscordStaffLink","summary":"Finish linking your Discord account with the code and state Discord sent back","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":4,"maxLength":200},"state":{"type":"string","minLength":20,"maxLength":900}},"required":["code","state"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordBotOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/discord/staff/{userId}":{"delete":{"operationId":"unlinkDiscordStaff","summary":"Unlink a teammate from Discord (yourself, or anyone with Discord write access)","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordBotOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/storefront/stores/{storeId}/discord/link":{"post":{"operationId":"startBuyerDiscordLink","summary":"Start linking the buyer's Discord account (OAuth2 identify + guilds.join); returns the authorize URL with a signed state","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"ticket"},"ticket":{"type":"string","minLength":20,"maxLength":600}},"required":["kind","ticket"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"account_order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","sessionId"]}]},"nonce":{"type":"string","pattern":"^[A-Za-z0-9_-]{22,64}$"},"returnTo":{"type":"string","enum":["order","verify","account"]}},"required":["proof","nonce","returnTo"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartBuyerDiscordLinkResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/link/complete":{"post":{"operationId":"completeBuyerDiscordLink","summary":"Finish the link: checks the state and nonce, saves the account, adds the buyer to the server and runs their waiting role grants","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":4,"maxLength":200},"state":{"type":"string","minLength":20,"maxLength":900},"nonce":{"type":"string","pattern":"^[A-Za-z0-9_-]{22,64}$"}},"required":["code","state","nonce"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerDiscordLinked"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/status":{"post":{"operationId":"getBuyerDiscordStatus","summary":"The buyer's Discord link and the roles their orders grant","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"ticket"},"ticket":{"type":"string","minLength":20,"maxLength":600}},"required":["kind","ticket"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"account_order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","sessionId"]}]}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerDiscordStatus"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/verify":{"post":{"operationId":"startDiscordVerify","summary":"Email a one-time code when the order number and email match (the answer is the same either way)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderNumber":{"type":"string","maxLength":24},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["orderNumber","email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartDiscordVerifyResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/verify/confirm":{"post":{"operationId":"confirmDiscordVerify","summary":"Check the code and return a short-lived ticket that proves the buyer owns the order","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderNumber":{"type":"string","maxLength":24},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["orderNumber","email","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmDiscordVerifyResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/unlink":{"post":{"operationId":"unlinkBuyerDiscord","summary":"The buyer disconnects their Discord account (roles already granted stay until a refund or the end of a membership)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"ticket"},"ticket":{"type":"string","minLength":20,"maxLength":600}},"required":["kind","ticket"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"account_order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","sessionId"]}]}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/announcements":{"get":{"operationId":"adminListAnnouncements","summary":"Announcements to sellers, newest publish time first, with delivery and agreement counts","tags":["admin announcements"],"security":[{"adminSession":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","scheduled","live","ended"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"channel","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["inbox","email","discord","ack"]},{"type":"null"}]}},{"name":"planId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"status","type":"string","enum":["title","audience","channels","reach","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListAnnouncementsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"adminCreateAnnouncement","summary":"Owner or support: publish or schedule an announcement (dashboard, email, needs agreeing)","tags":["admin announcements"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"body":{"type":"string","minLength":1,"maxLength":4000},"href":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"publishAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"expiresAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"planIds":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"}},"showInDashboard":{"default":true,"type":"boolean"},"sendEmail":{"default":false,"type":"boolean"},"requiresAck":{"default":false,"type":"boolean"},"discord":{"default":false,"type":"boolean"}},"required":["title","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAnnouncement"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/announcements/{announcementId}":{"get":{"operationId":"adminGetAnnouncement","summary":"One announcement with the stores that agreed to it","tags":["admin announcements"],"security":[{"adminSession":[]}],"parameters":[{"name":"announcementId","in":"path","required":true,"schema":{"type":"string","pattern":"^ann_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminGetAnnouncementResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"adminUpdateAnnouncement","summary":"Owner or support: edit an announcement that is not archived. Emails already sent stay sent.","tags":["admin announcements"],"security":[{"adminSession":[]}],"parameters":[{"name":"announcementId","in":"path","required":true,"schema":{"type":"string","pattern":"^ann_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"body":{"type":"string","minLength":1,"maxLength":4000},"href":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"publishAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"expiresAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"planIds":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"}},"showInDashboard":{"default":true,"type":"boolean"},"sendEmail":{"default":false,"type":"boolean"},"requiresAck":{"default":false,"type":"boolean"},"discord":{"default":false,"type":"boolean"}},"required":["title","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAnnouncement"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/announcements/{announcementId}/archive":{"post":{"operationId":"adminArchiveAnnouncement","summary":"Owner or support: take an announcement down (removed from every inbox, queued emails cancelled)","tags":["admin announcements"],"security":[{"adminSession":[]}],"parameters":[{"name":"announcementId","in":"path","required":true,"schema":{"type":"string","pattern":"^ann_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAnnouncement"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/announcements/pending":{"get":{"operationId":"listPendingAnnouncements","summary":"Live ShopFast announcements this store still has to agree to","tags":["announcements"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPendingAnnouncementsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/announcements/{announcementId}/acknowledge":{"post":{"operationId":"acknowledgeAnnouncement","summary":"Agree to a ShopFast announcement on behalf of the store (recorded with who and when)","tags":["announcements"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"announcementId","in":"path","required":true,"schema":{"type":"string","pattern":"^ann_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/admin/support/lookup":{"get":{"operationId":"adminSupportLookup","summary":"Find orders and buyers across every store by order number (SF-1042), order id or buyer email","tags":["admin support"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":3,"maxLength":254}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["pending","paid","fulfilled","partially_fulfilled","refunded","disputed","failed"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"order","type":"string","enum":["order","store","buyer","total","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"customerSort","in":"query","required":false,"schema":{"default":"since","type":"string","enum":["buyer","store","orders","since"]}},{"name":"customerDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportLookup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/view-sessions":{"post":{"operationId":"adminStartViewSession","summary":"Owner or support: open a time-limited, read-only view of a store (recorded in the audit log with the reason)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":8,"maxLength":280},"minutes":{"default":15,"anyOf":[{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":30},{"type":"number","const":60}]}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewSession"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"get":{"operationId":"adminListViewSessions","summary":"Recent view-as sessions on a store","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListViewSessionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/view-sessions/{sessionId}":{"get":{"operationId":"adminGetViewSnapshot","summary":"The store's orders, products, customers and settings, read-only, while your view session is open","tags":["admin view-sessions"],"security":[{"adminSession":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^avs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderQ","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"orderStatus","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["pending","paid","fulfilled","partially_fulfilled","refunded","disputed","failed"]},{"type":"null"}]}},{"name":"orderSort","in":"query","required":false,"schema":{"default":"order","type":"string","enum":["order","buyer","items","total","status"]}},{"name":"orderDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"productQ","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"productStatus","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["active","draft","archived"]},{"type":"null"}]}},{"name":"productType","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},{"type":"null"}]}},{"name":"productSort","in":"query","required":false,"schema":{"default":"updated","type":"string","enum":["name","type","stock","price","status","updated"]}},{"name":"productDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"customerQ","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"customerSort","in":"query","required":false,"schema":{"default":"since","type":"string","enum":["name","country","orders","since"]}},{"name":"customerDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewSnapshot"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/view-sessions/{sessionId}/end":{"post":{"operationId":"adminEndViewSession","summary":"Close your view session early","tags":["admin view-sessions"],"security":[{"adminSession":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^avs_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewSession"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/orders/{orderId}/release-hold":{"post":{"operationId":"releaseOrderHold","summary":"Deliver an order that was held for review","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/release-hold.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/release-hold"}},"/v1/stores/{storeId}/orders/{orderId}/release-hold":{"post":{"operationId":"releaseOrderHoldWithStoreId","summary":"Deliver an order that was held for review","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/release-hold, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/release-hold"}},"/v1/admin/plan-invoices":{"get":{"operationId":"adminListPlanInvoices","summary":"Plan invoices across stores, open first","tags":["admin plan-invoices"],"security":[{"adminSession":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"default":"open","type":"string","enum":["open","paid","void","all"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListPlanInvoicesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/plan-invoices/{invoiceId}/paid":{"post":{"operationId":"adminMarkPlanInvoicePaid","summary":"Mark a plan invoice paid","tags":["admin plan-invoices"],"security":[{"adminSession":[]}],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","pattern":"^pinv_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","minLength":1,"maxLength":280}},"required":["note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPlanInvoiceRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/auth/login/second-factor":{"post":{"operationId":"adminLoginSecondFactor","summary":"Finish admin sign-in with a TOTP or recovery code","tags":["admin auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"challenge":{"type":"string","minLength":10,"maxLength":1000},"code":{"type":"string","minLength":6,"maxLength":20}},"required":["challenge","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLoginSecondFactorResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/admins/{adminId}/reset-second-factor":{"post":{"operationId":"adminResetSecondFactor","summary":"Reset an admin's two-factor sign-in","tags":["admin admins"],"security":[{"adminSession":[]}],"parameters":[{"name":"adminId","in":"path","required":true,"schema":{"type":"string","pattern":"^adm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminResetSecondFactorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/products/{productId}/keys/{keyId}/reveal":{"post":{"operationId":"revealLicenseKey","summary":"Show one license key in full","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevealLicenseKeyResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/keys/{keyId}/reveal.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/keys/{keyId}/reveal"}},"/v1/stores/{storeId}/products/{productId}/keys/{keyId}/reveal":{"post":{"operationId":"revealLicenseKeyWithStoreId","summary":"Show one license key in full","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevealLicenseKeyResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/keys/{keyId}/reveal, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/keys/{keyId}/reveal"}},"/v1/auth/email/verify":{"post":{"operationId":"verifyEmail","summary":"Confirm a seller email address","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":1000}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyEmailResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/email/check":{"post":{"operationId":"checkSignupEmail","summary":"Check an email can sign up","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254}},"required":["email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSignupEmailResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/email/resend":{"post":{"operationId":"resendEmailVerification","summary":"Email the confirmation link again","tags":["auth"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendEmailVerificationResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/api-keys/usage":{"get":{"operationId":"getApiUsage","summary":"Requests over time for every key (or one), with latency and the busiest routes","tags":["api-keys"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"24h","type":"string","enum":["24h","7d","30d"]}},{"name":"keyId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUsage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/api-keys/requests":{"get":{"operationId":"listApiRequests","summary":"The request log of API keys and OAuth apps, newest first (or sorted by status, path, key, duration or IP)","tags":["api-keys"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","success","client_error","server_error","rate_limited","denied"]}},{"name":"method","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":200}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","status","path","key","duration","ip"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiRequestsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/oauth-apps":{"get":{"operationId":"listOAuthApps","summary":"OAuth apps this store publishes","tags":["oauth-apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOAuthAppsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"},"post":{"operationId":"createOAuthApp","summary":"Register an OAuth app. The client secret is in the response, once","tags":["oauth-apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":60},"description":{"default":"","type":"string","maxLength":300},"homepageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500,"format":"uri"},{"type":"null"}]},"redirectUris":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":500,"format":"uri"}},"scopes":{"type":"object","propertyNames":{"type":"string","enum":["store","catalog","orders","customers","marketing","storefront","analytics","balance","webhooks","security","team","audit","support","settings","payments"]},"additionalProperties":{"type":"string","enum":["none","read","write"]}}},"required":["name","redirectUris","scopes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOAuthAppResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/oauth-apps/{appId}":{"patch":{"operationId":"updateOAuthApp","summary":"Change the app's details, redirect URIs or scopes, or turn it off","tags":["oauth-apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","pattern":"^oap_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":60},"description":{"default":"","type":"string","maxLength":300},"homepageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500,"format":"uri"},{"type":"null"}]},"redirectUris":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":500,"format":"uri"}},"scopes":{"type":"object","propertyNames":{"type":"string","enum":["store","catalog","orders","customers","marketing","storefront","analytics","balance","webhooks","security","team","audit","support","settings","payments"]},"additionalProperties":{"type":"string","enum":["none","read","write"]}},"status":{"type":"string","enum":["active","disabled"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthApp"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"},"delete":{"operationId":"deleteOAuthApp","summary":"Delete the app. Every store that connected it loses access","tags":["oauth-apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","pattern":"^oap_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/oauth-apps/{appId}/secret":{"post":{"operationId":"rotateOAuthSecret","summary":"Replace the client secret. The old one stops working at once","tags":["oauth-apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","pattern":"^oap_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateOAuthSecretResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/oauth-connections":{"get":{"operationId":"listOAuthConnections","summary":"Third-party apps with access to this store","tags":["oauth-connections"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOAuthConnectionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/oauth-connections/{grantId}":{"delete":{"operationId":"revokeOAuthConnection","summary":"Disconnect an app. Its tokens stop working at once","tags":["oauth-connections"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"grantId","in":"path","required":true,"schema":{"type":"string","pattern":"^ogr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/oauth/consent":{"get":{"operationId":"getOAuthConsent","summary":"What the consent screen shows for an authorization request","tags":["oauth"],"security":[{"sellerSession":[]}],"parameters":[{"name":"client_id","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500}},{"name":"redirect_uri","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500}},{"name":"response_type","in":"query","required":true,"schema":{"type":"string","const":"code"}},{"name":"scope","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":500}},{"name":"state","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":500}},{"name":"code_challenge","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43,128}$"}},{"name":"code_challenge_method","in":"query","required":true,"schema":{"type":"string","const":"S256"}},{"name":"resource","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":500}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthConsent"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"decideOAuth","summary":"Approve or deny an authorization request. Returns where to send the browser","tags":["oauth"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"client_id":{"type":"string","minLength":1,"maxLength":500},"redirect_uri":{"type":"string","minLength":1,"maxLength":500},"response_type":{"type":"string","const":"code"},"scope":{"default":"","type":"string","maxLength":500},"state":{"default":"","type":"string","maxLength":500},"code_challenge":{"type":"string","pattern":"^[A-Za-z0-9_-]{43,128}$"},"code_challenge_method":{"type":"string","const":"S256"},"resource":{"default":"","type":"string","maxLength":500},"storeId":{"type":"string"},"approve":{"type":"boolean"},"access":{"default":"write","type":"string","enum":["read","write"]}},"required":["client_id","redirect_uri","response_type","code_challenge","code_challenge_method","storeId","approve"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecideOAuthResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/webhooks/events":{"get":{"operationId":"listWebhookEvents","summary":"Events sent to your endpoints, newest first (or sorted by type, deliveries or id)","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"type","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]}},{"name":"after","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"delivery","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["failed","pending","delivered"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","type","deliveries","id"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookEventsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read","x-api-key-scope":"webhooks:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/webhooks/events.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/events"}},"/v1/stores/{storeId}/webhooks/events":{"get":{"operationId":"listWebhookEventsWithStoreId","summary":"Events sent to your endpoints, newest first (or sorted by type, deliveries or id)","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"type","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]}},{"name":"after","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"delivery","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["failed","pending","delivered"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","type","deliveries","id"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookEventsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read","x-api-key-scope":"webhooks:read","description":"The explicit form of GET /v1/store/webhooks/events, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/events"}},"/v1/store/webhooks/events/{eventId}":{"get":{"operationId":"getWebhookEvent","summary":"One event: the exact signed body and where it went","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","pattern":"^msg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExplorerEventDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read","x-api-key-scope":"webhooks:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/webhooks/events/{eventId}.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/events/{eventId}"}},"/v1/stores/{storeId}/webhooks/events/{eventId}":{"get":{"operationId":"getWebhookEventWithStoreId","summary":"One event: the exact signed body and where it went","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string","pattern":"^msg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExplorerEventDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read","x-api-key-scope":"webhooks:read","description":"The explicit form of GET /v1/store/webhooks/events/{eventId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/events/{eventId}"}},"/v1/store/webhooks/events/{eventId}/resend":{"post":{"operationId":"resendWebhookEvent","summary":"Send the event again to one endpoint, or to every endpoint subscribed to its type","tags":["webhooks"],"security":[{"apiKey":[]}],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","pattern":"^msg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"endpointId":{"default":null,"anyOf":[{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendWebhookEventResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write","x-api-key-scope":"webhooks:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/webhooks/events/{eventId}/resend.","x-store-explicit-path":"/v1/stores/{storeId}/webhooks/events/{eventId}/resend"}},"/v1/stores/{storeId}/webhooks/events/{eventId}/resend":{"post":{"operationId":"resendWebhookEventWithStoreId","summary":"Send the event again to one endpoint, or to every endpoint subscribed to its type","tags":["webhooks"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string","pattern":"^msg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"endpointId":{"default":null,"anyOf":[{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendWebhookEventResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write","x-api-key-scope":"webhooks:write","description":"The explicit form of POST /v1/store/webhooks/events/{eventId}/resend, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/webhooks/events/{eventId}/resend"}},"/v1/stores/{storeId}/embeds":{"get":{"operationId":"getEmbedSettings","summary":"Which sites may frame your product embeds","tags":["embeds"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"},"put":{"operationId":"updateEmbedSettings","summary":"Limit embeds to your own sites (empty: any site)","tags":["embeds"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedOrigins":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200,"pattern":"^https:\\/\\/[a-z0-9.-]+(?::\\d{1,5})?$|^http:\\/\\/(?:localhost|127\\.0\\.0\\.1)(?::\\d{1,5})?$"}}},"required":["allowedOrigins"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/tutorials":{"get":{"operationId":"listTours","summary":"Your progress through each guided tour","tags":["tutorials"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListToursResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/tutorials/{tour}":{"put":{"operationId":"updateTour","summary":"Save where you are in a tour (or that you finished or skipped it)","tags":["tutorials"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tour","in":"path","required":true,"schema":{"type":"string","enum":["first-product","theme","payments","discord","webhooks","plugins"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["not_started","active","done","skipped"]},"step":{"type":"integer","minimum":0,"maximum":50}},"required":["status","step"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TourProgress"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/plugins":{"get":{"operationId":"listPlugins","summary":"Installed plugins with their status and last day of runs","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPluginsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"},"post":{"operationId":"createPlugin","summary":"Start a plugin from a template of its kind, or install one from the catalog (as a draft)","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["payment","delivery","checkout_hook","webhook_transformer"]},"name":{"type":"string","minLength":1,"maxLength":60}},"required":["kind","name"]},{"type":"object","properties":{"catalogSlug":{"type":"string","minLength":1,"maxLength":60}},"required":["catalogSlug"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/catalog":{"get":{"operationId":"listPluginCatalog","summary":"Plugins you can install from the ShopFast catalog","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPluginCatalogResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/plugins/{pluginId}":{"get":{"operationId":"getPlugin","summary":"One plugin: its latest source, manifest, versions, settings and stats","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"},"delete":{"operationId":"deletePlugin","summary":"Delete the plugin with its versions, data and logs","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/{pluginId}/versions/{versionId}":{"get":{"operationId":"getPluginVersion","summary":"The source and manifest of one saved version","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^plv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPluginVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/plugins/{pluginId}/lint":{"post":{"operationId":"lintPlugin","summary":"Compile the draft in the sandbox and report syntax errors and lint warnings","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"type":"string","maxLength":200000},"manifest":{"type":"string","maxLength":20000}},"required":["source","manifest"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LintPluginResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/plugins/{pluginId}/versions":{"post":{"operationId":"savePluginVersion","summary":"Save the draft as a new version. It goes live only when you activate it","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"type":"string","maxLength":200000},"manifest":{"type":"string","maxLength":20000},"note":{"default":"","type":"string","maxLength":200}},"required":["source","manifest"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/{pluginId}/test":{"post":{"operationId":"testPlugin","summary":"Run fixtures against the draft in the sandbox. Network calls hit only the mocks you give","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"draft":{"type":"object","properties":{"source":{"type":"string","maxLength":200000},"manifest":{"type":"string","maxLength":20000}},"required":["source","manifest"]},"fixtures":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"hook":{"type":"string","enum":["create_payment","verify_callback","deliver","validate_cart","transform"]},"input":{"$ref":"#/$defs/__schema0"},"settings":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":4000},{"type":"number"},{"type":"boolean"},{"maxItems":200,"type":"array","items":{"type":"string","maxLength":40}},{"type":"null"}]}},"http":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000},"method":{"default":"*","type":"string","maxLength":10},"status":{"default":200,"type":"integer","minimum":100,"maximum":599},"headers":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"body":{"default":"","type":"string","maxLength":262144}},"required":["url"]}},"kv":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expect":{"default":null,"anyOf":[{"$ref":"#/$defs/__schema1"},{"type":"null"}]},"expectError":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["name","hook","input"]}}},"required":["draft","fixtures"],"$defs":{"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/$defs/__schema0"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/$defs/__schema0"}}]},"__schema1":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/$defs/__schema1"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/$defs/__schema1"}}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestPluginResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/{pluginId}/fixtures":{"get":{"operationId":"getPluginFixtures","summary":"Saved test fixtures (or the starter set for the plugin kind)","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPluginFixturesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"},"put":{"operationId":"savePluginFixtures","summary":"Save the test fixtures","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"hook":{"type":"string","enum":["create_payment","verify_callback","deliver","validate_cart","transform"]},"input":{"$ref":"#/$defs/__schema0"},"settings":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":4000},{"type":"number"},{"type":"boolean"},{"maxItems":200,"type":"array","items":{"type":"string","maxLength":40}},{"type":"null"}]}},"http":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000},"method":{"default":"*","type":"string","maxLength":10},"status":{"default":200,"type":"integer","minimum":100,"maximum":599},"headers":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"body":{"default":"","type":"string","maxLength":262144}},"required":["url"]}},"kv":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expect":{"default":null,"anyOf":[{"$ref":"#/$defs/__schema1"},{"type":"null"}]},"expectError":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["name","hook","input"]}}},"required":["items"],"$defs":{"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/$defs/__schema0"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/$defs/__schema0"}}]},"__schema1":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/$defs/__schema1"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/$defs/__schema1"}}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavePluginFixturesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/{pluginId}/activate":{"post":{"operationId":"activatePlugin","summary":"Run a saved version (also how you roll back). New permissions need your approval in the same call","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","pattern":"^plv_[0-9a-hjkmnp-tv-z]{20}$"},"approvePermissions":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["versionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/{pluginId}/disable":{"post":{"operationId":"disablePlugin","summary":"Stop running the plugin. Versions and settings stay","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/{pluginId}/settings":{"put":{"operationId":"updatePluginSettings","summary":"Save the values for the settings the manifest declares. Secrets are encrypted; leave one out to keep it","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":4000},{"type":"number"},{"type":"boolean"},{"maxItems":200,"type":"array","items":{"type":"string","maxLength":40}},{"type":"null"}]}}},"required":["values"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PluginDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/plugins/{pluginId}/runs":{"get":{"operationId":"listPluginRuns","summary":"Runs with their logs and metrics, newest first","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["ok","error","timeout","limit","denied"]},{"type":"null"}]}},{"name":"test","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","live","test"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPluginRunsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/plugins/{pluginId}/kv":{"get":{"operationId":"listPluginKv","summary":"The keys in the plugin's data store (values truncated)","tags":["plugins"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pluginId","in":"path","required":true,"schema":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPluginKvResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/storefront/stores/{storeId}/analytics/collect":{"post":{"operationId":"collectAnalytics","summary":"Storefront: a batch of browser events (page views, engagement, cart adds, outbound clicks, custom events)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"v":{"type":"number","const":1},"sentAt":{"type":"integer","minimum":0,"maximum":9007199254740991},"vid":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9]{16,40}$"},{"type":"null"}]},"consent":{"default":"cookieless","type":"string","enum":["cookieless","granted","denied"]},"gpc":{"default":false,"type":"boolean"},"lang":{"default":"","type":"string","maxLength":35},"tz":{"default":"","type":"string","maxLength":64},"signals":{"default":{"webdriver":false,"noLanguages":false,"screenW":0,"screenH":0,"neverVisible":false},"type":"object","properties":{"webdriver":{"default":false,"type":"boolean"},"noLanguages":{"default":false,"type":"boolean"},"screenW":{"default":0,"type":"integer","minimum":0,"maximum":20000},"screenH":{"default":0,"type":"integer","minimum":0,"maximum":20000},"neverVisible":{"default":false,"type":"boolean"}}},"events":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9]{12,32}$"},"name":{"type":"string","enum":["page_view","page_leave","add_to_cart","outbound_click","custom"]},"at":{"type":"integer","minimum":0,"maximum":9007199254740991},"path":{"type":"string","maxLength":500},"query":{"default":"","type":"string","maxLength":1000},"title":{"default":"","type":"string","maxLength":200},"referrer":{"default":null,"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"pageId":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z0-9]{12,32}$"},{"type":"null"}]},"engagedMs":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":86400000},{"type":"null"}]},"scrollPct":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"target":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"valueMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":1000000000},{"type":"null"}]},"props":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"number"},{"type":"boolean"}]}}},"required":["id","name","at","path"]}}},"required":["v","sentAt","events"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/analytics/events":{"post":{"operationId":"collectServerEvents","summary":"Storefront: server-side events (checkout started, payment attempted, sign-up, crawler hits)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"events":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9]{12,32}$"},"name":{"type":"string","enum":["begin_checkout","payment_attempt","signup","crawl"]},"path":{"type":"string","maxLength":500},"query":{"default":"","type":"string","maxLength":1000},"cartId":{"default":null,"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"valueMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":1000000000},{"type":"null"}]},"status":{"default":null,"anyOf":[{"type":"integer","minimum":100,"maximum":599},{"type":"null"}]},"props":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"number"},{"type":"boolean"}]}}},"required":["id","name","path"]}}},"required":["events"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/analytics/config":{"get":{"operationId":"getStorefrontAnalyticsConfig","summary":"Storefront: the consent mode the beacon runs in","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontAnalyticsConfig"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/analytics/shared/{token}":{"get":{"operationId":"getSharedReport","summary":"A read-only report behind a signed share link","tags":["analytics"],"security":[],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","minLength":20,"maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedReport"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/analytics/query":{"post":{"operationId":"queryAnalytics","summary":"Breakdowns, pivots and time series over sessions, with filters, a segment and the period before","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"compare":{"default":true,"type":"boolean"},"segmentId":{"default":null,"anyOf":[{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"queries":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,40}$"},"dimension":{"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"pivot":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"metrics":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov"]}},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"sort":{"default":null,"anyOf":[{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov","dimension"]},{"type":"null"}]},"sortDir":{"default":"desc","type":"string","enum":["asc","desc"]},"search":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"limit":{"default":25,"type":"integer","minimum":1,"maximum":500},"series":{"default":false,"type":"boolean"}},"required":["id","dimension","metrics"]}}},"required":["period","queries"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsQueryResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/query.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/query"}},"/v1/stores/{storeId}/analytics/query":{"post":{"operationId":"queryAnalyticsWithStoreId","summary":"Breakdowns, pivots and time series over sessions, with filters, a segment and the period before","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"compare":{"default":true,"type":"boolean"},"segmentId":{"default":null,"anyOf":[{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"queries":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,40}$"},"dimension":{"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"pivot":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"metrics":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov"]}},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"sort":{"default":null,"anyOf":[{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov","dimension"]},{"type":"null"}]},"sortDir":{"default":"desc","type":"string","enum":["asc","desc"]},"search":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"limit":{"default":25,"type":"integer","minimum":1,"maximum":500},"series":{"default":false,"type":"boolean"}},"required":["id","dimension","metrics"]}}},"required":["period","queries"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsQueryResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/query, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/query"}},"/v1/store/analytics/query/export":{"post":{"operationId":"exportAnalyticsQuery","summary":"The same queries as CSV or JSON","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"compare":{"default":true,"type":"boolean"},"segmentId":{"default":null,"anyOf":[{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"queries":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,40}$"},"dimension":{"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"pivot":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"metrics":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov"]}},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"sort":{"default":null,"anyOf":[{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov","dimension"]},{"type":"null"}]},"sortDir":{"default":"desc","type":"string","enum":["asc","desc"]},"search":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"limit":{"default":25,"type":"integer","minimum":1,"maximum":500},"series":{"default":false,"type":"boolean"}},"required":["id","dimension","metrics"]}},"format":{"default":"csv","type":"string","enum":["csv","json"]},"name":{"default":"report","type":"string","maxLength":60}},"required":["period","queries"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/query/export.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/query/export"}},"/v1/stores/{storeId}/analytics/query/export":{"post":{"operationId":"exportAnalyticsQueryWithStoreId","summary":"The same queries as CSV or JSON","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"compare":{"default":true,"type":"boolean"},"segmentId":{"default":null,"anyOf":[{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"queries":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,40}$"},"dimension":{"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"pivot":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]},"metrics":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov"]}},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"sort":{"default":null,"anyOf":[{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov","dimension"]},{"type":"null"}]},"sortDir":{"default":"desc","type":"string","enum":["asc","desc"]},"search":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"limit":{"default":25,"type":"integer","minimum":1,"maximum":500},"series":{"default":false,"type":"boolean"}},"required":["id","dimension","metrics"]}},"format":{"default":"csv","type":"string","enum":["csv","json"]},"name":{"default":"report","type":"string","maxLength":60}},"required":["period","queries"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/query/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/query/export"}},"/v1/store/analytics/realtime":{"get":{"operationId":"getAnalyticsRealtime","summary":"Visitors right now and the last 30 minutes","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/realtime.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/realtime"}},"/v1/stores/{storeId}/analytics/realtime":{"get":{"operationId":"getAnalyticsRealtimeWithStoreId","summary":"Visitors right now and the last 30 minutes","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/realtime, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/realtime"}},"/v1/store/analytics/pages":{"get":{"operationId":"getPagesReport","summary":"Pages, landing and exit pages, time on page and scroll depth","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"path","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"pagesSort","in":"query","required":false,"schema":{"default":"views","type":"string","enum":["path","views","visitors","entries","exit_rate","time","scroll"]}},{"name":"pagesDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"landingSort","in":"query","required":false,"schema":{"default":"sessions","type":"string","enum":["path","sessions","bounce_rate","conversion_rate","revenue"]}},{"name":"landingDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"exitsSort","in":"query","required":false,"schema":{"default":"exits","type":"string","enum":["path","exits","exit_rate"]}},{"name":"exitsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagesReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/pages.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/pages"}},"/v1/stores/{storeId}/analytics/pages":{"get":{"operationId":"getPagesReportWithStoreId","summary":"Pages, landing and exit pages, time on page and scroll depth","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"path","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"pagesSort","in":"query","required":false,"schema":{"default":"views","type":"string","enum":["path","views","visitors","entries","exit_rate","time","scroll"]}},{"name":"pagesDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"landingSort","in":"query","required":false,"schema":{"default":"sessions","type":"string","enum":["path","sessions","bounce_rate","conversion_rate","revenue"]}},{"name":"landingDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"exitsSort","in":"query","required":false,"schema":{"default":"exits","type":"string","enum":["path","exits","exit_rate"]}},{"name":"exitsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagesReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/pages, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/pages"}},"/v1/store/analytics/bots":{"get":{"operationId":"getBotsReport","summary":"Crawler traffic: verified, declared, spoofed and suspicious, by bot","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"bot","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"category","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["search","ai_answers","ai_training","seo","social_preview","monitoring","feed","automation","other"]},{"type":"null"}]}},{"name":"verification","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["verified","spoofed","declared"]},{"type":"null"}]}},{"name":"botsSort","in":"query","required":false,"schema":{"default":"hits","type":"string","enum":["name","verification","hits","paths","last_seen"]}},{"name":"botsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"device","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["desktop","mobile","tablet"]},{"type":"null"}]}},{"name":"suspiciousSort","in":"query","required":false,"schema":{"default":"sessions","type":"string","enum":["who","sessions","pageviews","score"]}},{"name":"suspiciousDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotsReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/bots.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/bots"}},"/v1/stores/{storeId}/analytics/bots":{"get":{"operationId":"getBotsReportWithStoreId","summary":"Crawler traffic: verified, declared, spoofed and suspicious, by bot","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"bot","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"category","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["search","ai_answers","ai_training","seo","social_preview","monitoring","feed","automation","other"]},{"type":"null"}]}},{"name":"verification","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["verified","spoofed","declared"]},{"type":"null"}]}},{"name":"botsSort","in":"query","required":false,"schema":{"default":"hits","type":"string","enum":["name","verification","hits","paths","last_seen"]}},{"name":"botsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"device","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["desktop","mobile","tablet"]},{"type":"null"}]}},{"name":"suspiciousSort","in":"query","required":false,"schema":{"default":"sessions","type":"string","enum":["who","sessions","pageviews","score"]}},{"name":"suspiciousDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotsReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/bots, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/bots"}},"/v1/store/analytics/attribution":{"get":{"operationId":"getAttributionReport","summary":"Orders credited to channels, sources and campaigns under six models","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"dimension","in":"query","required":false,"schema":{"default":"channel","type":"string","enum":["channel","source","campaign","source_medium","affiliate","landing"]}},{"name":"lookbackDays","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"last_non_direct","type":"string","enum":["key","first_touch","last_touch","last_non_direct","linear","position_based","time_decay"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"by","in":"query","required":false,"schema":{"default":"revenue","type":"string","enum":["revenue","conversions"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributionReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/attribution.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/attribution"}},"/v1/stores/{storeId}/analytics/attribution":{"get":{"operationId":"getAttributionReportWithStoreId","summary":"Orders credited to channels, sources and campaigns under six models","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"dimension","in":"query","required":false,"schema":{"default":"channel","type":"string","enum":["channel","source","campaign","source_medium","affiliate","landing"]}},{"name":"lookbackDays","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"last_non_direct","type":"string","enum":["key","first_touch","last_touch","last_non_direct","linear","position_based","time_decay"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"by","in":"query","required":false,"schema":{"default":"revenue","type":"string","enum":["revenue","conversions"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributionReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/attribution, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/attribution"}},"/v1/store/analytics/cohorts":{"get":{"operationId":"getCohorts","summary":"Customer cohorts by first order, retention and lifetime value","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"granularity","in":"query","required":false,"schema":{"default":"month","type":"string","enum":["week","month"]}},{"name":"metric","in":"query","required":false,"schema":{"default":"customers","type":"string","enum":["customers","orders","revenue"]}},{"name":"periods","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^\\d+$"}]}},{"name":"channelSort","in":"query","required":false,"schema":{"default":"customers","type":"string","enum":["key","customers","repeat_rate","orders_per_customer","ltv"]}},{"name":"channelDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"productSort","in":"query","required":false,"schema":{"default":"customers","type":"string","enum":["key","customers","repeat_rate","orders_per_customer","ltv"]}},{"name":"productDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"product","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CohortReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/cohorts.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/cohorts"}},"/v1/stores/{storeId}/analytics/cohorts":{"get":{"operationId":"getCohortsWithStoreId","summary":"Customer cohorts by first order, retention and lifetime value","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"granularity","in":"query","required":false,"schema":{"default":"month","type":"string","enum":["week","month"]}},{"name":"metric","in":"query","required":false,"schema":{"default":"customers","type":"string","enum":["customers","orders","revenue"]}},{"name":"periods","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^\\d+$"}]}},{"name":"channelSort","in":"query","required":false,"schema":{"default":"customers","type":"string","enum":["key","customers","repeat_rate","orders_per_customer","ltv"]}},{"name":"channelDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"productSort","in":"query","required":false,"schema":{"default":"customers","type":"string","enum":["key","customers","repeat_rate","orders_per_customer","ltv"]}},{"name":"productDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"product","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CohortReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/cohorts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/cohorts"}},"/v1/store/analytics/product-conversion":{"get":{"operationId":"getProductConversion","summary":"Product views to cart to orders, per product and type","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"term","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"searchesSort","in":"query","required":false,"schema":{"default":"searches","type":"string","enum":["term","searches","viewed"]}},{"name":"searchesDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductConversionReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/product-conversion.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/product-conversion"}},"/v1/stores/{storeId}/analytics/product-conversion":{"get":{"operationId":"getProductConversionWithStoreId","summary":"Product views to cart to orders, per product and type","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"term","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"searchesSort","in":"query","required":false,"schema":{"default":"searches","type":"string","enum":["term","searches","viewed"]}},{"name":"searchesDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductConversionReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/product-conversion, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/product-conversion"}},"/v1/store/analytics/ads":{"get":{"operationId":"getAdsReport","summary":"Ad spend with CPM, CPC, CPA and ROAS per campaign","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"model","in":"query","required":false,"schema":{"default":"last_non_direct","type":"string","enum":["first_touch","last_touch","last_non_direct","linear","position_based","time_decay"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/ads.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/ads"}},"/v1/stores/{storeId}/analytics/ads":{"get":{"operationId":"getAdsReportWithStoreId","summary":"Ad spend with CPM, CPC, CPA and ROAS per campaign","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"model","in":"query","required":false,"schema":{"default":"last_non_direct","type":"string","enum":["first_touch","last_touch","last_non_direct","linear","position_based","time_decay"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/ads, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/ads"}},"/v1/store/analytics/ads/spend":{"post":{"operationId":"createAdSpend","summary":"Add one day of spend for a campaign","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"platform":{"type":"string","enum":["google","meta","tiktok","x","reddit","microsoft","linkedin","pinterest","snapchat","youtube","discord","newsletter","other"]},"campaign":{"type":"string","minLength":1,"maxLength":100},"impressions":{"type":"integer","minimum":0,"maximum":1000000000},"clicks":{"type":"integer","minimum":0,"maximum":1000000000},"spendMinor":{"type":"integer","minimum":0,"maximum":100000000000}},"required":["day","platform","campaign","impressions","clicks","spendMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdSpendRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/ads/spend.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/ads/spend"}},"/v1/stores/{storeId}/analytics/ads/spend":{"post":{"operationId":"createAdSpendWithStoreId","summary":"Add one day of spend for a campaign","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"day":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"platform":{"type":"string","enum":["google","meta","tiktok","x","reddit","microsoft","linkedin","pinterest","snapchat","youtube","discord","newsletter","other"]},"campaign":{"type":"string","minLength":1,"maxLength":100},"impressions":{"type":"integer","minimum":0,"maximum":1000000000},"clicks":{"type":"integer","minimum":0,"maximum":1000000000},"spendMinor":{"type":"integer","minimum":0,"maximum":100000000000}},"required":["day","platform","campaign","impressions","clicks","spendMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdSpendRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/ads/spend, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/ads/spend"}},"/v1/store/analytics/ads/spend/{spendId}":{"delete":{"operationId":"deleteAdSpend","summary":"Remove a spend row","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"spendId","in":"path","required":true,"schema":{"type":"string","pattern":"^ads_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/ads/spend/{spendId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/ads/spend/{spendId}"}},"/v1/stores/{storeId}/analytics/ads/spend/{spendId}":{"delete":{"operationId":"deleteAdSpendWithStoreId","summary":"Remove a spend row","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"spendId","in":"path","required":true,"schema":{"type":"string","pattern":"^ads_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/ads/spend/{spendId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/ads/spend/{spendId}"}},"/v1/store/analytics/ads/imports":{"post":{"operationId":"importAdSpend","summary":"Import spend from a CSV export of an ad platform","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":120},"csv":{"type":"string","minLength":1,"maxLength":2000000},"platform":{"default":"other","type":"string","enum":["google","meta","tiktok","x","reddit","microsoft","linkedin","pinterest","snapchat","youtube","discord","newsletter","other"]}},"required":["filename","csv"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdImportResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/ads/imports.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/ads/imports"}},"/v1/stores/{storeId}/analytics/ads/imports":{"post":{"operationId":"importAdSpendWithStoreId","summary":"Import spend from a CSV export of an ad platform","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":120},"csv":{"type":"string","minLength":1,"maxLength":2000000},"platform":{"default":"other","type":"string","enum":["google","meta","tiktok","x","reddit","microsoft","linkedin","pinterest","snapchat","youtube","discord","newsletter","other"]}},"required":["filename","csv"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdImportResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/ads/imports, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/ads/imports"}},"/v1/store/analytics/ads/imports/{importId}":{"delete":{"operationId":"deleteAdImport","summary":"Remove an import and its rows","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^adi_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/ads/imports/{importId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/ads/imports/{importId}"}},"/v1/stores/{storeId}/analytics/ads/imports/{importId}":{"delete":{"operationId":"deleteAdImportWithStoreId","summary":"Remove an import and its rows","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^adi_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/ads/imports/{importId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/ads/imports/{importId}"}},"/v1/store/analytics/funnels/run":{"post":{"operationId":"runFunnel","summary":"Run a funnel definition over the period","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"compare":{"default":true,"type":"boolean"},"definition":{"type":"object","properties":{"steps":{"minItems":2,"maxItems":8,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["page_view","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom"]},"label":{"type":"string","minLength":1,"maxLength":60},"filters":{"default":[],"maxItems":5,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["path","product","product_type","target","search","prop"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"value":{"type":"string","maxLength":200},"prop":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},{"type":"null"}]}},"required":["field","op","value"]}}},"required":["event","label"]}},"windowMinutes":{"type":"integer","minimum":1,"maximum":43200},"scope":{"type":"string","enum":["session","visitor"]},"segment":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"breakdown":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]}},"required":["steps","windowMinutes","scope"]}},"required":["period","definition"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunnelResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/funnels/run.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/funnels/run"}},"/v1/stores/{storeId}/analytics/funnels/run":{"post":{"operationId":"runFunnelWithStoreId","summary":"Run a funnel definition over the period","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"compare":{"default":true,"type":"boolean"},"definition":{"type":"object","properties":{"steps":{"minItems":2,"maxItems":8,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["page_view","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom"]},"label":{"type":"string","minLength":1,"maxLength":60},"filters":{"default":[],"maxItems":5,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["path","product","product_type","target","search","prop"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"value":{"type":"string","maxLength":200},"prop":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},{"type":"null"}]}},"required":["field","op","value"]}}},"required":["event","label"]}},"windowMinutes":{"type":"integer","minimum":1,"maximum":43200},"scope":{"type":"string","enum":["session","visitor"]},"segment":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"breakdown":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]}},"required":["steps","windowMinutes","scope"]}},"required":["period","definition"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunnelResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/funnels/run, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/funnels/run"}},"/v1/store/analytics/funnels":{"get":{"operationId":"listFunnels","summary":"Saved funnels","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFunnelsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/funnels.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/funnels"},"post":{"operationId":"createFunnel","summary":"Save a funnel (from the builder or a template)","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"templateId":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"definition":{"type":"object","properties":{"steps":{"minItems":2,"maxItems":8,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["page_view","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom"]},"label":{"type":"string","minLength":1,"maxLength":60},"filters":{"default":[],"maxItems":5,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["path","product","product_type","target","search","prop"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"value":{"type":"string","maxLength":200},"prop":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},{"type":"null"}]}},"required":["field","op","value"]}}},"required":["event","label"]}},"windowMinutes":{"type":"integer","minimum":1,"maximum":43200},"scope":{"type":"string","enum":["session","visitor"]},"segment":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"breakdown":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]}},"required":["steps","windowMinutes","scope"]},"pinned":{"default":false,"type":"boolean"}},"required":["name","definition"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedFunnel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/funnels.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/funnels"}},"/v1/stores/{storeId}/analytics/funnels":{"get":{"operationId":"listFunnelsWithStoreId","summary":"Saved funnels","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFunnelsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/funnels, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/funnels"},"post":{"operationId":"createFunnelWithStoreId","summary":"Save a funnel (from the builder or a template)","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"templateId":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"definition":{"type":"object","properties":{"steps":{"minItems":2,"maxItems":8,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["page_view","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom"]},"label":{"type":"string","minLength":1,"maxLength":60},"filters":{"default":[],"maxItems":5,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["path","product","product_type","target","search","prop"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"value":{"type":"string","maxLength":200},"prop":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},{"type":"null"}]}},"required":["field","op","value"]}}},"required":["event","label"]}},"windowMinutes":{"type":"integer","minimum":1,"maximum":43200},"scope":{"type":"string","enum":["session","visitor"]},"segment":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"breakdown":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]}},"required":["steps","windowMinutes","scope"]},"pinned":{"default":false,"type":"boolean"}},"required":["name","definition"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedFunnel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/funnels, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/funnels"}},"/v1/store/analytics/funnels/{funnelId}":{"put":{"operationId":"updateFunnel","summary":"Change a saved funnel","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"funnelId","in":"path","required":true,"schema":{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"templateId":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"definition":{"type":"object","properties":{"steps":{"minItems":2,"maxItems":8,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["page_view","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom"]},"label":{"type":"string","minLength":1,"maxLength":60},"filters":{"default":[],"maxItems":5,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["path","product","product_type","target","search","prop"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"value":{"type":"string","maxLength":200},"prop":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},{"type":"null"}]}},"required":["field","op","value"]}}},"required":["event","label"]}},"windowMinutes":{"type":"integer","minimum":1,"maximum":43200},"scope":{"type":"string","enum":["session","visitor"]},"segment":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"breakdown":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]}},"required":["steps","windowMinutes","scope"]},"pinned":{"default":false,"type":"boolean"}},"required":["name","definition"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedFunnel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/analytics/funnels/{funnelId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/funnels/{funnelId}"},"delete":{"operationId":"deleteFunnel","summary":"Delete a saved funnel","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"funnelId","in":"path","required":true,"schema":{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/funnels/{funnelId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/funnels/{funnelId}"}},"/v1/stores/{storeId}/analytics/funnels/{funnelId}":{"put":{"operationId":"updateFunnelWithStoreId","summary":"Change a saved funnel","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"funnelId","in":"path","required":true,"schema":{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"templateId":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"definition":{"type":"object","properties":{"steps":{"minItems":2,"maxItems":8,"type":"array","items":{"type":"object","properties":{"event":{"type":"string","enum":["page_view","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom"]},"label":{"type":"string","minLength":1,"maxLength":60},"filters":{"default":[],"maxItems":5,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["path","product","product_type","target","search","prop"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"value":{"type":"string","maxLength":200},"prop":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},{"type":"null"}]}},"required":["field","op","value"]}}},"required":["event","label"]}},"windowMinutes":{"type":"integer","minimum":1,"maximum":43200},"scope":{"type":"string","enum":["session","visitor"]},"segment":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"breakdown":{"default":null,"anyOf":[{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},{"type":"null"}]}},"required":["steps","windowMinutes","scope"]},"pinned":{"default":false,"type":"boolean"}},"required":["name","definition"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedFunnel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of PUT /v1/store/analytics/funnels/{funnelId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/funnels/{funnelId}"},"delete":{"operationId":"deleteFunnelWithStoreId","summary":"Delete a saved funnel","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"funnelId","in":"path","required":true,"schema":{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/funnels/{funnelId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/funnels/{funnelId}"}},"/v1/store/analytics/segments":{"get":{"operationId":"listSegments","summary":"Saved segments","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSegmentsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/segments.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/segments"},"post":{"operationId":"createSegment","summary":"Save a segment","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"default":"","type":"string","maxLength":200},"filters":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}}},"required":["name","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/segments.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/segments"}},"/v1/stores/{storeId}/analytics/segments":{"get":{"operationId":"listSegmentsWithStoreId","summary":"Saved segments","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSegmentsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/segments, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/segments"},"post":{"operationId":"createSegmentWithStoreId","summary":"Save a segment","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"default":"","type":"string","maxLength":200},"filters":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}}},"required":["name","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/segments, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/segments"}},"/v1/store/analytics/segments/{segmentId}":{"put":{"operationId":"updateSegment","summary":"Change a segment","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"segmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"default":"","type":"string","maxLength":200},"filters":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}}},"required":["name","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/analytics/segments/{segmentId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/segments/{segmentId}"},"delete":{"operationId":"deleteSegment","summary":"Delete a segment","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"segmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/segments/{segmentId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/segments/{segmentId}"}},"/v1/stores/{storeId}/analytics/segments/{segmentId}":{"put":{"operationId":"updateSegmentWithStoreId","summary":"Change a segment","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"segmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"default":"","type":"string","maxLength":200},"filters":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}}},"required":["name","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of PUT /v1/store/analytics/segments/{segmentId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/segments/{segmentId}"},"delete":{"operationId":"deleteSegmentWithStoreId","summary":"Delete a segment","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"segmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/segments/{segmentId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/segments/{segmentId}"}},"/v1/store/analytics/annotations":{"get":{"operationId":"listAnnotations","summary":"Chart notes (launches, campaigns, outages)","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAnnotationsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/annotations.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/annotations"},"post":{"operationId":"createAnnotation","summary":"Add a chart note","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"title":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":500},"tone":{"default":"accent","type":"string","enum":["neutral","accent","good","warn","danger"]}},"required":["date","title"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Annotation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/annotations.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/annotations"}},"/v1/stores/{storeId}/analytics/annotations":{"get":{"operationId":"listAnnotationsWithStoreId","summary":"Chart notes (launches, campaigns, outages)","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAnnotationsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/annotations, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/annotations"},"post":{"operationId":"createAnnotationWithStoreId","summary":"Add a chart note","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"title":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":500},"tone":{"default":"accent","type":"string","enum":["neutral","accent","good","warn","danger"]}},"required":["date","title"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Annotation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/annotations, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/annotations"}},"/v1/store/analytics/annotations/{annotationId}":{"put":{"operationId":"updateAnnotation","summary":"Change a chart note","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"annotationId","in":"path","required":true,"schema":{"type":"string","pattern":"^ano_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"title":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":500},"tone":{"default":"accent","type":"string","enum":["neutral","accent","good","warn","danger"]}},"required":["date","title"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Annotation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/analytics/annotations/{annotationId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/annotations/{annotationId}"},"delete":{"operationId":"deleteAnnotation","summary":"Delete a chart note","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"annotationId","in":"path","required":true,"schema":{"type":"string","pattern":"^ano_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/annotations/{annotationId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/annotations/{annotationId}"}},"/v1/stores/{storeId}/analytics/annotations/{annotationId}":{"put":{"operationId":"updateAnnotationWithStoreId","summary":"Change a chart note","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"annotationId","in":"path","required":true,"schema":{"type":"string","pattern":"^ano_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"title":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":500},"tone":{"default":"accent","type":"string","enum":["neutral","accent","good","warn","danger"]}},"required":["date","title"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Annotation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of PUT /v1/store/analytics/annotations/{annotationId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/annotations/{annotationId}"},"delete":{"operationId":"deleteAnnotationWithStoreId","summary":"Delete a chart note","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"annotationId","in":"path","required":true,"schema":{"type":"string","pattern":"^ano_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/annotations/{annotationId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/annotations/{annotationId}"}},"/v1/store/analytics/alerts":{"get":{"operationId":"listAlerts","summary":"Alert rules and what they found lately","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAlertsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/alerts.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/alerts"},"post":{"operationId":"createAlert","summary":"Add an alert (anomaly or threshold, emailed)","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"metric":{"type":"string","enum":["visitors","sessions","pageviews","conversions","conversion_rate","orders","revenue","bounce_rate","bot_share"]},"rule":{"type":"string","enum":["anomaly","drops_below","rises_above","change_pct"]},"threshold":{"type":"number","minimum":0,"maximum":1000000000000},"cadence":{"type":"string","enum":["hourly","daily"]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"enabled":{"default":true,"type":"boolean"}},"required":["name","metric","rule","threshold","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/alerts.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/alerts"}},"/v1/stores/{storeId}/analytics/alerts":{"get":{"operationId":"listAlertsWithStoreId","summary":"Alert rules and what they found lately","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAlertsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/alerts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/alerts"},"post":{"operationId":"createAlertWithStoreId","summary":"Add an alert (anomaly or threshold, emailed)","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"metric":{"type":"string","enum":["visitors","sessions","pageviews","conversions","conversion_rate","orders","revenue","bounce_rate","bot_share"]},"rule":{"type":"string","enum":["anomaly","drops_below","rises_above","change_pct"]},"threshold":{"type":"number","minimum":0,"maximum":1000000000000},"cadence":{"type":"string","enum":["hourly","daily"]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"enabled":{"default":true,"type":"boolean"}},"required":["name","metric","rule","threshold","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/alerts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/alerts"}},"/v1/store/analytics/alerts/{alertId}":{"put":{"operationId":"updateAlert","summary":"Change an alert","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"alertId","in":"path","required":true,"schema":{"type":"string","pattern":"^alr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"metric":{"type":"string","enum":["visitors","sessions","pageviews","conversions","conversion_rate","orders","revenue","bounce_rate","bot_share"]},"rule":{"type":"string","enum":["anomaly","drops_below","rises_above","change_pct"]},"threshold":{"type":"number","minimum":0,"maximum":1000000000000},"cadence":{"type":"string","enum":["hourly","daily"]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"enabled":{"default":true,"type":"boolean"}},"required":["name","metric","rule","threshold","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/analytics/alerts/{alertId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/alerts/{alertId}"},"delete":{"operationId":"deleteAlert","summary":"Delete an alert","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"alertId","in":"path","required":true,"schema":{"type":"string","pattern":"^alr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/alerts/{alertId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/alerts/{alertId}"}},"/v1/stores/{storeId}/analytics/alerts/{alertId}":{"put":{"operationId":"updateAlertWithStoreId","summary":"Change an alert","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string","pattern":"^alr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"metric":{"type":"string","enum":["visitors","sessions","pageviews","conversions","conversion_rate","orders","revenue","bounce_rate","bot_share"]},"rule":{"type":"string","enum":["anomaly","drops_below","rises_above","change_pct"]},"threshold":{"type":"number","minimum":0,"maximum":1000000000000},"cadence":{"type":"string","enum":["hourly","daily"]},"filters":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"op":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"]}},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"enabled":{"default":true,"type":"boolean"}},"required":["name","metric","rule","threshold","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Alert"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of PUT /v1/store/analytics/alerts/{alertId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/alerts/{alertId}"},"delete":{"operationId":"deleteAlertWithStoreId","summary":"Delete an alert","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string","pattern":"^alr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/alerts/{alertId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/alerts/{alertId}"}},"/v1/store/analytics/alerts/{alertId}/check":{"post":{"operationId":"checkAlert","summary":"Evaluate an alert now (emails only if it fires)","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"alertId","in":"path","required":true,"schema":{"type":"string","pattern":"^alr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAlertResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/alerts/{alertId}/check.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/alerts/{alertId}/check"}},"/v1/stores/{storeId}/analytics/alerts/{alertId}/check":{"post":{"operationId":"checkAlertWithStoreId","summary":"Evaluate an alert now (emails only if it fires)","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"alertId","in":"path","required":true,"schema":{"type":"string","pattern":"^alr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAlertResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/alerts/{alertId}/check, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/alerts/{alertId}/check"}},"/v1/store/analytics/reports":{"get":{"operationId":"listScheduledReports","summary":"Reports emailed on a schedule","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListScheduledReportsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/reports.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/reports"},"post":{"operationId":"createScheduledReport","summary":"Schedule a report","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["overview","traffic","pages","geography","bots","ads","funnel","financial"]},"funnelId":{"default":null,"anyOf":[{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"cadence":{"type":"string","enum":["daily","weekly","monthly"]},"weekday":{"default":1,"type":"integer","minimum":0,"maximum":6},"hour":{"default":8,"type":"integer","minimum":0,"maximum":23},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"format":{"default":"summary","type":"string","enum":["summary","csv"]},"enabled":{"default":true,"type":"boolean"}},"required":["name","kind","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/reports.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/reports"}},"/v1/stores/{storeId}/analytics/reports":{"get":{"operationId":"listScheduledReportsWithStoreId","summary":"Reports emailed on a schedule","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListScheduledReportsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/reports, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/reports"},"post":{"operationId":"createScheduledReportWithStoreId","summary":"Schedule a report","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["overview","traffic","pages","geography","bots","ads","funnel","financial"]},"funnelId":{"default":null,"anyOf":[{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"cadence":{"type":"string","enum":["daily","weekly","monthly"]},"weekday":{"default":1,"type":"integer","minimum":0,"maximum":6},"hour":{"default":8,"type":"integer","minimum":0,"maximum":23},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"format":{"default":"summary","type":"string","enum":["summary","csv"]},"enabled":{"default":true,"type":"boolean"}},"required":["name","kind","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/reports, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/reports"}},"/v1/store/analytics/reports/{reportId}":{"put":{"operationId":"updateScheduledReport","summary":"Change a scheduled report","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^srp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["overview","traffic","pages","geography","bots","ads","funnel","financial"]},"funnelId":{"default":null,"anyOf":[{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"cadence":{"type":"string","enum":["daily","weekly","monthly"]},"weekday":{"default":1,"type":"integer","minimum":0,"maximum":6},"hour":{"default":8,"type":"integer","minimum":0,"maximum":23},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"format":{"default":"summary","type":"string","enum":["summary","csv"]},"enabled":{"default":true,"type":"boolean"}},"required":["name","kind","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/analytics/reports/{reportId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/reports/{reportId}"},"delete":{"operationId":"deleteScheduledReport","summary":"Stop a scheduled report","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^srp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/reports/{reportId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/reports/{reportId}"}},"/v1/stores/{storeId}/analytics/reports/{reportId}":{"put":{"operationId":"updateScheduledReportWithStoreId","summary":"Change a scheduled report","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^srp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["overview","traffic","pages","geography","bots","ads","funnel","financial"]},"funnelId":{"default":null,"anyOf":[{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"cadence":{"type":"string","enum":["daily","weekly","monthly"]},"weekday":{"default":1,"type":"integer","minimum":0,"maximum":6},"hour":{"default":8,"type":"integer","minimum":0,"maximum":23},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"format":{"default":"summary","type":"string","enum":["summary","csv"]},"enabled":{"default":true,"type":"boolean"}},"required":["name","kind","cadence","recipients"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of PUT /v1/store/analytics/reports/{reportId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/reports/{reportId}"},"delete":{"operationId":"deleteScheduledReportWithStoreId","summary":"Stop a scheduled report","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^srp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/reports/{reportId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/reports/{reportId}"}},"/v1/store/analytics/reports/{reportId}/send":{"post":{"operationId":"sendScheduledReport","summary":"Send a scheduled report now","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^srp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendScheduledReportResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/reports/{reportId}/send.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/reports/{reportId}/send"}},"/v1/stores/{storeId}/analytics/reports/{reportId}/send":{"post":{"operationId":"sendScheduledReportWithStoreId","summary":"Send a scheduled report now","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^srp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendScheduledReportResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/reports/{reportId}/send, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/reports/{reportId}/send"}},"/v1/store/analytics/shares":{"get":{"operationId":"listShares","summary":"Read-only share links","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSharesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/shares.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/shares"},"post":{"operationId":"createShare","summary":"Create a signed, read-only link to a report","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["overview","traffic","pages","geography","bots","ads","funnel","financial"]},"funnelId":{"default":null,"anyOf":[{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"expiresInDays":{"default":30,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["name","kind","period"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportShare"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/analytics/shares.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/shares"}},"/v1/stores/{storeId}/analytics/shares":{"get":{"operationId":"listSharesWithStoreId","summary":"Read-only share links","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSharesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/shares, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/shares"},"post":{"operationId":"createShareWithStoreId","summary":"Create a signed, read-only link to a report","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["overview","traffic","pages","geography","bots","ads","funnel","financial"]},"funnelId":{"default":null,"anyOf":[{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"period":{"type":"object","properties":{"range":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"from":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"to":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"bucket":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}},"expiresInDays":{"default":30,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["name","kind","period"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportShare"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of POST /v1/store/analytics/shares, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/shares"}},"/v1/store/analytics/shares/{shareId}":{"delete":{"operationId":"revokeShare","summary":"Turn a share link off","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[{"name":"shareId","in":"path","required":true,"schema":{"type":"string","pattern":"^shr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/analytics/shares/{shareId}.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/shares/{shareId}"}},"/v1/stores/{storeId}/analytics/shares/{shareId}":{"delete":{"operationId":"revokeShareWithStoreId","summary":"Turn a share link off","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"shareId","in":"path","required":true,"schema":{"type":"string","pattern":"^shr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of DELETE /v1/store/analytics/shares/{shareId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/shares/{shareId}"}},"/v1/store/analytics/settings":{"get":{"operationId":"getAnalyticsSettings","summary":"Tracking settings and pipeline health","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsHealth"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/settings.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/settings"},"put":{"operationId":"updateAnalyticsSettings","summary":"Change consent mode, sessions and bot filtering","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consentMode":{"type":"string","enum":["cookieless","consent","first_party","off"]},"respectGpc":{"type":"boolean"},"sessionTimeoutMin":{"type":"integer","minimum":5,"maximum":120},"botFilter":{"type":"string","enum":["standard","strict"]},"excludedPaths":{"maxItems":20,"type":"array","items":{"type":"string","pattern":"^\\/[A-Za-z0-9/_.-]{0,99}$"}},"defaultModel":{"type":"string","enum":["first_touch","last_touch","last_non_direct","linear","position_based","time_decay"]},"lookbackDays":{"type":"integer","minimum":1,"maximum":90}},"required":["consentMode","respectGpc","sessionTimeoutMin","botFilter","excludedPaths","defaultModel","lookbackDays"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsHealth"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/analytics/settings.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/settings"}},"/v1/stores/{storeId}/analytics/settings":{"get":{"operationId":"getAnalyticsSettingsWithStoreId","summary":"Tracking settings and pipeline health","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsHealth"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/settings"},"put":{"operationId":"updateAnalyticsSettingsWithStoreId","summary":"Change consent mode, sessions and bot filtering","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consentMode":{"type":"string","enum":["cookieless","consent","first_party","off"]},"respectGpc":{"type":"boolean"},"sessionTimeoutMin":{"type":"integer","minimum":5,"maximum":120},"botFilter":{"type":"string","enum":["standard","strict"]},"excludedPaths":{"maxItems":20,"type":"array","items":{"type":"string","pattern":"^\\/[A-Za-z0-9/_.-]{0,99}$"}},"defaultModel":{"type":"string","enum":["first_touch","last_touch","last_non_direct","linear","position_based","time_decay"]},"lookbackDays":{"type":"integer","minimum":1,"maximum":90}},"required":["consentMode","respectGpc","sessionTimeoutMin","botFilter","excludedPaths","defaultModel","lookbackDays"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsHealth"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:write","x-api-key-scope":"analytics:write","description":"The explicit form of PUT /v1/store/analytics/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/settings"}},"/v1/store/financials/statement":{"get":{"operationId":"getFinancialStatement","summary":"Gross to net earnings for a period, per currency, tied out to the ledger","tags":["financials"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialStatement"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/financials/statement.","x-store-explicit-path":"/v1/stores/{storeId}/financials/statement"}},"/v1/stores/{storeId}/financials/statement":{"get":{"operationId":"getFinancialStatementWithStoreId","summary":"Gross to net earnings for a period, per currency, tied out to the ledger","tags":["financials"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialStatement"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The explicit form of GET /v1/store/financials/statement, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/financials/statement"}},"/v1/store/financials/monthly":{"get":{"operationId":"getMonthlyStatements","summary":"One statement row per month","tags":["financials"],"security":[{"apiKey":[]}],"parameters":[{"name":"months","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonthlyStatements"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/financials/monthly.","x-store-explicit-path":"/v1/stores/{storeId}/financials/monthly"}},"/v1/stores/{storeId}/financials/monthly":{"get":{"operationId":"getMonthlyStatementsWithStoreId","summary":"One statement row per month","tags":["financials"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"months","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonthlyStatements"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The explicit form of GET /v1/store/financials/monthly, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/financials/monthly"}},"/v1/store/financials/payouts":{"get":{"operationId":"getPayoutReconciliation","summary":"Payouts matched to their ledger journals, and the balance roll-forward","tags":["financials"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutReconciliation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/financials/payouts.","x-store-explicit-path":"/v1/stores/{storeId}/financials/payouts"}},"/v1/stores/{storeId}/financials/payouts":{"get":{"operationId":"getPayoutReconciliationWithStoreId","summary":"Payouts matched to their ledger journals, and the balance roll-forward","tags":["financials"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutReconciliation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The explicit form of GET /v1/store/financials/payouts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/financials/payouts"}},"/v1/store/financials/tax":{"get":{"operationId":"getTaxReport","summary":"Tax collected and refunded by buyer country","tags":["financials"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/financials/tax.","x-store-explicit-path":"/v1/stores/{storeId}/financials/tax"}},"/v1/stores/{storeId}/financials/tax":{"get":{"operationId":"getTaxReportWithStoreId","summary":"Tax collected and refunded by buyer country","tags":["financials"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The explicit form of GET /v1/store/financials/tax, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/financials/tax"}},"/v1/store/financials/export":{"get":{"operationId":"exportFinancials","summary":"A statement, the months, payouts, tax or the raw ledger as CSV","tags":["financials"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["statement","monthly","payouts","tax","ledger"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialCsv"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/financials/export.","x-store-explicit-path":"/v1/stores/{storeId}/financials/export"}},"/v1/stores/{storeId}/financials/export":{"get":{"operationId":"exportFinancialsWithStoreId","summary":"A statement, the months, payouts, tax or the raw ledger as CSV","tags":["financials"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"bucket","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["hour","day","week","month"]},{"type":"null"}]}},{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["statement","monthly","payouts","tax","ledger"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialCsv"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The explicit form of GET /v1/store/financials/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/financials/export"}},"/v1/stores/{storeId}/fraud/dashboard":{"get":{"operationId":"getFraudDashboard","summary":"Fraud Shield at a glance: checks by day and result, scores, top reasons, rules, countries and networks","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudDashboard"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/rules":{"get":{"operationId":"listFraudRules","summary":"The store's fraud rules in the order they run","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFraudRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"},"post":{"operationId":"createFraudRule","summary":"Add a fraud rule (it runs after the existing ones)","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"enabled":{"default":true,"type":"boolean"},"mode":{"default":"live","type":"string","enum":["live","shadow"]},"stage":{"default":"checkout","type":"string","enum":["checkout","payment"]},"match":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]},"actions":{"minItems":1,"maxItems":6,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"allow"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"block"},"message":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"review"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_email_verification"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_3ds"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"limit_quantity"},"max":{"type":"integer","minimum":1,"maximum":10000}},"required":["type","max"]},{"type":"object","properties":{"type":{"type":"string","const":"flag"},"label":{"type":"string","minLength":1,"maxLength":40}},"required":["type","label"]},{"type":"object","properties":{"type":{"type":"string","const":"score"},"points":{"type":"integer","minimum":-100,"maximum":100}},"required":["type","points"]},{"type":"object","properties":{"type":{"type":"string","const":"restrict_methods"}},"required":["type"]}]}},"stop":{"default":false,"type":"boolean"}},"required":["name","match","actions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/stores/{storeId}/fraud/rules/{ruleId}":{"put":{"operationId":"updateFraudRule","summary":"Change a fraud rule","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^frule_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"enabled":{"default":true,"type":"boolean"},"mode":{"default":"live","type":"string","enum":["live","shadow"]},"stage":{"default":"checkout","type":"string","enum":["checkout","payment"]},"match":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]},"actions":{"minItems":1,"maxItems":6,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"allow"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"block"},"message":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"review"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_email_verification"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_3ds"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"limit_quantity"},"max":{"type":"integer","minimum":1,"maximum":10000}},"required":["type","max"]},{"type":"object","properties":{"type":{"type":"string","const":"flag"},"label":{"type":"string","minLength":1,"maxLength":40}},"required":["type","label"]},{"type":"object","properties":{"type":{"type":"string","const":"score"},"points":{"type":"integer","minimum":-100,"maximum":100}},"required":["type","points"]},{"type":"object","properties":{"type":{"type":"string","const":"restrict_methods"}},"required":["type"]}]}},"stop":{"default":false,"type":"boolean"}},"required":["name","match","actions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"},"delete":{"operationId":"deleteFraudRule","summary":"Delete a fraud rule","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^frule_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/stores/{storeId}/fraud/rule-order":{"put":{"operationId":"reorderFraudRules","summary":"Set the order fraud rules run in","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^frule_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderFraudRulesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/stores/{storeId}/fraud/backtest":{"post":{"operationId":"backtestFraudRules","summary":"Replay past checkouts or paid orders through a rule set and compare with what happened (changes nothing)","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"default":null,"anyOf":[{"maxItems":100,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"enabled":{"default":true,"type":"boolean"},"mode":{"default":"live","type":"string","enum":["live","shadow"]},"stage":{"default":"checkout","type":"string","enum":["checkout","payment"]},"match":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]},"actions":{"minItems":1,"maxItems":6,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"allow"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"block"},"message":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"review"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_email_verification"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_3ds"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"limit_quantity"},"max":{"type":"integer","minimum":1,"maximum":10000}},"required":["type","max"]},{"type":"object","properties":{"type":{"type":"string","const":"flag"},"label":{"type":"string","minLength":1,"maxLength":40}},"required":["type","label"]},{"type":"object","properties":{"type":{"type":"string","const":"score"},"points":{"type":"integer","minimum":-100,"maximum":100}},"required":["type","points"]},{"type":"object","properties":{"type":{"type":"string","const":"restrict_methods"}},"required":["type"]}]}},"stop":{"default":false,"type":"boolean"},"id":{"type":"string","maxLength":40}},"required":["name","match","actions"]}},{"type":"null"}]},"days":{"default":30,"type":"integer","minimum":1,"maximum":180},"source":{"default":"checks","type":"string","enum":["checks","orders"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BacktestResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/simulate":{"post":{"operationId":"simulateFraud","summary":"Run a pretend checkout through every signal and rule, with the full explanation (not logged)","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","minLength":3,"maxLength":254},"ip":{"default":"","type":"string","maxLength":45},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"ipCountry":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"totalMinor":{"default":2000,"type":"integer","minimum":0,"maximum":100000000},"quantity":{"default":1,"type":"integer","minimum":1,"maximum":10000},"deviceId":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"stage":{"default":"checkout","type":"string","enum":["checkout","payment"]},"overrides":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"maxItems":50,"type":"array","items":{"type":"string"}},{"type":"null"}]}},"rules":{"default":null,"anyOf":[{"maxItems":100,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"enabled":{"default":true,"type":"boolean"},"mode":{"default":"live","type":"string","enum":["live","shadow"]},"stage":{"default":"checkout","type":"string","enum":["checkout","payment"]},"match":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]},"actions":{"minItems":1,"maxItems":6,"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"allow"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"block"},"message":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"review"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_email_verification"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"require_3ds"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"limit_quantity"},"max":{"type":"integer","minimum":1,"maximum":10000}},"required":["type","max"]},{"type":"object","properties":{"type":{"type":"string","const":"flag"},"label":{"type":"string","minLength":1,"maxLength":40}},"required":["type","label"]},{"type":"object","properties":{"type":{"type":"string","const":"score"},"points":{"type":"integer","minimum":-100,"maximum":100}},"required":["type","points"]},{"type":"object","properties":{"type":{"type":"string","const":"restrict_methods"}},"required":["type"]}]}},"stop":{"default":false,"type":"boolean"},"id":{"type":"string","maxLength":40}},"required":["name","match","actions"]}},{"type":"null"}]}},"required":["email","country"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudSimulationResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/checks":{"get":{"operationId":"listFraudChecks","summary":"Every checkout Fraud Shield looked at, newest first","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["allow","review","block"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"tests","in":"query","required":false,"schema":{"default":"include","type":"string","enum":["include","exclude","only"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["when","buyer","score","result"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFraudChecksResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/checks/{checkId}":{"get":{"operationId":"getFraudCheck","summary":"One check with every signal, every rule it went through and why it ended where it did","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"checkId","in":"path","required":true,"schema":{"type":"string","pattern":"^frd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudCheckDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/lists":{"get":{"operationId":"listFraudLists","summary":"Allowlist and blocklist entries with how often each matched","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"list","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["block","allow"]},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["email","email_domain","ip","ip_range","country","asn","device","discord_id","card_fingerprint"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"expired","in":"query","required":false,"schema":{"default":"include","type":"string","enum":["include","exclude","only"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"added","type":"string","enum":["added","value","list","matches","expires"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFraudListsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"},"post":{"operationId":"addFraudListEntries","summary":"Add entries to the allowlist or the blocklist (normalized; duplicates skipped)","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"list":{"type":"string","enum":["block","allow"]},"kind":{"type":"string","enum":["email","email_domain","ip","ip_range","country","asn","device","discord_id","card_fingerprint"]},"values":{"minItems":1,"maxItems":5000,"type":"array","items":{"type":"string","minLength":1,"maxLength":254}},"reason":{"default":"","type":"string","maxLength":200},"expiresAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["list","kind","values"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudListAddResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/stores/{storeId}/fraud/lists/{entryId}":{"patch":{"operationId":"updateFraudListEntry","summary":"Change an entry's reason or expiry, or move it to the other list","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"entryId","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:blk|alw|pbl)_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","maxLength":200},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"list":{"type":"string","enum":["block","allow"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudListEntry"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"},"delete":{"operationId":"removeFraudListEntry","summary":"Remove an allowlist or blocklist entry","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"entryId","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:blk|alw|pbl)_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/stores/{storeId}/fraud/lists/import":{"post":{"operationId":"importFraudList","summary":"Import list entries from CSV (list,kind,value,reason,expires_at); dry run first to see what would change","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"type":"string","minLength":1,"maxLength":1000000},"defaultList":{"default":"block","type":"string","enum":["block","allow"]},"dryRun":{"default":false,"type":"boolean"}},"required":["csv"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudListImportResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/stores/{storeId}/fraud/lists/export":{"get":{"operationId":"exportFraudList","summary":"The allowlist and blocklist as CSV","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"list","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["block","allow"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportFraudListResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/platform-list":{"get":{"operationId":"getPlatformListInfo","summary":"The ShopFast shared blocklist: whether this store uses it, its size and its matches here","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformListInfo"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/reviews":{"get":{"operationId":"listFraudReviews","summary":"Orders and checkouts held for a person to approve, cancel or refund","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":"open","anyOf":[{"type":"string","enum":["open","approved","cancelled","refunded"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["score","order","where","state","updated"]},{"type":"null"}]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFraudReviewsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/reviews/{reviewId}":{"get":{"operationId":"getFraudReview","summary":"A held order with its checks, signals, the buyer's history and the notes","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^frev_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudReviewDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/reviews/{reviewId}/decision":{"post":{"operationId":"decideFraudReview","summary":"Approve (deliver), cancel (an unpaid checkout) or refund a held order","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^frev_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","cancel","refund"]},"note":{"default":"","type":"string","maxLength":1000},"blockBuyer":{"default":false,"type":"boolean"},"trustBuyer":{"default":false,"type":"boolean"}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudReviewDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/stores/{storeId}/fraud/reviews/{reviewId}/notes":{"post":{"operationId":"addFraudReviewNote","summary":"Add a note to a review","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^frev_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudReviewNote"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/admin/fraud/blocklist":{"get":{"operationId":"adminListPlatformBlocklist","summary":"The shared blocklist stores can opt into","tags":["admin fraud"],"security":[{"adminSession":[]}],"parameters":[{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["email","email_domain","ip","ip_range","country","asn","device","discord_id","card_fingerprint"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"severity","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["high","medium"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"added","type":"string","enum":["value","sev","stores","expires","added"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListPlatformBlocklistResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"adminAddPlatformBlocklist","summary":"Add entries to the shared blocklist","tags":["admin fraud"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["email","email_domain","ip","ip_range","country","asn","device","discord_id","card_fingerprint"]},"values":{"minItems":1,"maxItems":5000,"type":"array","items":{"type":"string","minLength":1,"maxLength":254}},"reason":{"type":"string","minLength":3,"maxLength":200},"severity":{"default":"high","type":"string","enum":["high","medium"]},"expiresAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["kind","values","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAddPlatformBlocklistResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/fraud/blocklist/{entryId}":{"delete":{"operationId":"adminRemovePlatformBlocklist","summary":"Remove a shared blocklist entry","tags":["admin fraud"],"security":[{"adminSession":[]}],"parameters":[{"name":"entryId","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:blk|alw|pbl)_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/team/access":{"get":{"operationId":"getTeamAccess","summary":"Access policies, member attributes and the team's two-factor and invite settings","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamAccessOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:read","x-api-key-scope":"team:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/team/access.","x-store-explicit-path":"/v1/stores/{storeId}/team/access"}},"/v1/stores/{storeId}/team/access":{"get":{"operationId":"getTeamAccessWithStoreId","summary":"Access policies, member attributes and the team's two-factor and invite settings","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamAccessOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:read","x-api-key-scope":"team:read","description":"The explicit form of GET /v1/store/team/access, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/access"}},"/v1/store/team/policies":{"post":{"operationId":"createAccessPolicy","summary":"Add an access policy (allow policies are owner-only)","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"effect":{"type":"string","enum":["allow","deny"]},"enabled":{"default":true,"type":"boolean"},"subjects":{"type":"object","properties":{"everyone":{"default":false,"type":"boolean"},"roles":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["admin","staff","support","finance","custom"]}},"customRoleIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}},"userIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},"departments":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"tags":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}}},"permissions":{"minItems":1,"maxItems":40,"type":"array","items":{"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"string","pattern":"^(catalog|orders|customers|disputes|reviews|marketing|analytics|storefront|payments|finance|team|settings|discord|fraud|developers|audit|support|ai):\\*$"},{"type":"string","const":"*"}]}},"conditions":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]}},"required":["name","effect","subjects","permissions","conditions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/policies.","x-store-explicit-path":"/v1/stores/{storeId}/team/policies"}},"/v1/stores/{storeId}/team/policies":{"post":{"operationId":"createAccessPolicyWithStoreId","summary":"Add an access policy (allow policies are owner-only)","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"effect":{"type":"string","enum":["allow","deny"]},"enabled":{"default":true,"type":"boolean"},"subjects":{"type":"object","properties":{"everyone":{"default":false,"type":"boolean"},"roles":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["admin","staff","support","finance","custom"]}},"customRoleIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}},"userIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},"departments":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"tags":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}}},"permissions":{"minItems":1,"maxItems":40,"type":"array","items":{"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"string","pattern":"^(catalog|orders|customers|disputes|reviews|marketing|analytics|storefront|payments|finance|team|settings|discord|fraud|developers|audit|support|ai):\\*$"},{"type":"string","const":"*"}]}},"conditions":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]}},"required":["name","effect","subjects","permissions","conditions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/policies, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/policies"}},"/v1/store/team/policies/{policyId}":{"put":{"operationId":"updateAccessPolicy","summary":"Change an access policy","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"policyId","in":"path","required":true,"schema":{"type":"string","pattern":"^pol_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"effect":{"type":"string","enum":["allow","deny"]},"enabled":{"default":true,"type":"boolean"},"subjects":{"type":"object","properties":{"everyone":{"default":false,"type":"boolean"},"roles":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["admin","staff","support","finance","custom"]}},"customRoleIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}},"userIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},"departments":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"tags":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}}},"permissions":{"minItems":1,"maxItems":40,"type":"array","items":{"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"string","pattern":"^(catalog|orders|customers|disputes|reviews|marketing|analytics|storefront|payments|finance|team|settings|discord|fraud|developers|audit|support|ai):\\*$"},{"type":"string","const":"*"}]}},"conditions":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]}},"required":["name","effect","subjects","permissions","conditions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/team/policies/{policyId}.","x-store-explicit-path":"/v1/stores/{storeId}/team/policies/{policyId}"},"delete":{"operationId":"deleteAccessPolicy","summary":"Delete an access policy","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"policyId","in":"path","required":true,"schema":{"type":"string","pattern":"^pol_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/team/policies/{policyId}.","x-store-explicit-path":"/v1/stores/{storeId}/team/policies/{policyId}"}},"/v1/stores/{storeId}/team/policies/{policyId}":{"put":{"operationId":"updateAccessPolicyWithStoreId","summary":"Change an access policy","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","pattern":"^pol_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"effect":{"type":"string","enum":["allow","deny"]},"enabled":{"default":true,"type":"boolean"},"subjects":{"type":"object","properties":{"everyone":{"default":false,"type":"boolean"},"roles":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["admin","staff","support","finance","custom"]}},"customRoleIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}},"userIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},"departments":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"tags":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}}},"permissions":{"minItems":1,"maxItems":40,"type":"array","items":{"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"string","pattern":"^(catalog|orders|customers|disputes|reviews|marketing|analytics|storefront|payments|finance|team|settings|discord|fraud|developers|audit|support|ai):\\*$"},{"type":"string","const":"*"}]}},"conditions":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]}},"required":["name","effect","subjects","permissions","conditions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of PUT /v1/store/team/policies/{policyId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/policies/{policyId}"},"delete":{"operationId":"deleteAccessPolicyWithStoreId","summary":"Delete an access policy","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","pattern":"^pol_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of DELETE /v1/store/team/policies/{policyId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/policies/{policyId}"}},"/v1/store/team/simulate":{"post":{"operationId":"simulateAccess","summary":"What a member (or a role) could do, here and now or in a given context, with every policy explained","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"default":null,"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"assignment":{"default":null,"anyOf":[{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]},{"type":"null"}]},"department":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"default":null,"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string","maxLength":40}},{"type":"null"}]},"twoFactor":{"default":null,"type":["boolean","null"]},"viaApiKey":{"default":false,"type":"boolean"},"permission":{"default":null,"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"null"}]},"endpoint":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"resource":{"default":null,"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["product","order","customer"]},"id":{"type":"string","maxLength":40}},"required":["type","id"]},{"type":"null"}]},"attributes":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"maxItems":200,"type":"array","items":{"type":"string"}},{"type":"null"}]}},"context":{"default":{"hour":null,"weekday":null,"ip":null,"country":null},"type":"object","properties":{"hour":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"weekday":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":6},{"type":"null"}]},"ip":{"default":null,"anyOf":[{"type":"string","maxLength":45},{"type":"null"}]},"country":{"default":null,"anyOf":[{"type":"string","maxLength":2},{"type":"null"}]}}},"policies":{"default":null,"anyOf":[{"maxItems":100,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"effect":{"type":"string","enum":["allow","deny"]},"enabled":{"default":true,"type":"boolean"},"subjects":{"type":"object","properties":{"everyone":{"default":false,"type":"boolean"},"roles":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["admin","staff","support","finance","custom"]}},"customRoleIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}},"userIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},"departments":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"tags":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}}},"permissions":{"minItems":1,"maxItems":40,"type":"array","items":{"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"string","pattern":"^(catalog|orders|customers|disputes|reviews|marketing|analytics|storefront|payments|finance|team|settings|discord|fraud|developers|audit|support|ai):\\*$"},{"type":"string","const":"*"}]}},"conditions":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]},"id":{"type":"string","maxLength":40}},"required":["name","effect","subjects","permissions","conditions"]}},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessSimulationResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:read","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/simulate.","x-store-explicit-path":"/v1/stores/{storeId}/team/simulate"}},"/v1/stores/{storeId}/team/simulate":{"post":{"operationId":"simulateAccessWithStoreId","summary":"What a member (or a role) could do, here and now or in a given context, with every policy explained","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"default":null,"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"assignment":{"default":null,"anyOf":[{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]},{"type":"null"}]},"department":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"default":null,"anyOf":[{"maxItems":20,"type":"array","items":{"type":"string","maxLength":40}},{"type":"null"}]},"twoFactor":{"default":null,"type":["boolean","null"]},"viaApiKey":{"default":false,"type":"boolean"},"permission":{"default":null,"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"null"}]},"endpoint":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"resource":{"default":null,"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["product","order","customer"]},"id":{"type":"string","maxLength":40}},"required":["type","id"]},{"type":"null"}]},"attributes":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"maxItems":200,"type":"array","items":{"type":"string"}},{"type":"null"}]}},"context":{"default":{"hour":null,"weekday":null,"ip":null,"country":null},"type":"object","properties":{"hour":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"weekday":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":6},{"type":"null"}]},"ip":{"default":null,"anyOf":[{"type":"string","maxLength":45},{"type":"null"}]},"country":{"default":null,"anyOf":[{"type":"string","maxLength":2},{"type":"null"}]}}},"policies":{"default":null,"anyOf":[{"maxItems":100,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"effect":{"type":"string","enum":["allow","deny"]},"enabled":{"default":true,"type":"boolean"},"subjects":{"type":"object","properties":{"everyone":{"default":false,"type":"boolean"},"roles":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["admin","staff","support","finance","custom"]}},"customRoleIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}},"userIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},"departments":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"tags":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}}},"permissions":{"minItems":1,"maxItems":40,"type":"array","items":{"anyOf":[{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},{"type":"string","pattern":"^(catalog|orders|customers|disputes|reviews|marketing|analytics|storefront|payments|finance|team|settings|discord|fraud|developers|audit|support|ai):\\*$"},{"type":"string","const":"*"}]}},"conditions":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"attribute":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"op":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"value":{"default":null,"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op"]}}},"required":["op","conditions"]}}},"required":["op","conditions"]},"id":{"type":"string","maxLength":40}},"required":["name","effect","subjects","permissions","conditions"]}},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessSimulationResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:read","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/simulate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/simulate"}},"/v1/store/team/access-settings":{"put":{"operationId":"updateTeamAccessSettings","summary":"Which roles need two-factor sign-in, and how long invite links work","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"require2faRoles":{"maxItems":60,"type":"array","items":{"anyOf":[{"type":"string","enum":["admin","staff","support","finance"]},{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}]}},"inviteExpiryHours":{"type":"integer","minimum":1,"maximum":720}},"required":["require2faRoles","inviteExpiryHours"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamAccessSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/team/access-settings.","x-store-explicit-path":"/v1/stores/{storeId}/team/access-settings"}},"/v1/stores/{storeId}/team/access-settings":{"put":{"operationId":"updateTeamAccessSettingsWithStoreId","summary":"Which roles need two-factor sign-in, and how long invite links work","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"require2faRoles":{"maxItems":60,"type":"array","items":{"anyOf":[{"type":"string","enum":["admin","staff","support","finance"]},{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"}]}},"inviteExpiryHours":{"type":"integer","minimum":1,"maximum":720}},"required":["require2faRoles","inviteExpiryHours"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamAccessSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of PUT /v1/store/team/access-settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/access-settings"}},"/v1/store/team/members/{userId}/attributes":{"put":{"operationId":"updateMemberAttributes","summary":"Set a teammate's department and tags (used by access policies)","tags":["team"],"security":[{"apiKey":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"department":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}},"required":["department","tags"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberAttributes"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/team/members/{userId}/attributes.","x-store-explicit-path":"/v1/stores/{storeId}/team/members/{userId}/attributes"}},"/v1/stores/{storeId}/team/members/{userId}/attributes":{"put":{"operationId":"updateMemberAttributesWithStoreId","summary":"Set a teammate's department and tags (used by access policies)","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"department":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}},"required":["department","tags"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberAttributes"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of PUT /v1/store/team/members/{userId}/attributes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/members/{userId}/attributes"}},"/v1/store/team/invites/bulk":{"post":{"operationId":"bulkInviteMembers","summary":"Invite up to 200 people at once, each with a role and the same attributes","tags":["team"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"department":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"expiresInHours":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":720},{"type":"null"}]},"entries":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"assignment":{"default":null,"anyOf":[{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]},{"type":"null"}]}},"required":["email"]}},"assignment":{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]}},"required":["entries","assignment"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkInviteResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/team/invites/bulk.","x-store-explicit-path":"/v1/stores/{storeId}/team/invites/bulk"}},"/v1/stores/{storeId}/team/invites/bulk":{"post":{"operationId":"bulkInviteMembersWithStoreId","summary":"Invite up to 200 people at once, each with a role and the same attributes","tags":["team"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"department":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"expiresInHours":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":720},{"type":"null"}]},"entries":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"assignment":{"default":null,"anyOf":[{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]},{"type":"null"}]}},"required":["email"]}},"assignment":{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]}},"required":["entries","assignment"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkInviteResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"team:write","x-api-key-scope":"team:write","description":"The explicit form of POST /v1/store/team/invites/bulk, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/team/invites/bulk"}},"/v1/store/audit-log/timeline":{"get":{"operationId":"getAuditTimeline","summary":"Every change to one product, order, role, member or setting, oldest first, with field-level differences","tags":["audit-log"],"security":[{"apiKey":[]}],"parameters":[{"name":"targetType","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}},{"name":"targetId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":120}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditTimeline"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/audit-log/timeline.","x-store-explicit-path":"/v1/stores/{storeId}/audit-log/timeline"}},"/v1/stores/{storeId}/audit-log/timeline":{"get":{"operationId":"getAuditTimelineWithStoreId","summary":"Every change to one product, order, role, member or setting, oldest first, with field-level differences","tags":["audit-log"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"targetType","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}},{"name":"targetId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":120}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditTimeline"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The explicit form of GET /v1/store/audit-log/timeline, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/audit-log/timeline"}},"/v1/store/audit-log/settings":{"get":{"operationId":"getAuditSettings","summary":"How long the audit log keeps entries and which sensitive changes raise alerts","tags":["audit-log"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/audit-log/settings.","x-store-explicit-path":"/v1/stores/{storeId}/audit-log/settings"},"put":{"operationId":"updateAuditSettings","summary":"Change the audit log retention and alerts (owner only)","tags":["audit-log"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"retentionDays":{"type":"integer","minimum":30,"maximum":2555},"alerts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["payout_destination","api_key_created","role_change","member_removed","ownership_transfer","access_policy","fraud_rules","webhook_endpoint","audit_settings"]},"enabled":{"type":"boolean"}},"required":["kind","enabled"]}}},"required":["retentionDays","alerts"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:write","x-api-key-scope":"audit:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/audit-log/settings.","x-store-explicit-path":"/v1/stores/{storeId}/audit-log/settings"}},"/v1/stores/{storeId}/audit-log/settings":{"get":{"operationId":"getAuditSettingsWithStoreId","summary":"How long the audit log keeps entries and which sensitive changes raise alerts","tags":["audit-log"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The explicit form of GET /v1/store/audit-log/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/audit-log/settings"},"put":{"operationId":"updateAuditSettingsWithStoreId","summary":"Change the audit log retention and alerts (owner only)","tags":["audit-log"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"retentionDays":{"type":"integer","minimum":30,"maximum":2555},"alerts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["payout_destination","api_key_created","role_change","member_removed","ownership_transfer","access_policy","fraud_rules","webhook_endpoint","audit_settings"]},"enabled":{"type":"boolean"}},"required":["kind","enabled"]}}},"required":["retentionDays","alerts"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:write","x-api-key-scope":"audit:write","description":"The explicit form of PUT /v1/store/audit-log/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/audit-log/settings"}},"/v1/store/audit-log/export.json":{"get":{"operationId":"exportStoreAuditJson","summary":"The filtered store audit log as JSON lines with snapshots (up to 10,000 rows)","tags":["audit-log"],"security":[{"apiKey":[]}],"parameters":[{"name":"actor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}]},{"type":"null"}]}},{"name":"area","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"targetType","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"targetId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sensitive","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"actorKind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["user","api_key"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStoreAuditJsonResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/audit-log/export.json.","x-store-explicit-path":"/v1/stores/{storeId}/audit-log/export.json"}},"/v1/stores/{storeId}/audit-log/export.json":{"get":{"operationId":"exportStoreAuditJsonWithStoreId","summary":"The filtered store audit log as JSON lines with snapshots (up to 10,000 rows)","tags":["audit-log"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"actor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"}]},{"type":"null"}]}},{"name":"area","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"action","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"targetType","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"targetId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sensitive","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]},{"type":"null"}]}},{"name":"actorKind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["user","api_key"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStoreAuditJsonResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"audit:read","x-api-key-scope":"audit:read","description":"The explicit form of GET /v1/store/audit-log/export.json, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/audit-log/export.json"}},"/v1/store/payments/overview":{"get":{"operationId":"getPaymentsOverview","summary":"Every way the store can get paid: ShopFast Pay status, gateways, manual methods, plugins, health, order and rules","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaidOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/payments/overview.","x-store-explicit-path":"/v1/stores/{storeId}/payments/overview"}},"/v1/stores/{storeId}/payments/overview":{"get":{"operationId":"getPaymentsOverviewWithStoreId","summary":"Every way the store can get paid: ShopFast Pay status, gateways, manual methods, plugins, health, order and rules","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaidOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The explicit form of GET /v1/store/payments/overview, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/overview"}},"/v1/store/payments/shopfast-pay":{"get":{"operationId":"getShopFastPayStatus","summary":"ShopFast Pay for this store: the platform mode, the application, limits, reserve and payout hold","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerPayStatus"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/payments/shopfast-pay.","x-store-explicit-path":"/v1/stores/{storeId}/payments/shopfast-pay"}},"/v1/stores/{storeId}/payments/shopfast-pay":{"get":{"operationId":"getShopFastPayStatusWithStoreId","summary":"ShopFast Pay for this store: the platform mode, the application, limits, reserve and payout hold","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerPayStatus"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The explicit form of GET /v1/store/payments/shopfast-pay, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/shopfast-pay"}},"/v1/store/payments/rules":{"put":{"operationId":"savePaymentRules","summary":"The order buyers see ways to pay in, and per-method country and order total rules","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"order":{"maxItems":7,"type":"array","items":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}},"rules":{"type":"object","propertyNames":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},"additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean"},"countries":{"type":"object","properties":{"mode":{"type":"string","enum":["all","only","except"]},"list":{"maxItems":250,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["mode","list"]},"minMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"maxMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]}},"required":["enabled","countries","minMinor","maxMinor"]}}},"required":["order","rules"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodRules"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/payments/rules.","x-store-explicit-path":"/v1/stores/{storeId}/payments/rules"}},"/v1/stores/{storeId}/payments/rules":{"put":{"operationId":"savePaymentRulesWithStoreId","summary":"The order buyers see ways to pay in, and per-method country and order total rules","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"order":{"maxItems":7,"type":"array","items":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}},"rules":{"type":"object","propertyNames":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},"additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean"},"countries":{"type":"object","properties":{"mode":{"type":"string","enum":["all","only","except"]},"list":{"maxItems":250,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["mode","list"]},"minMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"maxMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]}},"required":["enabled","countries","minMinor","maxMinor"]}}},"required":["order","rules"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodRules"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of PUT /v1/store/payments/rules, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/rules"}},"/v1/store/payments/test-mode":{"put":{"operationId":"setPaymentsTestMode","summary":"Turn store-wide test mode on for a few hours (checkouts run on simulated payments and are marked test) or off","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"on":{"type":"boolean"},"hours":{"default":24,"anyOf":[{"type":"number","const":1},{"type":"number","const":24},{"type":"number","const":72}]}},"required":["on"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsTestMode"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/payments/test-mode.","x-store-explicit-path":"/v1/stores/{storeId}/payments/test-mode"}},"/v1/stores/{storeId}/payments/test-mode":{"put":{"operationId":"setPaymentsTestModeWithStoreId","summary":"Turn store-wide test mode on for a few hours (checkouts run on simulated payments and are marked test) or off","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"on":{"type":"boolean"},"hours":{"default":24,"anyOf":[{"type":"number","const":1},{"type":"number","const":24},{"type":"number","const":72}]}},"required":["on"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsTestMode"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of PUT /v1/store/payments/test-mode, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/test-mode"}},"/v1/store/payments/shopfast-pay/application":{"put":{"operationId":"savePayApplication","summary":"Save the ShopFast Pay application as a draft (starts one when there is none)","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"object","properties":{"categories":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]}},"productExamples":{"default":"","type":"string","maxLength":1000},"links":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":300}},"monthlyVolumeMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":100000000000},{"type":"null"}]},"averageOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":10000000000},{"type":"null"}]},"buyerCountries":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}},"refundPolicy":{"default":"","type":"string","maxLength":2000},"yearsSelling":{"default":null,"anyOf":[{"type":"string","enum":["new","under_1","1_3","3_plus"]},{"type":"null"}]},"discord":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"telegram":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"website":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"entityType":{"default":null,"anyOf":[{"type":"string","enum":["individual","business"]},{"type":"null"}]},"businessName":{"default":null,"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]}}},"kyc":{"type":"object","properties":{"legalName":{"default":"","type":"string","maxLength":120},"country":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"dateOfBirth":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}}}},"required":["answers","kyc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/payments/shopfast-pay/application.","x-store-explicit-path":"/v1/stores/{storeId}/payments/shopfast-pay/application"}},"/v1/stores/{storeId}/payments/shopfast-pay/application":{"put":{"operationId":"savePayApplicationWithStoreId","summary":"Save the ShopFast Pay application as a draft (starts one when there is none)","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"object","properties":{"categories":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]}},"productExamples":{"default":"","type":"string","maxLength":1000},"links":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":300}},"monthlyVolumeMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":100000000000},{"type":"null"}]},"averageOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":10000000000},{"type":"null"}]},"buyerCountries":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}},"refundPolicy":{"default":"","type":"string","maxLength":2000},"yearsSelling":{"default":null,"anyOf":[{"type":"string","enum":["new","under_1","1_3","3_plus"]},{"type":"null"}]},"discord":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"telegram":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"website":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"entityType":{"default":null,"anyOf":[{"type":"string","enum":["individual","business"]},{"type":"null"}]},"businessName":{"default":null,"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]}}},"kyc":{"type":"object","properties":{"legalName":{"default":"","type":"string","maxLength":120},"country":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"dateOfBirth":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}}}},"required":["answers","kyc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of PUT /v1/store/payments/shopfast-pay/application, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/shopfast-pay/application"}},"/v1/store/payments/shopfast-pay/application/documents":{"post":{"operationId":"addPayDocument","summary":"Attach a finished upload (purpose file: PDF, PNG, JPEG or WebP up to 15 MB) to the application","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"kind":{"type":"string","enum":["identity","proof_of_address","business_registration","other"]}},"required":["uploadId","kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/payments/shopfast-pay/application/documents.","x-store-explicit-path":"/v1/stores/{storeId}/payments/shopfast-pay/application/documents"}},"/v1/stores/{storeId}/payments/shopfast-pay/application/documents":{"post":{"operationId":"addPayDocumentWithStoreId","summary":"Attach a finished upload (purpose file: PDF, PNG, JPEG or WebP up to 15 MB) to the application","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"kind":{"type":"string","enum":["identity","proof_of_address","business_registration","other"]}},"required":["uploadId","kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/payments/shopfast-pay/application/documents, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/shopfast-pay/application/documents"}},"/v1/store/payments/shopfast-pay/application/documents/{documentId}":{"delete":{"operationId":"removePayDocument","summary":"Remove a document from an application that is still open","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"string","pattern":"^pdoc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/payments/shopfast-pay/application/documents/{documentId}.","x-store-explicit-path":"/v1/stores/{storeId}/payments/shopfast-pay/application/documents/{documentId}"}},"/v1/stores/{storeId}/payments/shopfast-pay/application/documents/{documentId}":{"delete":{"operationId":"removePayDocumentWithStoreId","summary":"Remove a document from an application that is still open","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"string","pattern":"^pdoc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of DELETE /v1/store/payments/shopfast-pay/application/documents/{documentId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/shopfast-pay/application/documents/{documentId}"}},"/v1/store/payments/shopfast-pay/application/submit":{"post":{"operationId":"submitPayApplication","summary":"Owner only: send the application to ShopFast for review (or turn ShopFast Pay on at once when it is open to all)","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"object","properties":{"categories":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]}},"productExamples":{"default":"","type":"string","maxLength":1000},"links":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":300}},"monthlyVolumeMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":100000000000},{"type":"null"}]},"averageOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":10000000000},{"type":"null"}]},"buyerCountries":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}},"refundPolicy":{"default":"","type":"string","maxLength":2000},"yearsSelling":{"default":null,"anyOf":[{"type":"string","enum":["new","under_1","1_3","3_plus"]},{"type":"null"}]},"discord":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"telegram":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"website":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"entityType":{"default":null,"anyOf":[{"type":"string","enum":["individual","business"]},{"type":"null"}]},"businessName":{"default":null,"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]}}},"kyc":{"type":"object","properties":{"legalName":{"default":"","type":"string","maxLength":120},"country":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"dateOfBirth":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}}}},"required":["answers","kyc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerPayStatus"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/payments/shopfast-pay/application/submit.","x-store-explicit-path":"/v1/stores/{storeId}/payments/shopfast-pay/application/submit"}},"/v1/stores/{storeId}/payments/shopfast-pay/application/submit":{"post":{"operationId":"submitPayApplicationWithStoreId","summary":"Owner only: send the application to ShopFast for review (or turn ShopFast Pay on at once when it is open to all)","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"object","properties":{"categories":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]}},"productExamples":{"default":"","type":"string","maxLength":1000},"links":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":300}},"monthlyVolumeMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":100000000000},{"type":"null"}]},"averageOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":10000000000},{"type":"null"}]},"buyerCountries":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"}},"refundPolicy":{"default":"","type":"string","maxLength":2000},"yearsSelling":{"default":null,"anyOf":[{"type":"string","enum":["new","under_1","1_3","3_plus"]},{"type":"null"}]},"discord":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"telegram":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"website":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"entityType":{"default":null,"anyOf":[{"type":"string","enum":["individual","business"]},{"type":"null"}]},"businessName":{"default":null,"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]}}},"kyc":{"type":"object","properties":{"legalName":{"default":"","type":"string","maxLength":120},"country":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]},"dateOfBirth":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}}}},"required":["answers","kyc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerPayStatus"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/payments/shopfast-pay/application/submit, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/shopfast-pay/application/submit"}},"/v1/store/payments/shopfast-pay/application/reply":{"post":{"operationId":"replyPayApplication","summary":"Answer the reviewer's question; the application goes back into review","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","minLength":2,"maxLength":2000}},"required":["message"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/payments/shopfast-pay/application/reply.","x-store-explicit-path":"/v1/stores/{storeId}/payments/shopfast-pay/application/reply"}},"/v1/stores/{storeId}/payments/shopfast-pay/application/reply":{"post":{"operationId":"replyPayApplicationWithStoreId","summary":"Answer the reviewer's question; the application goes back into review","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","minLength":2,"maxLength":2000}},"required":["message"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayApplication"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/payments/shopfast-pay/application/reply, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/shopfast-pay/application/reply"}},"/v1/store/payments/shopfast-pay/application/withdraw":{"post":{"operationId":"withdrawPayApplication","summary":"Withdraw an open application","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerPayStatus"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/payments/shopfast-pay/application/withdraw.","x-store-explicit-path":"/v1/stores/{storeId}/payments/shopfast-pay/application/withdraw"}},"/v1/stores/{storeId}/payments/shopfast-pay/application/withdraw":{"post":{"operationId":"withdrawPayApplicationWithStoreId","summary":"Withdraw an open application","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerPayStatus"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of POST /v1/store/payments/shopfast-pay/application/withdraw, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/shopfast-pay/application/withdraw"}},"/v1/admin/shopfast-pay":{"get":{"operationId":"adminGetPay","summary":"ShopFast Pay access mode, approval defaults and application stats","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminGetPayResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/shopfast-pay/mode":{"put":{"operationId":"adminSetPayMode","summary":"Owner or finance: open to all, application required, or disabled (disabling moves every store off ShopFast Pay and tells them)","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"type":"string","enum":["open","application","disabled"]},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["mode","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModeChangeResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/shopfast-pay/mode/preview":{"get":{"operationId":"adminPreviewPayMode","summary":"How many stores a mode change would move, before you make it","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[{"name":"mode","in":"query","required":true,"schema":{"type":"string","enum":["open","application","disabled"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPreviewPayModeResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/shopfast-pay/defaults":{"put":{"operationId":"adminSetPayDefaults","summary":"Owner or finance: the limits new approvals start from","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rollingCapMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"windowDays":{"type":"integer","minimum":1,"maximum":90},"maxOrderMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"reserveBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]}},"required":["rollingCapMinor","windowDays","maxOrderMinor","reserveBps"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaySettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/shopfast-pay/applications":{"get":{"operationId":"adminListPayApplications","summary":"The review queue, oldest submitted first","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["draft","submitted","info_requested","approved","rejected","withdrawn"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sells","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["store","sells","volume","risk","status","when"]},{"type":"null"}]}},{"name":"dir","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["asc","desc"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListPayApplicationsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/shopfast-pay/applications/{applicationId}":{"get":{"operationId":"adminGetPayApplication","summary":"One application with its answers, KYC, documents, timeline and the store's risk signals","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[{"name":"applicationId","in":"path","required":true,"schema":{"type":"string","pattern":"^papp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPayApplicationDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/shopfast-pay/applications/{applicationId}/decision":{"post":{"operationId":"adminDecidePayApplication","summary":"Owner or finance: approve (with limits), reject with a reason, or ask the seller for more information","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[{"name":"applicationId","in":"path","required":true,"schema":{"type":"string","pattern":"^papp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["approve","reject","request_info"]},"message":{"type":"string","maxLength":2000},"limits":{"anyOf":[{"type":"object","properties":{"rollingCapMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"windowDays":{"type":"integer","minimum":1,"maximum":90},"maxOrderMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"reserveBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]}},"required":["rollingCapMinor","windowDays","maxOrderMinor","reserveBps"]},{"type":"null"}]}},"required":["action","message","limits"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPayApplicationDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/shopfast-pay/applications/{applicationId}/documents/{documentId}/link":{"post":{"operationId":"adminPayDocumentLink","summary":"A 5-minute download link for one application document (recorded in the audit log)","tags":["admin shopfast-pay"],"security":[{"adminSession":[]}],"parameters":[{"name":"applicationId","in":"path","required":true,"schema":{"type":"string","pattern":"^papp_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"string","pattern":"^pdoc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPayDocumentLinkResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/shopfast-pay":{"get":{"operationId":"adminGetStorePay","summary":"A store's ShopFast Pay access, limits, reserve, payout hold, balances and risk","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePay"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/shopfast-pay/limits":{"put":{"operationId":"adminSetStorePayLimits","summary":"Owner or finance: the store's rolling volume cap, order limit and reserve","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limits":{"type":"object","properties":{"rollingCapMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"windowDays":{"type":"integer","minimum":1,"maximum":90},"maxOrderMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"reserveBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]}},"required":["rollingCapMinor","windowDays","maxOrderMinor","reserveBps"]},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["limits","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePay"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/shopfast-pay/access":{"put":{"operationId":"adminSetStorePayAccess","summary":"Owner or finance: approve without an application, suspend (falls back to the store's own gateways) or reinstate","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["approve","suspend","reinstate"]},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["action","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePay"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/shopfast-pay/payout-hold":{"put":{"operationId":"adminSetPayoutHold","summary":"Owner or finance: hold the store's payouts (sales keep settling) or release them","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"held":{"type":"boolean"},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["held","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePay"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/shopfast-pay/manual-payout":{"post":{"operationId":"adminManualPayout","summary":"Owner or finance: pay the store now, outside the schedule and minimum (not while its payouts are held)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"waiveFee":{"type":"boolean"},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["amountMinor","waiveFee","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminManualPayoutResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/shopfast-pay/flags":{"put":{"operationId":"adminSetStorePayFlags","summary":"Owner, finance or support: manual risk flags and a reviewer note","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"flags":{"maxItems":5,"type":"array","items":{"type":"string","enum":["watchlist","high_risk_category","chargeback_history","identity_mismatch","manual_review"]}},"note":{"type":"string","maxLength":1000}},"required":["flags","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePay"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/gateway-health":{"get":{"operationId":"adminGatewayHealth","summary":"Each gateway: readiness, connected stores, checkouts, payments and provider messages","tags":["admin gateway-health"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminGatewayHealthResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/support/tickets":{"get":{"operationId":"listTickets","summary":"Tickets in a view (open, mine, unassigned, waiting, breached, solved, all) with search and filters","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"view","in":"query","required":false,"schema":{"default":"open","type":"string","enum":["open","mine","unassigned","pending","breached","solved","all"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"priority","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["low","normal","high","urgent"]},{"type":"null"}]}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["open","pending","on_hold","solved","closed"]},{"type":"null"}]}},{"name":"assigneeId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"tag","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},{"name":"category","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTicketsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/support/tickets.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets"},"post":{"operationId":"createTicket","summary":"Open a ticket on behalf of a buyer (emails them unless notify is off)","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requesterEmail":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"requesterName":{"type":"string","maxLength":120},"subject":{"type":"string","minLength":1,"maxLength":200},"body":{"type":"string","minLength":1,"maxLength":10000},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"orderId":{"anyOf":[{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"notify":{"type":"boolean"}},"required":["requesterEmail","requesterName","subject","body","priority","category","orderId","notify"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/tickets.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets"}},"/v1/stores/{storeId}/support/tickets":{"get":{"operationId":"listTicketsWithStoreId","summary":"Tickets in a view (open, mine, unassigned, waiting, breached, solved, all) with search and filters","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"view","in":"query","required":false,"schema":{"default":"open","type":"string","enum":["open","mine","unassigned","pending","breached","solved","all"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"priority","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["low","normal","high","urgent"]},{"type":"null"}]}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["open","pending","on_hold","solved","closed"]},{"type":"null"}]}},{"name":"assigneeId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"tag","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},{"name":"category","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTicketsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The explicit form of GET /v1/store/support/tickets, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets"},"post":{"operationId":"createTicketWithStoreId","summary":"Open a ticket on behalf of a buyer (emails them unless notify is off)","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requesterEmail":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"requesterName":{"type":"string","maxLength":120},"subject":{"type":"string","minLength":1,"maxLength":200},"body":{"type":"string","minLength":1,"maxLength":10000},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"orderId":{"anyOf":[{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"notify":{"type":"boolean"}},"required":["requesterEmail","requesterName","subject","body","priority","category","orderId","notify"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/tickets, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets"}},"/v1/store/support/unread":{"get":{"operationId":"supportUnread","summary":"Open tickets with a buyer message you have not opened or answered yet (the Support badge)","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportUnreadResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/support/unread.","x-store-explicit-path":"/v1/stores/{storeId}/support/unread"}},"/v1/stores/{storeId}/support/unread":{"get":{"operationId":"supportUnreadWithStoreId","summary":"Open tickets with a buyer message you have not opened or answered yet (the Support badge)","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportUnreadResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The explicit form of GET /v1/store/support/unread, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/unread"}},"/v1/store/support/tickets/{ticketId}":{"get":{"operationId":"getTicket","summary":"One ticket: messages, notes, timeline, attachments (signed links) and the customer context","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/support/tickets/{ticketId}.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets/{ticketId}"},"patch":{"operationId":"updateTicket","summary":"Change status, priority, assignee, tags, category, subject or the linked order","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending","on_hold","solved","closed"]},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"assigneeId":{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\w -]+$"}},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"subject":{"type":"string","minLength":1,"maxLength":200},"orderId":{"anyOf":[{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/support/tickets/{ticketId}.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets/{ticketId}"}},"/v1/stores/{storeId}/support/tickets/{ticketId}":{"get":{"operationId":"getTicketWithStoreId","summary":"One ticket: messages, notes, timeline, attachments (signed links) and the customer context","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The explicit form of GET /v1/store/support/tickets/{ticketId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets/{ticketId}"},"patch":{"operationId":"updateTicketWithStoreId","summary":"Change status, priority, assignee, tags, category, subject or the linked order","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending","on_hold","solved","closed"]},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"assigneeId":{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\w -]+$"}},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"subject":{"type":"string","minLength":1,"maxLength":200},"orderId":{"anyOf":[{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of PATCH /v1/store/support/tickets/{ticketId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets/{ticketId}"}},"/v1/store/support/tickets/{ticketId}/messages":{"post":{"operationId":"replyTicket","summary":"Reply to the buyer (emailed, threaded) or add an internal note; optionally set the status in the same step","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000},"internal":{"type":"boolean"},"status":{"anyOf":[{"type":"string","enum":["open","pending","on_hold","solved","closed"]},{"type":"null"}]},"attachmentIds":{"maxItems":5,"type":"array","items":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["body","internal","status","attachmentIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/tickets/{ticketId}/messages.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets/{ticketId}/messages"}},"/v1/stores/{storeId}/support/tickets/{ticketId}/messages":{"post":{"operationId":"replyTicketWithStoreId","summary":"Reply to the buyer (emailed, threaded) or add an internal note; optionally set the status in the same step","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000},"internal":{"type":"boolean"},"status":{"anyOf":[{"type":"string","enum":["open","pending","on_hold","solved","closed"]},{"type":"null"}]},"attachmentIds":{"maxItems":5,"type":"array","items":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["body","internal","status","attachmentIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/tickets/{ticketId}/messages, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets/{ticketId}/messages"}},"/v1/store/support/tickets/bulk":{"post":{"operationId":"bulkUpdateTickets","summary":"Apply one change to many tickets (close, assign, tag, prioritize)","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}},"patch":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending","on_hold","solved","closed"]},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"assigneeId":{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\w -]+$"}},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"subject":{"type":"string","minLength":1,"maxLength":200}}}},"required":["ids","patch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateTicketsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/tickets/bulk.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets/bulk"}},"/v1/stores/{storeId}/support/tickets/bulk":{"post":{"operationId":"bulkUpdateTicketsWithStoreId","summary":"Apply one change to many tickets (close, assign, tag, prioritize)","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}},"patch":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending","on_hold","solved","closed"]},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"assigneeId":{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\w -]+$"}},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"subject":{"type":"string","minLength":1,"maxLength":200}}}},"required":["ids","patch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateTicketsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/tickets/bulk, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets/bulk"}},"/v1/store/support/tickets/{ticketId}/merge":{"post":{"operationId":"mergeTickets","summary":"Merge other tickets from the same buyer into this one (their messages move here; they close)","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceIds":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["sourceIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/tickets/{ticketId}/merge.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets/{ticketId}/merge"}},"/v1/stores/{storeId}/support/tickets/{ticketId}/merge":{"post":{"operationId":"mergeTicketsWithStoreId","summary":"Merge other tickets from the same buyer into this one (their messages move here; they close)","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceIds":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["sourceIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/tickets/{ticketId}/merge, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets/{ticketId}/merge"}},"/v1/store/support/tickets/{ticketId}/presence":{"post":{"operationId":"ticketPresence","summary":"I am viewing (or typing in) this ticket; answers who else is","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"typing":{"type":"boolean"}},"required":["typing"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketPresenceResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/tickets/{ticketId}/presence.","x-store-explicit-path":"/v1/stores/{storeId}/support/tickets/{ticketId}/presence"}},"/v1/stores/{storeId}/support/tickets/{ticketId}/presence":{"post":{"operationId":"ticketPresenceWithStoreId","summary":"I am viewing (or typing in) this ticket; answers who else is","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"typing":{"type":"boolean"}},"required":["typing"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketPresenceResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/tickets/{ticketId}/presence, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/tickets/{ticketId}/presence"}},"/v1/store/support/attachments":{"post":{"operationId":"startAgentAttachment","summary":"A signed upload link for a reply attachment (size and type limits apply)","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":160},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf","text/plain","application/zip"]},"bytes":{"type":"integer","minimum":1,"maximum":26214400}},"required":["filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartAgentAttachmentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/attachments.","x-store-explicit-path":"/v1/stores/{storeId}/support/attachments"}},"/v1/stores/{storeId}/support/attachments":{"post":{"operationId":"startAgentAttachmentWithStoreId","summary":"A signed upload link for a reply attachment (size and type limits apply)","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":160},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf","text/plain","application/zip"]},"bytes":{"type":"integer","minimum":1,"maximum":26214400}},"required":["filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartAgentAttachmentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/attachments, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/attachments"}},"/v1/store/support/attachments/{attachmentId}/complete":{"post":{"operationId":"completeAgentAttachment","summary":"Check the uploaded bytes (real type, size) and make the attachment usable","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketAttachment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/attachments/{attachmentId}/complete.","x-store-explicit-path":"/v1/stores/{storeId}/support/attachments/{attachmentId}/complete"}},"/v1/stores/{storeId}/support/attachments/{attachmentId}/complete":{"post":{"operationId":"completeAgentAttachmentWithStoreId","summary":"Check the uploaded bytes (real type, size) and make the attachment usable","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketAttachment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/attachments/{attachmentId}/complete, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/attachments/{attachmentId}/complete"}},"/v1/store/support/canned":{"get":{"operationId":"listCannedReplies","summary":"Saved replies with variables","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCannedRepliesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/support/canned.","x-store-explicit-path":"/v1/stores/{storeId}/support/canned"},"post":{"operationId":"createCannedReply","summary":"Save a reply","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"shortcut":{"type":"string","maxLength":32,"pattern":"^[a-z0-9_-]*$"},"body":{"type":"string","minLength":1,"maxLength":5000},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},"required":["name","shortcut","body","category"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CannedReply"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/canned.","x-store-explicit-path":"/v1/stores/{storeId}/support/canned"}},"/v1/stores/{storeId}/support/canned":{"get":{"operationId":"listCannedRepliesWithStoreId","summary":"Saved replies with variables","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCannedRepliesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The explicit form of GET /v1/store/support/canned, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/canned"},"post":{"operationId":"createCannedReplyWithStoreId","summary":"Save a reply","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"shortcut":{"type":"string","maxLength":32,"pattern":"^[a-z0-9_-]*$"},"body":{"type":"string","minLength":1,"maxLength":5000},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},"required":["name","shortcut","body","category"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CannedReply"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/canned, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/canned"}},"/v1/store/support/canned/{cannedId}":{"put":{"operationId":"updateCannedReply","summary":"Edit a saved reply","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^crep_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"shortcut":{"type":"string","maxLength":32,"pattern":"^[a-z0-9_-]*$"},"body":{"type":"string","minLength":1,"maxLength":5000},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},"required":["name","shortcut","body","category"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CannedReply"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/support/canned/{cannedId}.","x-store-explicit-path":"/v1/stores/{storeId}/support/canned/{cannedId}"},"delete":{"operationId":"deleteCannedReply","summary":"Delete a saved reply","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^crep_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/support/canned/{cannedId}.","x-store-explicit-path":"/v1/stores/{storeId}/support/canned/{cannedId}"}},"/v1/stores/{storeId}/support/canned/{cannedId}":{"put":{"operationId":"updateCannedReplyWithStoreId","summary":"Edit a saved reply","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^crep_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"shortcut":{"type":"string","maxLength":32,"pattern":"^[a-z0-9_-]*$"},"body":{"type":"string","minLength":1,"maxLength":5000},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},"required":["name","shortcut","body","category"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CannedReply"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of PUT /v1/store/support/canned/{cannedId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/canned/{cannedId}"},"delete":{"operationId":"deleteCannedReplyWithStoreId","summary":"Delete a saved reply","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^crep_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of DELETE /v1/store/support/canned/{cannedId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/canned/{cannedId}"}},"/v1/store/support/canned/{cannedId}/fill":{"post":{"operationId":"fillCannedReply","summary":"A saved reply with its variables filled for one ticket","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^crep_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["ticketId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FillCannedReplyResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/support/canned/{cannedId}/fill.","x-store-explicit-path":"/v1/stores/{storeId}/support/canned/{cannedId}/fill"}},"/v1/stores/{storeId}/support/canned/{cannedId}/fill":{"post":{"operationId":"fillCannedReplyWithStoreId","summary":"A saved reply with its variables filled for one ticket","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^crep_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["ticketId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FillCannedReplyResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:write","description":"The explicit form of POST /v1/store/support/canned/{cannedId}/fill, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/canned/{cannedId}/fill"}},"/v1/store/support/settings":{"get":{"operationId":"getSupportSettings","summary":"Support settings: categories, SLA targets, widget, email replies, auto-close and satisfaction","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSupportSettingsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/support/settings.","x-store-explicit-path":"/v1/stores/{storeId}/support/settings"},"put":{"operationId":"updateSupportSettings","summary":"Save support settings","tags":["support"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"categories":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,32}$"},"label":{"type":"string","minLength":1,"maxLength":60}},"required":["id","label"]}},"firstResponse":{"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"]},"resolution":{"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"]},"restrictToAssigned":{"type":"boolean"},"autoCloseDays":{"type":"integer","minimum":0,"maximum":90},"satisfaction":{"type":"boolean"},"widget":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"title":{"default":"Need help?","type":"string","maxLength":60},"greeting":{"default":"Send us a message and we reply by email, usually within a few hours.","type":"string","maxLength":240},"position":{"default":"right","type":"string","enum":["right","left"]},"floating":{"default":true,"type":"boolean"}}},"emailReplies":{"type":"boolean"},"attachmentMaxMb":{"type":"integer","minimum":1,"maximum":25},"autoReply":{"type":"string","maxLength":1000}},"required":["enabled","categories","firstResponse","resolution","restrictToAssigned","autoCloseDays","satisfaction","widget","emailReplies","attachmentMaxMb","autoReply"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupportSettingsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/support/settings.","x-store-explicit-path":"/v1/stores/{storeId}/support/settings"}},"/v1/stores/{storeId}/support/settings":{"get":{"operationId":"getSupportSettingsWithStoreId","summary":"Support settings: categories, SLA targets, widget, email replies, auto-close and satisfaction","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSupportSettingsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The explicit form of GET /v1/store/support/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/settings"},"put":{"operationId":"updateSupportSettingsWithStoreId","summary":"Save support settings","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"categories":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,32}$"},"label":{"type":"string","minLength":1,"maxLength":60}},"required":["id","label"]}},"firstResponse":{"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"]},"resolution":{"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"]},"restrictToAssigned":{"type":"boolean"},"autoCloseDays":{"type":"integer","minimum":0,"maximum":90},"satisfaction":{"type":"boolean"},"widget":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"title":{"default":"Need help?","type":"string","maxLength":60},"greeting":{"default":"Send us a message and we reply by email, usually within a few hours.","type":"string","maxLength":240},"position":{"default":"right","type":"string","enum":["right","left"]},"floating":{"default":true,"type":"boolean"}}},"emailReplies":{"type":"boolean"},"attachmentMaxMb":{"type":"integer","minimum":1,"maximum":25},"autoReply":{"type":"string","maxLength":1000}},"required":["enabled","categories","firstResponse","resolution","restrictToAssigned","autoCloseDays","satisfaction","widget","emailReplies","attachmentMaxMb","autoReply"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupportSettingsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:write","x-api-key-scope":"support:write","description":"The explicit form of PUT /v1/store/support/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/settings"}},"/v1/store/support/report":{"get":{"operationId":"supportReport","summary":"First response and resolution times, SLA, satisfaction, volume, categories and agents","tags":["support"],"security":[{"apiKey":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/support/report.","x-store-explicit-path":"/v1/stores/{storeId}/support/report"}},"/v1/stores/{storeId}/support/report":{"get":{"operationId":"supportReportWithStoreId","summary":"First response and resolution times, SLA, satisfaction, volume, categories and agents","tags":["support"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"support:read","x-api-key-scope":"support:read","description":"The explicit form of GET /v1/store/support/report, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/support/report"}},"/v1/storefront/stores/{storeId}/support":{"get":{"operationId":"buyerSupportForm","summary":"The contact form's settings, and the signed-in buyer's orders to link","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"order","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"access","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerSupportFormResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/support/tickets":{"post":{"operationId":"buyerOpenTicket","summary":"Open a ticket (signed-in buyer, or a guest who gets an access link by email)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":120},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"subject":{"type":"string","minLength":3,"maxLength":200},"category":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]},"message":{"type":"string","minLength":10,"maxLength":10000},"channel":{"type":"string","enum":["web","widget","order"]},"order":{"anyOf":[{"type":"object","properties":{"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},"required":["sessionId","access"]},{"type":"null"}]},"attachments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"},"claim":{"type":"string","minLength":10,"maxLength":200}},"required":["id","claim"]}},"website":{"default":"","type":"string","maxLength":200}},"required":["name","email","subject","category","message","channel","order","attachments"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOpenTicketResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"get":{"operationId":"buyerTickets","summary":"The signed-in buyer's tickets","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerTicketsResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/support/attachments":{"post":{"operationId":"buyerStartAttachment","summary":"A signed upload link for a ticket attachment (images, PDF, text, zip; size limit per store)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":160},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf","text/plain","application/zip"]},"bytes":{"type":"integer","minimum":1,"maximum":26214400}},"required":["filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartAgentAttachmentResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/support/attachments/{attachmentId}/complete":{"post":{"operationId":"buyerCompleteAttachment","summary":"Check an uploaded attachment","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"claim":{"type":"string","minLength":10,"maxLength":200}},"required":["claim"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCompleteAttachmentResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/support/tickets/{ticketId}":{"get":{"operationId":"buyerGetTicket","summary":"One ticket for the buyer (signed in with the same email, or the access link)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","minLength":20,"maxLength":300,"pattern":"^[A-Za-z0-9_.-]+$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerTicket"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/support/tickets/{ticketId}/messages":{"post":{"operationId":"buyerReplyTicket","summary":"Reply on a ticket (reopens it)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"anyOf":[{"type":"string","minLength":20,"maxLength":300,"pattern":"^[A-Za-z0-9_.-]+$"},{"type":"null"}]},"body":{"type":"string","minLength":1,"maxLength":10000},"attachments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"},"claim":{"type":"string","minLength":10,"maxLength":200}},"required":["id","claim"]}}},"required":["access","body","attachments"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerTicket"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/support/tickets/{ticketId}/rating":{"post":{"operationId":"buyerRateTicket","summary":"Rate the support on a solved ticket (1–5) with an optional comment","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"anyOf":[{"type":"string","minLength":20,"maxLength":300,"pattern":"^[A-Za-z0-9_.-]+$"},{"type":"null"}]},"rating":{"type":"integer","minimum":1,"maximum":5},"comment":{"type":"string","maxLength":1000}},"required":["access","rating","comment"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerTicket"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/marketing/overview":{"get":{"operationId":"marketingOverview","summary":"Audience size, growth and the last 30 days of email results","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketingOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/stores/{storeId}/marketing/contacts":{"get":{"operationId":"listContacts","summary":"The audience with consent status, by tab, search or segment","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","subscribed","pending","unsubscribed","not_subscribed","suppressed"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"segmentId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^seg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","contact","consent","source","orders","spent","opened"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"post":{"operationId":"upsertContact","summary":"Add a contact (or update one with the same email). \"pending\" sends a confirmation email.","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"name":{"type":"string","maxLength":120},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":32}},"status":{"type":"string","enum":["subscribed","not_subscribed","pending"]},"consentConfirmed":{"type":"boolean"}},"required":["email","name","tags","status","consentConfirmed"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/contacts/{contactId}":{"patch":{"operationId":"updateContact","summary":"Change tags, categories, or unsubscribe a contact. Resubscribing asks the person to confirm by email.","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"contactId","in":"path","required":true,"schema":{"type":"string","pattern":"^mc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":32}},"categories":{"type":"object","properties":{"newsletter":{"type":"boolean"},"promotions":{"type":"boolean"},"product_updates":{"type":"boolean"},"reminders":{"type":"boolean"}},"required":["newsletter","promotions","product_updates","reminders"]},"action":{"type":"string","enum":["unsubscribe","reconfirm"]},"name":{"type":"string","maxLength":120}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"},"delete":{"operationId":"deleteContact","summary":"Erase a contact and their email history (GDPR); the address stays suppressed so it is never re-added by mistake","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"contactId","in":"path","required":true,"schema":{"type":"string","pattern":"^mc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/contacts/import":{"post":{"operationId":"importContacts","summary":"Import a CSV (email, name, tags). Contacts you have consent for join as subscribed; others as not subscribed.","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"type":"string","maxLength":2000000},"consentConfirmed":{"type":"boolean"},"tag":{"type":"string","maxLength":32},"asStatus":{"type":"string","enum":["subscribed","not_subscribed","pending"]}},"required":["csv","consentConfirmed","tag","asStatus"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportContactsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/contacts/export":{"get":{"operationId":"exportContacts","summary":"The audience as CSV","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","subscribed","pending","unsubscribed","not_subscribed","suppressed"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportContactsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/stores/{storeId}/marketing/contacts/sync":{"post":{"operationId":"syncAudience","summary":"Bring in new customers, checkout opt-ins and newsletter sign-ups now (also runs every few minutes)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAudienceResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/suppressions":{"get":{"operationId":"listSuppressions","summary":"Addresses that never get marketing: bounces, spam complaints, unsubscribes and manual blocks","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSuppressionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"post":{"operationId":"addSuppression","summary":"Never send marketing to these addresses","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}},"required":["emails"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSuppressionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/suppressions/remove":{"post":{"operationId":"removeSuppression","summary":"Lift a manual suppression (bounces and spam complaints stay; unsubscribes need the person to opt in again)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/segments":{"get":{"operationId":"listAudienceSegments","summary":"Saved segments with subscriber counts, and presets to start from","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAudienceSegmentsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"post":{"operationId":"createAudienceSegment","summary":"Save a segment","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":300},"rules":{"type":"object","properties":{"match":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["orders_count","total_spent","last_order_days","first_order_days","avg_order","bought_product","not_bought_product","tag","not_tag","country","consent_days","opened_days","clicked_days","event_count","source"]},"op":{"type":"string","enum":["gt","gte","lt","lte","eq","neq","within","not_within","is","is_not"]},"value":{"anyOf":[{"type":"number"},{"type":"string","maxLength":80}]},"days":{"type":"integer","minimum":1,"maximum":730},"event":{"type":"string","maxLength":60}},"required":["field","op","value"]}}},"required":["match","conditions"]}},"required":["name","description","rules"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceSegment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/segments/preview":{"post":{"operationId":"previewAudienceSegment","summary":"How many subscribed contacts match these rules, with a sample","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"type":"object","properties":{"match":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["orders_count","total_spent","last_order_days","first_order_days","avg_order","bought_product","not_bought_product","tag","not_tag","country","consent_days","opened_days","clicked_days","event_count","source"]},"op":{"type":"string","enum":["gt","gte","lt","lte","eq","neq","within","not_within","is","is_not"]},"value":{"anyOf":[{"type":"number"},{"type":"string","maxLength":80}]},"days":{"type":"integer","minimum":1,"maximum":730},"event":{"type":"string","maxLength":60}},"required":["field","op","value"]}}},"required":["match","conditions"]}},"required":["rules"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewAudienceSegmentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/stores/{storeId}/marketing/segments/{segmentId}":{"put":{"operationId":"updateAudienceSegment","summary":"Edit a segment","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"segmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^seg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":300},"rules":{"type":"object","properties":{"match":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["orders_count","total_spent","last_order_days","first_order_days","avg_order","bought_product","not_bought_product","tag","not_tag","country","consent_days","opened_days","clicked_days","event_count","source"]},"op":{"type":"string","enum":["gt","gte","lt","lte","eq","neq","within","not_within","is","is_not"]},"value":{"anyOf":[{"type":"number"},{"type":"string","maxLength":80}]},"days":{"type":"integer","minimum":1,"maximum":730},"event":{"type":"string","maxLength":60}},"required":["field","op","value"]}}},"required":["match","conditions"]}},"required":["name","description","rules"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceSegment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"},"delete":{"operationId":"deleteAudienceSegment","summary":"Delete a segment (campaigns that used it keep their recipients)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"segmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^seg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/campaigns":{"get":{"operationId":"listCampaigns","summary":"Campaigns with their results (the 200 last edited, or the first 200 by `sort`)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["draft","scheduled","sending","testing","sent","paused","cancelled"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"updated","type":"string","enum":["updated","name","status","recipients","opened","clicked","revenue"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCampaignsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"post":{"operationId":"createCampaign","summary":"Create a draft campaign","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"category":{"type":"string","enum":["newsletter","promotions","product_updates","reminders"]},"segmentId":{"anyOf":[{"type":"string","pattern":"^seg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"ab":{"type":"object","properties":{"enabled":{"type":"boolean"},"subjectB":{"type":"string","maxLength":200},"testPercent":{"type":"integer","minimum":10,"maximum":100},"winnerBy":{"type":"string","enum":["opens","clicks"]},"decideAfterMinutes":{"type":"integer","minimum":30,"maximum":2880}},"required":["enabled","subjectB","testPercent","winnerBy","decideAfterMinutes"]},"window":{"type":"object","properties":{"enabled":{"type":"boolean"},"startHour":{"type":"integer","minimum":0,"maximum":23},"endHour":{"type":"integer","minimum":1,"maximum":24},"days":{"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}}},"required":["enabled","startHour","endHour","days"]},"throttlePerMinute":{"type":"integer","minimum":10,"maximum":10000}},"required":["name","category","segmentId","doc","ab","window","throttlePerMinute"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/campaigns/{campaignId}":{"get":{"operationId":"getCampaign","summary":"One campaign: content, schedule and analytics","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"put":{"operationId":"updateCampaign","summary":"Edit a draft, scheduled or paused campaign (saves a version)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"category":{"type":"string","enum":["newsletter","promotions","product_updates","reminders"]},"segmentId":{"anyOf":[{"type":"string","pattern":"^seg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"ab":{"type":"object","properties":{"enabled":{"type":"boolean"},"subjectB":{"type":"string","maxLength":200},"testPercent":{"type":"integer","minimum":10,"maximum":100},"winnerBy":{"type":"string","enum":["opens","clicks"]},"decideAfterMinutes":{"type":"integer","minimum":30,"maximum":2880}},"required":["enabled","subjectB","testPercent","winnerBy","decideAfterMinutes"]},"window":{"type":"object","properties":{"enabled":{"type":"boolean"},"startHour":{"type":"integer","minimum":0,"maximum":23},"endHour":{"type":"integer","minimum":1,"maximum":24},"days":{"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}}},"required":["enabled","startHour","endHour","days"]},"throttlePerMinute":{"type":"integer","minimum":10,"maximum":10000}},"required":["name","category","segmentId","doc","ab","window","throttlePerMinute"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"},"delete":{"operationId":"deleteCampaign","summary":"Delete a draft or cancelled campaign","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/campaigns/{campaignId}/duplicate":{"post":{"operationId":"duplicateCampaign","summary":"Copy a campaign as a new draft","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/campaigns/{campaignId}/schedule":{"post":{"operationId":"scheduleCampaign","summary":"Send now (at null) or at a time; recipients are fixed when sending starts","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["at"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/campaigns/{campaignId}/control":{"post":{"operationId":"controlCampaign","summary":"Pause, resume or cancel sending (or unschedule back to a draft)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["pause","resume","cancel","unschedule"]}},"required":["action"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/campaigns/test":{"post":{"operationId":"testCampaign","summary":"Send a test of a document to you (and up to 3 teammates)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"subjectB":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"flow":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"to":{"maxItems":3,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}},"required":["doc","subjectB","flow","to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestCampaignResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/campaigns/estimate":{"post":{"operationId":"estimateAudience","summary":"Recipients a campaign would reach now (subscribed, in the segment, category on, not suppressed)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"segmentId":{"anyOf":[{"type":"string","pattern":"^seg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"category":{"type":"string","enum":["newsletter","promotions","product_updates","reminders"]}},"required":["segmentId","category"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstimateAudienceResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/stores/{storeId}/marketing/flows":{"get":{"operationId":"listFlows","summary":"Automations: welcome, abandoned cart, post-purchase, win-back, key expiry and review request","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/stores/{storeId}/marketing/flows/{flowId}":{"put":{"operationId":"updateFlow","summary":"Edit an automation (steps, timing, content) and turn it on or off","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"flowId","in":"path","required":true,"schema":{"type":"string","pattern":"^flow_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"enabled":{"type":"boolean"},"steps":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"delayMinutes":{"type":"integer","minimum":0,"maximum":525600},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"exitOnPurchase":{"default":true,"type":"boolean"},"channel":{"type":"string","enum":["email","discord_dm","both"]},"dm":{"type":"string","maxLength":1800}},"required":["id","delayMinutes","doc"]}},"settings":{"type":"object","properties":{"inactiveDays":{"default":60,"type":"integer","minimum":7,"maximum":730},"durationOnly":{"default":true,"type":"boolean"},"requireConsent":{"default":true,"type":"boolean"}}}},"required":["name","enabled","steps","settings"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/settings":{"get":{"operationId":"getMarketingSettings","summary":"Double opt-in, sender, tracking and the legal footer","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMarketingSettingsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"put":{"operationId":"updateMarketingSettings","summary":"Save marketing settings","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"doubleOptIn":{"type":"boolean"},"senderName":{"type":"string","maxLength":80},"replyTo":{"type":"string","maxLength":254},"footerText":{"type":"string","maxLength":400},"trackOpens":{"type":"boolean"},"trackClicks":{"type":"boolean"},"syncCheckoutConsent":{"type":"boolean"}},"required":["doubleOptIn","senderName","replyTo","footerText","trackOpens","trackClicks","syncCheckoutConsent"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMarketingSettingsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/templates":{"get":{"operationId":"listEmailTemplatesGallery","summary":"The template gallery and your saved designs","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEmailTemplatesGalleryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"post":{"operationId":"saveEmailTemplateDesign","summary":"Save a design to reuse","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":200},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]}},"required":["name","description","doc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedTemplate"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/templates/{templateId}":{"delete":{"operationId":"deleteEmailTemplateDesign","summary":"Delete a saved design","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"templateId","in":"path","required":true,"schema":{"type":"string","pattern":"^etpl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/stores/{storeId}/marketing/products":{"get":{"operationId":"marketingProductPicks","summary":"Products for the editor’s product block (name, price, link, image)","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketingProductPicksResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/mail/preferences":{"get":{"operationId":"getEmailPreferences","summary":"A subscriber’s email categories (from the signed link in an email)","tags":["mail"],"security":[],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","minLength":20,"maxLength":400,"pattern":"^[A-Za-z0-9_.-]+$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailPreferences"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"updateEmailPreferences","summary":"Change categories or unsubscribe from everything","tags":["mail"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":400,"pattern":"^[A-Za-z0-9_.-]+$"},"categories":{"type":"object","properties":{"newsletter":{"type":"boolean"},"promotions":{"type":"boolean"},"product_updates":{"type":"boolean"},"reminders":{"type":"boolean"}},"required":["newsletter","promotions","product_updates","reminders"]},"unsubscribeAll":{"type":"boolean"}},"required":["token","categories","unsubscribeAll"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailPreferences"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/mail/confirm":{"post":{"operationId":"confirmSubscription","summary":"Double opt-in: confirm a subscription from the emailed link","tags":["mail"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":400,"pattern":"^[A-Za-z0-9_.-]+$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmSubscriptionResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/emails/{kind}/document":{"get":{"operationId":"getEmailDocument","summary":"A transactional email as blocks, with its typed variables and preview data","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEmailDocumentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/emails/{kind}/document.","x-store-explicit-path":"/v1/stores/{storeId}/emails/{kind}/document"},"put":{"operationId":"saveEmailDocument","summary":"Save a transactional email built with blocks (keeps a version)","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]}},"required":["enabled","doc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveEmailDocumentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/emails/{kind}/document.","x-store-explicit-path":"/v1/stores/{storeId}/emails/{kind}/document"}},"/v1/stores/{storeId}/emails/{kind}/document":{"get":{"operationId":"getEmailDocumentWithStoreId","summary":"A transactional email as blocks, with its typed variables and preview data","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEmailDocumentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/emails/{kind}/document, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails/{kind}/document"},"put":{"operationId":"saveEmailDocumentWithStoreId","summary":"Save a transactional email built with blocks (keeps a version)","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]}},"required":["enabled","doc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveEmailDocumentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/emails/{kind}/document, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails/{kind}/document"}},"/v1/store/emails/{kind}/document/test":{"post":{"operationId":"testEmailDocument","summary":"Send yourself a test with sample data (rendered on the server exactly as buyers get it)","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]}},"required":["doc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestEmailDocumentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/emails/{kind}/document/test.","x-store-explicit-path":"/v1/stores/{storeId}/emails/{kind}/document/test"}},"/v1/stores/{storeId}/emails/{kind}/document/test":{"post":{"operationId":"testEmailDocumentWithStoreId","summary":"Send yourself a test with sample data (rendered on the server exactly as buyers get it)","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"path","required":true,"schema":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]}},"required":["doc"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestEmailDocumentResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/emails/{kind}/document/test, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails/{kind}/document/test"}},"/v1/store/emails/render":{"post":{"operationId":"renderEmailPreview","summary":"The server render of a document (email HTML and text) with sample data","tags":["emails"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"kind":{"anyOf":[{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]},{"type":"null"}]},"flow":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},"required":["doc","kind","flow"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderEmailPreviewResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/emails/render.","x-store-explicit-path":"/v1/stores/{storeId}/emails/render"}},"/v1/stores/{storeId}/emails/render":{"post":{"operationId":"renderEmailPreviewWithStoreId","summary":"The server render of a document (email HTML and text) with sample data","tags":["emails"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"kind":{"anyOf":[{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]},{"type":"null"}]},"flow":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},"required":["doc","kind","flow"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenderEmailPreviewResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/emails/render, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/emails/render"}},"/v1/stores/{storeId}/email-versions":{"get":{"operationId":"listEmailVersions","summary":"Saved versions of a template, campaign or flow step","tags":["email-versions"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"scope","in":"query","required":true,"schema":{"type":"string","pattern":"^(template:[a-z_]+|campaign:cmp_[0-9a-hjkmnp-tv-z]{20}|flow:flow_[0-9a-hjkmnp-tv-z]{20}:[a-z0-9_-]{1,24}|saved:etpl_[0-9a-hjkmnp-tv-z]{20})$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEmailVersionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/stores/{storeId}/email-versions/{versionId}":{"get":{"operationId":"getEmailVersion","summary":"One saved version","tags":["email-versions"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"versionId","in":"path","required":true,"schema":{"type":"string","pattern":"^ever_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEmailVersionResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/stores/{storeId}/status-pages":{"get":{"operationId":"getStatusOverview","summary":"Status pages, labels, components, incidents and subscriber counts","tags":["status-pages"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatusOverviewResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"},"post":{"operationId":"createStatusPage","summary":"Create a status page (the first one starts with the default labels and is served at /status)","tags":["status-pages"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":400},"published":{"type":"boolean"},"historyDays":{"anyOf":[{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":90}]},"showUptime":{"type":"boolean"},"allowSubscribers":{"type":"boolean"},"theme":{"type":"object","properties":{"accent":{"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"layout":{"type":"string","enum":["list","grid"]},"appearance":{"type":"string","enum":["auto","dark","light"]},"showGroups":{"type":"boolean"}},"required":["accent","layout","appearance","showGroups"]},"embedOrigins":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":200,"pattern":"^https:\\/\\/[a-z0-9.-]+(?::\\d{2,5})?$"}}},"required":["slug","name","description","published","historyDays","showUptime","allowSubscribers","theme","embedOrigins"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-pages/{pageId}":{"put":{"operationId":"updateStatusPage","summary":"Edit a status page","tags":["status-pages"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":400},"published":{"type":"boolean"},"historyDays":{"anyOf":[{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":90}]},"showUptime":{"type":"boolean"},"allowSubscribers":{"type":"boolean"},"theme":{"type":"object","properties":{"accent":{"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"layout":{"type":"string","enum":["list","grid"]},"appearance":{"type":"string","enum":["auto","dark","light"]},"showGroups":{"type":"boolean"}},"required":["accent","layout","appearance","showGroups"]},"embedOrigins":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":200,"pattern":"^https:\\/\\/[a-z0-9.-]+(?::\\d{2,5})?$"}}},"required":["slug","name","description","published","historyDays","showUptime","allowSubscribers","theme","embedOrigins"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"},"delete":{"operationId":"deleteStatusPage","summary":"Delete a status page with its components and incidents","tags":["status-pages"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-pages/{pageId}/default":{"post":{"operationId":"makeDefaultStatusPage","summary":"Serve this page at /status","tags":["status-pages"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-labels":{"post":{"operationId":"createStatusLabel","summary":"Add a status label (name, icon, color, severity)","tags":["status-labels"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"description":{"type":"string","maxLength":160},"icon":{"type":"string","enum":["check","refresh","wrench","eye","ban","gavel","x","alert","clock","shield","bolt","pause","flask","lock","cloud","dot"]},"color":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"severity":{"type":"string","enum":["operational","degraded","maintenance","outage"]},"countsAsUp":{"type":"boolean"}},"required":["name","description","icon","color","severity","countsAsUp"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLabel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-labels/{labelId}":{"put":{"operationId":"updateStatusLabel","summary":"Edit a status label","tags":["status-labels"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"description":{"type":"string","maxLength":160},"icon":{"type":"string","enum":["check","refresh","wrench","eye","ban","gavel","x","alert","clock","shield","bolt","pause","flask","lock","cloud","dot"]},"color":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"severity":{"type":"string","enum":["operational","degraded","maintenance","outage"]},"countsAsUp":{"type":"boolean"}},"required":["name","description","icon","color","severity","countsAsUp"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusLabel"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"},"delete":{"operationId":"deleteStatusLabel","summary":"Delete a label; components on it move to another label","tags":["status-labels"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"replaceWith","in":"query","required":true,"schema":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-labels/order":{"post":{"operationId":"reorderStatusLabels","summary":"Order the labels","tags":["status-labels"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-components":{"post":{"operationId":"createStatusComponent","summary":"Add a component (a product, tool or service) to a page","tags":["status-components"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":240},"group":{"type":"string","maxLength":60},"productId":{"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"labelId":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"},"showUptime":{"type":"boolean"},"note":{"type":"string","maxLength":160},"pageId":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["name","description","group","productId","labelId","showUptime","note","pageId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusComponent"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-components/{componentId}":{"put":{"operationId":"updateStatusComponent","summary":"Edit a component","tags":["status-components"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"componentId","in":"path","required":true,"schema":{"type":"string","pattern":"^scm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":240},"group":{"type":"string","maxLength":60},"productId":{"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"labelId":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"},"showUptime":{"type":"boolean"},"note":{"type":"string","maxLength":160}},"required":["name","description","group","productId","labelId","showUptime","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusComponent"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"},"delete":{"operationId":"deleteStatusComponent","summary":"Remove a component","tags":["status-components"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"componentId","in":"path","required":true,"schema":{"type":"string","pattern":"^scm_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-components/{componentId}/status":{"post":{"operationId":"setComponentStatus","summary":"Change a component’s label now (tells subscribers when notify is on)","tags":["status-components"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"componentId","in":"path","required":true,"schema":{"type":"string","pattern":"^scm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"labelId":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"},"note":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]},"notify":{"type":"boolean"}},"required":["labelId","note","notify"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusComponent"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-components/order":{"post":{"operationId":"reorderStatusComponents","summary":"Order a page’s components","tags":["status-components"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"},"ids":{"maxItems":200,"type":"array","items":{"type":"string","pattern":"^scm_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["pageId","ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-incidents":{"post":{"operationId":"createStatusIncident","summary":"Report an incident or schedule maintenance","tags":["status-incidents"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["incident","maintenance"]},"title":{"type":"string","minLength":1,"maxLength":160},"state":{"type":"string","enum":["investigating","identified","monitoring","resolved","scheduled","in_progress","completed"]},"componentIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^scm_[0-9a-hjkmnp-tv-z]{20}$"}},"labelId":{"anyOf":[{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"body":{"type":"string","minLength":1,"maxLength":4000},"scheduledStart":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"scheduledEnd":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"notify":{"type":"boolean"},"pageId":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","title","state","componentIds","labelId","body","scheduledStart","scheduledEnd","notify","pageId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncident"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-incidents/{incidentId}/updates":{"post":{"operationId":"postIncidentUpdate","summary":"Add a timeline update (resolving puts components back to the label you pick)","tags":["status-incidents"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"incidentId","in":"path","required":true,"schema":{"type":"string","pattern":"^sinc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"state":{"type":"string","enum":["investigating","identified","monitoring","resolved","scheduled","in_progress","completed"]},"body":{"type":"string","minLength":1,"maxLength":4000},"notify":{"type":"boolean"},"restoreLabelId":{"anyOf":[{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["state","body","notify","restoreLabelId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIncident"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-incidents/{incidentId}":{"delete":{"operationId":"deleteStatusIncident","summary":"Delete an incident from the history","tags":["status-incidents"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"incidentId","in":"path","required":true,"schema":{"type":"string","pattern":"^sinc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-subscribers":{"get":{"operationId":"listStatusSubscribers","summary":"People and Discord channels following a page","tags":["status-subscribers"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pageId","in":"query","required":true,"schema":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStatusSubscribersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/stores/{storeId}/status-subscribers/{subscriberId}":{"delete":{"operationId":"deleteStatusSubscriber","summary":"Remove a subscriber","tags":["status-subscribers"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"subscriberId","in":"path","required":true,"schema":{"type":"string","pattern":"^ssub_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/status-pages/{pageId}/preview":{"get":{"operationId":"previewStatusPage","summary":"The page as buyers will see it (published or not), for the customizer preview","tags":["status-pages"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicStatusPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/storefront/stores/{storeId}/status":{"get":{"operationId":"publicStatusPage","summary":"A published status page: components with history, active incidents and maintenance","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"page","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicStatusPage"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/status/summary":{"get":{"operationId":"publicStatusSummary","summary":"Every published component’s current label (widgets, badges, theme sections, the product status board app)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicStatusSummary"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/status/subscribe":{"post":{"operationId":"statusSubscribe","summary":"Follow a status page by email (confirmed by a link) or with a Discord webhook","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"string","maxLength":40},"kind":{"type":"string","enum":["email","discord"]},"target":{"type":"string","maxLength":300},"componentIds":{"maxItems":50,"type":"array","items":{"type":"string","pattern":"^scm_[0-9a-hjkmnp-tv-z]{20}$"}},"website":{"default":"","type":"string","maxLength":200}},"required":["page","kind","target","componentIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusSubscribeResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/status/subscription":{"post":{"operationId":"statusSubscription","summary":"Confirm or cancel a subscription from the emailed link","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":400,"pattern":"^[A-Za-z0-9_.-]+$"},"action":{"type":"string","enum":["confirm","unsubscribe"]}},"required":["token","action"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusSubscriptionResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/product-presets":{"get":{"operationId":"listProductPresets","summary":"ShopFast's product presets (with this store's edits) and the store's own presets","tags":["product-presets"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductPresetsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/product-presets.","x-store-explicit-path":"/v1/stores/{storeId}/product-presets"},"post":{"operationId":"createProductPreset","summary":"Save a preset of your own","tags":["product-presets"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"type":"string","maxLength":200},"icon":{"type":"string","enum":["key","shield","user","code","discord","download","calendar","box","bolt","star"]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"titleTemplate":{"type":"string","minLength":1,"maxLength":120},"shortDescription":{"type":"string","maxLength":300},"descriptionMd":{"type":"string","maxLength":5000},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"options":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"default":"","type":"string","maxLength":300},"deliveryNote":{"default":"","type":"string","maxLength":2000}},"required":["name","priceMinor"]}},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"platforms":{"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"instantDelivery":{"type":"boolean"},"keyInstructions":{"type":"string","maxLength":2000},"postPurchaseMessage":{"type":"string","maxLength":5000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"needsGame":{"type":"boolean"},"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]},"discordRoleName":{"type":"string","maxLength":100}},"required":["name","description","icon","type","titleTemplate","shortDescription","descriptionMd","tags","options","priceMinor","platforms","region","status","instantDelivery","keyInstructions","postPurchaseMessage","maxPerOrder","needsGame","downloadLimit","stock","turnaroundDays","discordRoleName"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPreset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/product-presets.","x-store-explicit-path":"/v1/stores/{storeId}/product-presets"}},"/v1/stores/{storeId}/product-presets":{"get":{"operationId":"listProductPresetsWithStoreId","summary":"ShopFast's product presets (with this store's edits) and the store's own presets","tags":["product-presets"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductPresetsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/product-presets, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-presets"},"post":{"operationId":"createProductPresetWithStoreId","summary":"Save a preset of your own","tags":["product-presets"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"type":"string","maxLength":200},"icon":{"type":"string","enum":["key","shield","user","code","discord","download","calendar","box","bolt","star"]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"titleTemplate":{"type":"string","minLength":1,"maxLength":120},"shortDescription":{"type":"string","maxLength":300},"descriptionMd":{"type":"string","maxLength":5000},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"options":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"default":"","type":"string","maxLength":300},"deliveryNote":{"default":"","type":"string","maxLength":2000}},"required":["name","priceMinor"]}},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"platforms":{"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"instantDelivery":{"type":"boolean"},"keyInstructions":{"type":"string","maxLength":2000},"postPurchaseMessage":{"type":"string","maxLength":5000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"needsGame":{"type":"boolean"},"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]},"discordRoleName":{"type":"string","maxLength":100}},"required":["name","description","icon","type","titleTemplate","shortDescription","descriptionMd","tags","options","priceMinor","platforms","region","status","instantDelivery","keyInstructions","postPurchaseMessage","maxPerOrder","needsGame","downloadLimit","stock","turnaroundDays","discordRoleName"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPreset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/product-presets, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-presets"}},"/v1/store/product-presets/{presetKey}":{"put":{"operationId":"saveProductPreset","summary":"Edit a preset (a built-in one becomes your store's copy)","tags":["product-presets"],"security":[{"apiKey":[]}],"parameters":[{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"type":"string","maxLength":200},"icon":{"type":"string","enum":["key","shield","user","code","discord","download","calendar","box","bolt","star"]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"titleTemplate":{"type":"string","minLength":1,"maxLength":120},"shortDescription":{"type":"string","maxLength":300},"descriptionMd":{"type":"string","maxLength":5000},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"options":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"default":"","type":"string","maxLength":300},"deliveryNote":{"default":"","type":"string","maxLength":2000}},"required":["name","priceMinor"]}},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"platforms":{"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"instantDelivery":{"type":"boolean"},"keyInstructions":{"type":"string","maxLength":2000},"postPurchaseMessage":{"type":"string","maxLength":5000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"needsGame":{"type":"boolean"},"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]},"discordRoleName":{"type":"string","maxLength":100}},"required":["name","description","icon","type","titleTemplate","shortDescription","descriptionMd","tags","options","priceMinor","platforms","region","status","instantDelivery","keyInstructions","postPurchaseMessage","maxPerOrder","needsGame","downloadLimit","stock","turnaroundDays","discordRoleName"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPreset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/product-presets/{presetKey}.","x-store-explicit-path":"/v1/stores/{storeId}/product-presets/{presetKey}"},"delete":{"operationId":"resetProductPreset","summary":"Delete your preset, or bring a built-in one back to ShopFast's version","tags":["product-presets"],"security":[{"apiKey":[]}],"parameters":[{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/product-presets/{presetKey}.","x-store-explicit-path":"/v1/stores/{storeId}/product-presets/{presetKey}"}},"/v1/stores/{storeId}/product-presets/{presetKey}":{"put":{"operationId":"saveProductPresetWithStoreId","summary":"Edit a preset (a built-in one becomes your store's copy)","tags":["product-presets"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"type":"string","maxLength":200},"icon":{"type":"string","enum":["key","shield","user","code","discord","download","calendar","box","bolt","star"]},"type":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"titleTemplate":{"type":"string","minLength":1,"maxLength":120},"shortDescription":{"type":"string","maxLength":300},"descriptionMd":{"type":"string","maxLength":5000},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"options":{"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"compareAtMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"default":"","type":"string","maxLength":300},"deliveryNote":{"default":"","type":"string","maxLength":2000}},"required":["name","priceMinor"]}},"priceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"platforms":{"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},"region":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"instantDelivery":{"type":"boolean"},"keyInstructions":{"type":"string","maxLength":2000},"postPurchaseMessage":{"type":"string","maxLength":5000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"needsGame":{"type":"boolean"},"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]},"discordRoleName":{"type":"string","maxLength":100}},"required":["name","description","icon","type","titleTemplate","shortDescription","descriptionMd","tags","options","priceMinor","platforms","region","status","instantDelivery","keyInstructions","postPurchaseMessage","maxPerOrder","needsGame","downloadLimit","stock","turnaroundDays","discordRoleName"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPreset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/product-presets/{presetKey}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-presets/{presetKey}"},"delete":{"operationId":"resetProductPresetWithStoreId","summary":"Delete your preset, or bring a built-in one back to ShopFast's version","tags":["product-presets"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of DELETE /v1/store/product-presets/{presetKey}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-presets/{presetKey}"}},"/v1/store/product-presets/{presetKey}/default":{"post":{"operationId":"setDefaultProductPreset","summary":"Make it the preset \"New product\" opens with (or stop)","tags":["product-presets"],"security":[{"apiKey":[]}],"parameters":[{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isDefault":{"type":"boolean"}},"required":["isDefault"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultProductPresetResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/product-presets/{presetKey}/default.","x-store-explicit-path":"/v1/stores/{storeId}/product-presets/{presetKey}/default"}},"/v1/stores/{storeId}/product-presets/{presetKey}/default":{"post":{"operationId":"setDefaultProductPresetWithStoreId","summary":"Make it the preset \"New product\" opens with (or stop)","tags":["product-presets"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isDefault":{"type":"boolean"}},"required":["isDefault"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultProductPresetResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/product-presets/{presetKey}/default, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-presets/{presetKey}/default"}},"/v1/store/product-presets/{presetKey}/bulk":{"post":{"operationId":"bulkCreateFromPreset","summary":"Create one product per game from a preset (5 games × 4 durations in one go)","tags":["product-presets"],"security":[{"apiKey":[]}],"parameters":[{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"games":{"minItems":1,"maxItems":25,"type":"array","items":{"type":"object","properties":{"game":{"type":"string","minLength":1,"maxLength":80},"name":{"default":"","type":"string","maxLength":120},"platforms":{"default":null,"anyOf":[{"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},{"type":"null"}]}},"required":["game"]}},"prices":{"default":[],"maxItems":12,"type":"array","items":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"status":{"default":"draft","type":"string","enum":["active","draft"]}},"required":["games"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPresetResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/product-presets/{presetKey}/bulk.","x-store-explicit-path":"/v1/stores/{storeId}/product-presets/{presetKey}/bulk"}},"/v1/stores/{storeId}/product-presets/{presetKey}/bulk":{"post":{"operationId":"bulkCreateFromPresetWithStoreId","summary":"Create one product per game from a preset (5 games × 4 durations in one go)","tags":["product-presets"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"presetKey","in":"path","required":true,"schema":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"games":{"minItems":1,"maxItems":25,"type":"array","items":{"type":"object","properties":{"game":{"type":"string","minLength":1,"maxLength":80},"name":{"default":"","type":"string","maxLength":120},"platforms":{"default":null,"anyOf":[{"maxItems":8,"type":"array","items":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]}},{"type":"null"}]}},"required":["game"]}},"prices":{"default":[],"maxItems":12,"type":"array","items":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"status":{"default":"draft","type":"string","enum":["active","draft"]}},"required":["games"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPresetResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/product-presets/{presetKey}/bulk, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-presets/{presetKey}/bulk"}},"/v1/store/product-statuses":{"get":{"operationId":"listProductStatuses","summary":"Every product with its game and live status badge (the status board)","tags":["product-statuses"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductStatusesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/product-statuses.","x-store-explicit-path":"/v1/stores/{storeId}/product-statuses"},"patch":{"operationId":"updateProductStatuses","summary":"Change live status badges (Working, Updating, Not working) of several products at once","tags":["product-statuses"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"status":{"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"statusNote":{"type":"string","maxLength":140}},"required":["productId","status","statusNote"]}}},"required":["items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductStatusesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/product-statuses.","x-store-explicit-path":"/v1/stores/{storeId}/product-statuses"}},"/v1/stores/{storeId}/product-statuses":{"get":{"operationId":"listProductStatusesWithStoreId","summary":"Every product with its game and live status badge (the status board)","tags":["product-statuses"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductStatusesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/product-statuses, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-statuses"},"patch":{"operationId":"updateProductStatusesWithStoreId","summary":"Change live status badges (Working, Updating, Not working) of several products at once","tags":["product-statuses"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"status":{"anyOf":[{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},{"type":"null"}]},"statusNote":{"type":"string","maxLength":140}},"required":["productId","status","statusNote"]}}},"required":["items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductStatusesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PATCH /v1/store/product-statuses, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/product-statuses"}},"/v1/stores/{storeId}/apps":{"get":{"operationId":"getAppDirectory","summary":"Installed apps with their settings, the consent setup and the Lua plugins","tags":["apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppDirectory"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/stores/{storeId}/apps/{appId}":{"post":{"operationId":"installApp","summary":"Install an app with its defaults (apps that need an id stay off until you add it)","tags":["apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","enum":["purchase_alerts","coupon_popup","exit_intent","upsell_popup","countdown_banner","trust_badges","status_board","live_chat","discord_widget","telegram_notify","google_analytics","meta_pixel","tiktok_pixel","cookie_consent","age_gate","currency_display","reviews_carousel","faq_bot","content_protection","maintenance_page","back_in_stock","recently_viewed","wishlist","bought_together","email_popup","tab_reminder","promo_bar","payment_icons","delivery_notice","store_stats","activation_guide","trustpilot","scam_notice","discord_posts","chat_buttons","share_buttons","affiliate_invite","x_pixel","reddit_pixel","google_ads","cookieless_analytics","region_notice","privacy_requests","away_notice"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstalledApp"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"},"put":{"operationId":"saveApp","summary":"Save an app's settings and turn it on or off","tags":["apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","enum":["purchase_alerts","coupon_popup","exit_intent","upsell_popup","countdown_banner","trust_badges","status_board","live_chat","discord_widget","telegram_notify","google_analytics","meta_pixel","tiktok_pixel","cookie_consent","age_gate","currency_display","reviews_carousel","faq_bot","content_protection","maintenance_page","back_in_stock","recently_viewed","wishlist","bought_together","email_popup","tab_reminder","promo_bar","payment_icons","delivery_notice","store_stats","activation_guide","trustpilot","scam_notice","discord_posts","chat_buttons","share_buttons","affiliate_invite","x_pixel","reddit_pixel","google_ads","cookieless_analytics","region_notice","privacy_requests","away_notice"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"object","propertyNames":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9]{0,39}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}},{"maxItems":50,"type":"array","items":{"type":"object","properties":{"a":{"type":"string","maxLength":600},"b":{"type":"string","maxLength":600}},"required":["a","b"]}}]}},"enabled":{"type":"boolean"},"secret":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["values","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstalledApp"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"},"delete":{"operationId":"uninstallApp","summary":"Remove an app and its settings (its popups stay in Marketing → Popups)","tags":["apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","enum":["purchase_alerts","coupon_popup","exit_intent","upsell_popup","countdown_banner","trust_badges","status_board","live_chat","discord_widget","telegram_notify","google_analytics","meta_pixel","tiktok_pixel","cookie_consent","age_gate","currency_display","reviews_carousel","faq_bot","content_protection","maintenance_page","back_in_stock","recently_viewed","wishlist","bought_together","email_popup","tab_reminder","promo_bar","payment_icons","delivery_notice","store_stats","activation_guide","trustpilot","scam_notice","discord_posts","chat_buttons","share_buttons","affiliate_invite","x_pixel","reddit_pixel","google_ads","cookieless_analytics","region_notice","privacy_requests","away_notice"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/apps/{appId}/test":{"post":{"operationId":"testApp","summary":"Send a test (Telegram: a test post to the channel)","tags":["apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","enum":["purchase_alerts","coupon_popup","exit_intent","upsell_popup","countdown_banner","trust_badges","status_board","live_chat","discord_widget","telegram_notify","google_analytics","meta_pixel","tiktok_pixel","cookie_consent","age_gate","currency_display","reviews_carousel","faq_bot","content_protection","maintenance_page","back_in_stock","recently_viewed","wishlist","bought_together","email_popup","tab_reminder","promo_bar","payment_icons","delivery_notice","store_stats","activation_guide","trustpilot","scam_notice","discord_posts","chat_buttons","share_buttons","affiliate_invite","x_pixel","reddit_pixel","google_ads","cookieless_analytics","region_notice","privacy_requests","away_notice"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestAppResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/apps/{appId}/preview-link":{"post":{"operationId":"appPreviewLink","summary":"Maintenance page: a new private link that opens the store for you while buyers see the page","tags":["apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","enum":["purchase_alerts","coupon_popup","exit_intent","upsell_popup","countdown_banner","trust_badges","status_board","live_chat","discord_widget","telegram_notify","google_analytics","meta_pixel","tiktok_pixel","cookie_consent","age_gate","currency_display","reviews_carousel","faq_bot","content_protection","maintenance_page","back_in_stock","recently_viewed","wishlist","bought_together","email_popup","tab_reminder","promo_bar","payment_icons","delivery_notice","store_stats","activation_guide","trustpilot","scam_notice","discord_posts","chat_buttons","share_buttons","affiliate_invite","x_pixel","reddit_pixel","google_ads","cookieless_analytics","region_notice","privacy_requests","away_notice"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppPreviewLinkResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/store/popups":{"get":{"operationId":"listPopups","summary":"Popup offers with impressions and conversions per variant (last 30 days)","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","live","draft","paused","archived"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPopupsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/popups.","x-store-explicit-path":"/v1/stores/{storeId}/popups"},"post":{"operationId":"createPopup","summary":"Create a popup offer","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["coupon","email","exit","upsell","announcement"]},"status":{"type":"string","enum":["draft","live","paused","archived"]},"trigger":{"type":"object","properties":{"kind":{"type":"string","enum":["delay","scroll","exit","add_to_cart","page_views"]},"delaySeconds":{"default":8,"type":"integer","minimum":0,"maximum":300},"scrollPercent":{"default":50,"type":"integer","minimum":5,"maximum":100},"pageViews":{"default":2,"type":"integer","minimum":1,"maximum":20},"exitOnMobile":{"default":true,"type":"boolean"}},"required":["kind"]},"targeting":{"type":"object","properties":{"pages":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["home","product","collection","list-collections","cart","page","search","reviews","other"]}},"productHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"collectionHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"urlContains":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"urlExcludes":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"devices":{"default":"all","type":"string","enum":["all","desktop","mobile"]},"visitors":{"default":"all","type":"string","enum":["all","new","returning"]},"buyers":{"default":"all","type":"string","enum":["all","buyers","non_buyers"]},"cart":{"default":"any","type":"string","enum":["any","empty","has_items"]},"utmSource":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmMedium":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmCampaign":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}}},"frequency":{"type":"object","properties":{"showAgainAfterDays":{"default":7,"type":"integer","minimum":0,"maximum":365},"maxShows":{"default":3,"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]},"stopAfterConversion":{"default":true,"type":"boolean"}}},"variants":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["a","b","c"]},"name":{"type":"string","minLength":1,"maxLength":40},"weight":{"type":"integer","minimum":0,"maximum":100},"content":{"type":"object","properties":{"eyebrow":{"default":"","type":"string","maxLength":40},"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":300},"ctaLabel":{"default":"Shop now","type":"string","maxLength":30},"ctaLink":{"default":"/collections/all","type":"string","maxLength":300},"dismissLabel":{"default":"No thanks","type":"string","maxLength":30},"couponMode":{"default":"none","type":"string","enum":["none","code","unique"]},"discountId":{"default":null,"anyOf":[{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"revealAfterEmail":{"default":false,"type":"boolean"},"emailCapture":{"default":false,"type":"boolean"},"emailPlaceholder":{"default":"you@example.com","type":"string","maxLength":60},"consentLabel":{"default":"Send me offers and updates by email. Unsubscribe anytime.","type":"string","maxLength":200},"requireConsent":{"default":false,"type":"boolean"},"submitLabel":{"default":"Get my code","type":"string","maxLength":30},"successHeading":{"default":"You are in","type":"string","maxLength":80},"successBody":{"default":"Use your code at checkout.","type":"string","maxLength":300},"timerMinutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1440},{"type":"null"}]},"upsellHandle":{"default":null,"anyOf":[{"type":"string","maxLength":140},{"type":"null"}]}},"required":["heading"]},"design":{"type":"object","properties":{"layout":{"default":"modal","type":"string","enum":["modal","split","corner","bar","sheet"]},"position":{"default":"center","type":"string","enum":["center","bottom-right","bottom-left","top","bottom"]},"surface":{"default":"store","type":"string","enum":["store","light","dark"]},"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"radius":{"default":16,"type":"integer","minimum":0,"maximum":28},"motion":{"default":"rise","type":"string","enum":["rise","scale","slide","fade"]},"width":{"default":"md","type":"string","enum":["sm","md","lg"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"backdrop":{"default":45,"type":"integer","minimum":0,"maximum":80},"showClose":{"default":true,"type":"boolean"}}}},"required":["key","name","weight","content","design"]}},"startsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"endsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100}},"required":["name","kind","status","trigger","targeting","frequency","variants"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/popups.","x-store-explicit-path":"/v1/stores/{storeId}/popups"}},"/v1/stores/{storeId}/popups":{"get":{"operationId":"listPopupsWithStoreId","summary":"Popup offers with impressions and conversions per variant (last 30 days)","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","live","draft","paused","archived"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPopupsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/popups, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups"},"post":{"operationId":"createPopupWithStoreId","summary":"Create a popup offer","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["coupon","email","exit","upsell","announcement"]},"status":{"type":"string","enum":["draft","live","paused","archived"]},"trigger":{"type":"object","properties":{"kind":{"type":"string","enum":["delay","scroll","exit","add_to_cart","page_views"]},"delaySeconds":{"default":8,"type":"integer","minimum":0,"maximum":300},"scrollPercent":{"default":50,"type":"integer","minimum":5,"maximum":100},"pageViews":{"default":2,"type":"integer","minimum":1,"maximum":20},"exitOnMobile":{"default":true,"type":"boolean"}},"required":["kind"]},"targeting":{"type":"object","properties":{"pages":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["home","product","collection","list-collections","cart","page","search","reviews","other"]}},"productHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"collectionHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"urlContains":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"urlExcludes":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"devices":{"default":"all","type":"string","enum":["all","desktop","mobile"]},"visitors":{"default":"all","type":"string","enum":["all","new","returning"]},"buyers":{"default":"all","type":"string","enum":["all","buyers","non_buyers"]},"cart":{"default":"any","type":"string","enum":["any","empty","has_items"]},"utmSource":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmMedium":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmCampaign":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}}},"frequency":{"type":"object","properties":{"showAgainAfterDays":{"default":7,"type":"integer","minimum":0,"maximum":365},"maxShows":{"default":3,"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]},"stopAfterConversion":{"default":true,"type":"boolean"}}},"variants":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["a","b","c"]},"name":{"type":"string","minLength":1,"maxLength":40},"weight":{"type":"integer","minimum":0,"maximum":100},"content":{"type":"object","properties":{"eyebrow":{"default":"","type":"string","maxLength":40},"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":300},"ctaLabel":{"default":"Shop now","type":"string","maxLength":30},"ctaLink":{"default":"/collections/all","type":"string","maxLength":300},"dismissLabel":{"default":"No thanks","type":"string","maxLength":30},"couponMode":{"default":"none","type":"string","enum":["none","code","unique"]},"discountId":{"default":null,"anyOf":[{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"revealAfterEmail":{"default":false,"type":"boolean"},"emailCapture":{"default":false,"type":"boolean"},"emailPlaceholder":{"default":"you@example.com","type":"string","maxLength":60},"consentLabel":{"default":"Send me offers and updates by email. Unsubscribe anytime.","type":"string","maxLength":200},"requireConsent":{"default":false,"type":"boolean"},"submitLabel":{"default":"Get my code","type":"string","maxLength":30},"successHeading":{"default":"You are in","type":"string","maxLength":80},"successBody":{"default":"Use your code at checkout.","type":"string","maxLength":300},"timerMinutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1440},{"type":"null"}]},"upsellHandle":{"default":null,"anyOf":[{"type":"string","maxLength":140},{"type":"null"}]}},"required":["heading"]},"design":{"type":"object","properties":{"layout":{"default":"modal","type":"string","enum":["modal","split","corner","bar","sheet"]},"position":{"default":"center","type":"string","enum":["center","bottom-right","bottom-left","top","bottom"]},"surface":{"default":"store","type":"string","enum":["store","light","dark"]},"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"radius":{"default":16,"type":"integer","minimum":0,"maximum":28},"motion":{"default":"rise","type":"string","enum":["rise","scale","slide","fade"]},"width":{"default":"md","type":"string","enum":["sm","md","lg"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"backdrop":{"default":45,"type":"integer","minimum":0,"maximum":80},"showClose":{"default":true,"type":"boolean"}}}},"required":["key","name","weight","content","design"]}},"startsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"endsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100}},"required":["name","kind","status","trigger","targeting","frequency","variants"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/popups, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups"}},"/v1/store/popups/{popupId}":{"get":{"operationId":"getPopup","summary":"One popup with its daily series and recent email signups","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopupDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/popups/{popupId}.","x-store-explicit-path":"/v1/stores/{storeId}/popups/{popupId}"},"put":{"operationId":"savePopup","summary":"Save a popup offer","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["coupon","email","exit","upsell","announcement"]},"status":{"type":"string","enum":["draft","live","paused","archived"]},"trigger":{"type":"object","properties":{"kind":{"type":"string","enum":["delay","scroll","exit","add_to_cart","page_views"]},"delaySeconds":{"default":8,"type":"integer","minimum":0,"maximum":300},"scrollPercent":{"default":50,"type":"integer","minimum":5,"maximum":100},"pageViews":{"default":2,"type":"integer","minimum":1,"maximum":20},"exitOnMobile":{"default":true,"type":"boolean"}},"required":["kind"]},"targeting":{"type":"object","properties":{"pages":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["home","product","collection","list-collections","cart","page","search","reviews","other"]}},"productHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"collectionHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"urlContains":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"urlExcludes":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"devices":{"default":"all","type":"string","enum":["all","desktop","mobile"]},"visitors":{"default":"all","type":"string","enum":["all","new","returning"]},"buyers":{"default":"all","type":"string","enum":["all","buyers","non_buyers"]},"cart":{"default":"any","type":"string","enum":["any","empty","has_items"]},"utmSource":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmMedium":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmCampaign":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}}},"frequency":{"type":"object","properties":{"showAgainAfterDays":{"default":7,"type":"integer","minimum":0,"maximum":365},"maxShows":{"default":3,"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]},"stopAfterConversion":{"default":true,"type":"boolean"}}},"variants":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["a","b","c"]},"name":{"type":"string","minLength":1,"maxLength":40},"weight":{"type":"integer","minimum":0,"maximum":100},"content":{"type":"object","properties":{"eyebrow":{"default":"","type":"string","maxLength":40},"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":300},"ctaLabel":{"default":"Shop now","type":"string","maxLength":30},"ctaLink":{"default":"/collections/all","type":"string","maxLength":300},"dismissLabel":{"default":"No thanks","type":"string","maxLength":30},"couponMode":{"default":"none","type":"string","enum":["none","code","unique"]},"discountId":{"default":null,"anyOf":[{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"revealAfterEmail":{"default":false,"type":"boolean"},"emailCapture":{"default":false,"type":"boolean"},"emailPlaceholder":{"default":"you@example.com","type":"string","maxLength":60},"consentLabel":{"default":"Send me offers and updates by email. Unsubscribe anytime.","type":"string","maxLength":200},"requireConsent":{"default":false,"type":"boolean"},"submitLabel":{"default":"Get my code","type":"string","maxLength":30},"successHeading":{"default":"You are in","type":"string","maxLength":80},"successBody":{"default":"Use your code at checkout.","type":"string","maxLength":300},"timerMinutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1440},{"type":"null"}]},"upsellHandle":{"default":null,"anyOf":[{"type":"string","maxLength":140},{"type":"null"}]}},"required":["heading"]},"design":{"type":"object","properties":{"layout":{"default":"modal","type":"string","enum":["modal","split","corner","bar","sheet"]},"position":{"default":"center","type":"string","enum":["center","bottom-right","bottom-left","top","bottom"]},"surface":{"default":"store","type":"string","enum":["store","light","dark"]},"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"radius":{"default":16,"type":"integer","minimum":0,"maximum":28},"motion":{"default":"rise","type":"string","enum":["rise","scale","slide","fade"]},"width":{"default":"md","type":"string","enum":["sm","md","lg"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"backdrop":{"default":45,"type":"integer","minimum":0,"maximum":80},"showClose":{"default":true,"type":"boolean"}}}},"required":["key","name","weight","content","design"]}},"startsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"endsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100}},"required":["name","kind","status","trigger","targeting","frequency","variants"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/popups/{popupId}.","x-store-explicit-path":"/v1/stores/{storeId}/popups/{popupId}"},"delete":{"operationId":"deletePopup","summary":"Delete a popup with its stats (email signups stay in the export until then)","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/popups/{popupId}.","x-store-explicit-path":"/v1/stores/{storeId}/popups/{popupId}"}},"/v1/stores/{storeId}/popups/{popupId}":{"get":{"operationId":"getPopupWithStoreId","summary":"One popup with its daily series and recent email signups","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopupDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/popups/{popupId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups/{popupId}"},"put":{"operationId":"savePopupWithStoreId","summary":"Save a popup offer","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"type":"string","enum":["coupon","email","exit","upsell","announcement"]},"status":{"type":"string","enum":["draft","live","paused","archived"]},"trigger":{"type":"object","properties":{"kind":{"type":"string","enum":["delay","scroll","exit","add_to_cart","page_views"]},"delaySeconds":{"default":8,"type":"integer","minimum":0,"maximum":300},"scrollPercent":{"default":50,"type":"integer","minimum":5,"maximum":100},"pageViews":{"default":2,"type":"integer","minimum":1,"maximum":20},"exitOnMobile":{"default":true,"type":"boolean"}},"required":["kind"]},"targeting":{"type":"object","properties":{"pages":{"default":[],"maxItems":9,"type":"array","items":{"type":"string","enum":["home","product","collection","list-collections","cart","page","search","reviews","other"]}},"productHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"collectionHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"urlContains":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"urlExcludes":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"devices":{"default":"all","type":"string","enum":["all","desktop","mobile"]},"visitors":{"default":"all","type":"string","enum":["all","new","returning"]},"buyers":{"default":"all","type":"string","enum":["all","buyers","non_buyers"]},"cart":{"default":"any","type":"string","enum":["any","empty","has_items"]},"utmSource":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmMedium":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmCampaign":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}}},"frequency":{"type":"object","properties":{"showAgainAfterDays":{"default":7,"type":"integer","minimum":0,"maximum":365},"maxShows":{"default":3,"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]},"stopAfterConversion":{"default":true,"type":"boolean"}}},"variants":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["a","b","c"]},"name":{"type":"string","minLength":1,"maxLength":40},"weight":{"type":"integer","minimum":0,"maximum":100},"content":{"type":"object","properties":{"eyebrow":{"default":"","type":"string","maxLength":40},"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":300},"ctaLabel":{"default":"Shop now","type":"string","maxLength":30},"ctaLink":{"default":"/collections/all","type":"string","maxLength":300},"dismissLabel":{"default":"No thanks","type":"string","maxLength":30},"couponMode":{"default":"none","type":"string","enum":["none","code","unique"]},"discountId":{"default":null,"anyOf":[{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"revealAfterEmail":{"default":false,"type":"boolean"},"emailCapture":{"default":false,"type":"boolean"},"emailPlaceholder":{"default":"you@example.com","type":"string","maxLength":60},"consentLabel":{"default":"Send me offers and updates by email. Unsubscribe anytime.","type":"string","maxLength":200},"requireConsent":{"default":false,"type":"boolean"},"submitLabel":{"default":"Get my code","type":"string","maxLength":30},"successHeading":{"default":"You are in","type":"string","maxLength":80},"successBody":{"default":"Use your code at checkout.","type":"string","maxLength":300},"timerMinutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1440},{"type":"null"}]},"upsellHandle":{"default":null,"anyOf":[{"type":"string","maxLength":140},{"type":"null"}]}},"required":["heading"]},"design":{"type":"object","properties":{"layout":{"default":"modal","type":"string","enum":["modal","split","corner","bar","sheet"]},"position":{"default":"center","type":"string","enum":["center","bottom-right","bottom-left","top","bottom"]},"surface":{"default":"store","type":"string","enum":["store","light","dark"]},"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"radius":{"default":16,"type":"integer","minimum":0,"maximum":28},"motion":{"default":"rise","type":"string","enum":["rise","scale","slide","fade"]},"width":{"default":"md","type":"string","enum":["sm","md","lg"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"backdrop":{"default":45,"type":"integer","minimum":0,"maximum":80},"showClose":{"default":true,"type":"boolean"}}}},"required":["key","name","weight","content","design"]}},"startsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"endsAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100}},"required":["name","kind","status","trigger","targeting","frequency","variants"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of PUT /v1/store/popups/{popupId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups/{popupId}"},"delete":{"operationId":"deletePopupWithStoreId","summary":"Delete a popup with its stats (email signups stay in the export until then)","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of DELETE /v1/store/popups/{popupId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups/{popupId}"}},"/v1/store/popups/{popupId}/status":{"post":{"operationId":"setPopupStatus","summary":"Publish, pause or archive a popup","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["draft","live","paused","archived"]}},"required":["status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/popups/{popupId}/status.","x-store-explicit-path":"/v1/stores/{storeId}/popups/{popupId}/status"}},"/v1/stores/{storeId}/popups/{popupId}/status":{"post":{"operationId":"setPopupStatusWithStoreId","summary":"Publish, pause or archive a popup","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["draft","live","paused","archived"]}},"required":["status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/popups/{popupId}/status, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups/{popupId}/status"}},"/v1/store/popups/{popupId}/duplicate":{"post":{"operationId":"duplicatePopup","summary":"Copy a popup as a draft","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/popups/{popupId}/duplicate.","x-store-explicit-path":"/v1/stores/{storeId}/popups/{popupId}/duplicate"}},"/v1/stores/{storeId}/popups/{popupId}/duplicate":{"post":{"operationId":"duplicatePopupWithStoreId","summary":"Copy a popup as a draft","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Popup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/popups/{popupId}/duplicate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups/{popupId}/duplicate"}},"/v1/store/popups/{popupId}/leads/export":{"get":{"operationId":"exportPopupLeads","summary":"Email signups of a popup as CSV, with consent and the code each got","tags":["popups"],"security":[{"apiKey":[]}],"parameters":[{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/popups/{popupId}/leads/export.","x-store-explicit-path":"/v1/stores/{storeId}/popups/{popupId}/leads/export"}},"/v1/stores/{storeId}/popups/{popupId}/leads/export":{"get":{"operationId":"exportPopupLeadsWithStoreId","summary":"Email signups of a popup as CSV, with consent and the code each got","tags":["popups"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"popupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/popups/{popupId}/leads/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/popups/{popupId}/leads/export"}},"/v1/storefront/stores/{storeId}/popups/events":{"post":{"operationId":"storefrontPopupEvent","summary":"Count a popup impression, close, click or conversion (the storefront proxies it, rate-limited)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"popupId":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"},"variant":{"type":"string","enum":["a","b","c"]},"kind":{"type":"string","enum":["impression","close","click","convert"]}},"required":["popupId","variant","kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/popups/leads":{"post":{"operationId":"storefrontPopupLead","summary":"A visitor's email from a popup, with their consent: returns the popup's code (a unique one per email when set up)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"popupId":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"},"variant":{"type":"string","enum":["a","b","c"]},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"consent":{"type":"boolean"}},"required":["popupId","variant","email","consent"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopupLeadResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/discounts/{discountId}/codes":{"post":{"operationId":"generateDiscountCodes","summary":"Generate unique codes for a discount (prefix, count, uses per code, optional email per code)","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prefix":{"default":"","type":"string","maxLength":16,"pattern":"^[A-Z0-9]*$"},"count":{"type":"integer","minimum":1,"maximum":5000},"length":{"default":8,"type":"integer","minimum":6,"maximum":16},"usesPerCode":{"default":1,"type":"integer","minimum":1,"maximum":1000},"emails":{"default":[],"maxItems":5000,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}},"required":["count"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedCodes"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/discounts/{discountId}/codes.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/codes"},"get":{"operationId":"listDiscountCodes","summary":"A discount's generated codes with their uses","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","unused","used","disabled"]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":40}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","code","uses","email","source","last"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountCodePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/discounts/{discountId}/codes.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/codes"}},"/v1/stores/{storeId}/discounts/{discountId}/codes":{"post":{"operationId":"generateDiscountCodesWithStoreId","summary":"Generate unique codes for a discount (prefix, count, uses per code, optional email per code)","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"prefix":{"default":"","type":"string","maxLength":16,"pattern":"^[A-Z0-9]*$"},"count":{"type":"integer","minimum":1,"maximum":5000},"length":{"default":8,"type":"integer","minimum":6,"maximum":16},"usesPerCode":{"default":1,"type":"integer","minimum":1,"maximum":1000},"emails":{"default":[],"maxItems":5000,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}},"required":["count"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneratedCodes"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/discounts/{discountId}/codes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/codes"},"get":{"operationId":"listDiscountCodesWithStoreId","summary":"A discount's generated codes with their uses","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","unused","used","disabled"]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":40}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","code","uses","email","source","last"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountCodePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/discounts/{discountId}/codes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/codes"}},"/v1/store/discounts/{discountId}/codes/{code}":{"patch":{"operationId":"updateDiscountCode","summary":"Turn one generated code off or on","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"code","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"disabled":{"type":"boolean"}},"required":["disabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountCodeRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as PATCH /v1/stores/{storeId}/discounts/{discountId}/codes/{code}.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/codes/{code}"}},"/v1/stores/{storeId}/discounts/{discountId}/codes/{code}":{"patch":{"operationId":"updateDiscountCodeWithStoreId","summary":"Turn one generated code off or on","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"code","in":"path","required":true,"schema":{"type":"string","minLength":3,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"disabled":{"type":"boolean"}},"required":["disabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountCodeRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of PATCH /v1/store/discounts/{discountId}/codes/{code}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/codes/{code}"}},"/v1/store/discounts/{discountId}/codes/export":{"get":{"operationId":"exportDiscountCodes","summary":"Every generated code as CSV (code, uses, limit, email, status)","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/discounts/{discountId}/codes/export.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/codes/export"}},"/v1/stores/{storeId}/discounts/{discountId}/codes/export":{"get":{"operationId":"exportDiscountCodesWithStoreId","summary":"Every generated code as CSV (code, uses, limit, email, status)","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/discounts/{discountId}/codes/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/codes/export"}},"/v1/store/discounts/{discountId}/report":{"get":{"operationId":"getCouponReport","summary":"Orders, revenue, conversion from entered to paid, top products and why codes did not apply","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/discounts/{discountId}/report.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/report"}},"/v1/stores/{storeId}/discounts/{discountId}/report":{"get":{"operationId":"getCouponReportWithStoreId","summary":"Orders, revenue, conversion from entered to paid, top products and why codes did not apply","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/discounts/{discountId}/report, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/report"}},"/v1/store/discounts/{discountId}/usage":{"get":{"operationId":"listCouponUsage","summary":"The usage log: every time the code was entered, rejected, redeemed or held, newest first (or by `sort`)","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"event","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["entered","rejected","redeemed","held"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"at","type":"string","enum":["at","event","code","email","order","amount"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponUsagePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/discounts/{discountId}/usage.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/usage"}},"/v1/stores/{storeId}/discounts/{discountId}/usage":{"get":{"operationId":"listCouponUsageWithStoreId","summary":"The usage log: every time the code was entered, rejected, redeemed or held, newest first (or by `sort`)","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]},{"type":"null"}]}},{"name":"event","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["entered","rejected","redeemed","held"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"at","type":"string","enum":["at","event","code","email","order","amount"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponUsagePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/discounts/{discountId}/usage, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/usage"}},"/v1/store/discounts/{discountId}/usage/export":{"get":{"operationId":"exportCouponUsage","summary":"The usage log as CSV (up to 20,000 rows)","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/discounts/{discountId}/usage/export.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/{discountId}/usage/export"}},"/v1/stores/{storeId}/discounts/{discountId}/usage/export":{"get":{"operationId":"exportCouponUsageWithStoreId","summary":"The usage log as CSV (up to 20,000 rows)","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"discountId","in":"path","required":true,"schema":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/discounts/{discountId}/usage/export, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/{discountId}/usage/export"}},"/v1/stores/{storeId}/discount-stacking":{"get":{"operationId":"getStackingSettings","summary":"How discounts combine: the policy and every discount's combine, priority and sale-item settings","tags":["discount-stacking"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackingSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"},"put":{"operationId":"saveStackingSettings","summary":"Save the stacking policy and the order discounts apply in","tags":["discount-stacking"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"mode":{"default":"best","type":"string","enum":["best","priority"]},"maxStack":{"default":10,"type":"integer","minimum":1,"maximum":10},"codesWithAutomatic":{"default":true,"type":"boolean"}}},"discounts":{"maxItems":500,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"},"combinable":{"type":"boolean"},"priority":{"type":"integer","minimum":0,"maximum":100},"excludeSaleItems":{"type":"boolean"}},"required":["id","combinable","priority","excludeSaleItems"]}}},"required":["policy","discounts"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackingSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/storefront/stores/{storeId}/apps/stock-alerts":{"post":{"operationId":"storefrontStockAlert","summary":"Back-in-stock alerts: a buyer asks for one email when a sold-out product or option is back (rate-limited)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"variantId":{"anyOf":[{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"website":{"default":"","type":"string","maxLength":200}},"required":["productId","variantId","email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/apps/stock-alerts/stop":{"post":{"operationId":"storefrontStockAlertStop","summary":"Cancel a back-in-stock alert from the link in its email","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{24,64}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontStockAlertStopResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/apps/back_in_stock/alerts":{"get":{"operationId":"getStockAlerts","summary":"Back-in-stock alerts: what buyers wait for, per product and option, and how many alerts went out","tags":["apps"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockAlertSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/storefront/stores/{storeId}/apps/bought-together":{"get":{"operationId":"storefrontBoughtTogether","summary":"Frequently bought together: products paid in the same orders as this one (last 90 days), best first","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"query","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontBoughtTogetherResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/apps/store-stats":{"get":{"operationId":"storefrontStoreStats","summary":"Store stats app: delivered orders, verified reviews and the opening year","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreStats"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/media":{"get":{"operationId":"getMediaLibrary","summary":"Files and images of the store with folders, tags, usage and the plan quota (filters: folder, q, tag, kind, visibility, unused)","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"folder","in":"query","required":false,"schema":{"default":null,"anyOf":[{"anyOf":[{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"string","const":"root"}]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"tag","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":32},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["image","video","audio","pdf","archive","text","file"]},{"type":"null"}]}},{"name":"visibility","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["public","private"]},{"type":"null"}]}},{"name":"unused","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"newest","type":"string","enum":["newest","oldest","name","largest"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaLibrary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/media/usage":{"get":{"operationId":"getMediaUsage","summary":"Storage used and the plan quota","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaUsageSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/media/assets/{assetId}":{"get":{"operationId":"getMediaAsset","summary":"One file with where it is used","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaAsset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"},"patch":{"operationId":"updateMediaAsset","summary":"Rename, alt text, tags, folder, video poster","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":200},"alt":{"type":"string","maxLength":500},"tags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\p{L}\\p{N} _.-]+$"}},"folderId":{"anyOf":[{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"posterAssetId":{"anyOf":[{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaAsset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write"}},"/v1/stores/{storeId}/media/intents":{"post":{"operationId":"createMediaUploadIntent","summary":"A signed, 15-minute upload intent for exactly this type, size and SHA-256 (quota checked first). 413 media-quota-exceeded","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":200},"contentType":{"type":"string","minLength":3,"maxLength":120,"pattern":"^[a-z0-9.+-]+\\/[a-z0-9.+-]+$"},"bytes":{"type":"integer","minimum":1,"maximum":2147483647},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$"},"visibility":{"type":"string","enum":["public","private"]},"folderId":{"anyOf":[{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"tags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\p{L}\\p{N} _.-]+$"}},"replaceAssetId":{"default":null,"anyOf":[{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["filename","contentType","bytes","sha256","visibility","folderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaUploadIntent"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write"}},"/v1/stores/{storeId}/media/intents/{assetId}/finalize":{"post":{"operationId":"finalizeMediaUpload","summary":"Re-check the bytes that arrived (size, hash, real type, malware scan) and add the file to the library","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaAsset"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write"}},"/v1/stores/{storeId}/media/bulk":{"post":{"operationId":"bulkMediaAction","summary":"Move, tag or delete many files. Delete refuses files in use unless force is set (and removes the stored objects)","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"action":{"type":"string","const":"move"},"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"folderId":{"anyOf":[{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["action","ids","folderId"]},{"type":"object","properties":{"action":{"type":"string","const":"tag"},"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"add":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\p{L}\\p{N} _.-]+$"}},"remove":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\p{L}\\p{N} _.-]+$"}}},"required":["action","ids","add","remove"]},{"type":"object","properties":{"action":{"type":"string","const":"delete"},"ids":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"force":{"type":"boolean"}},"required":["action","ids","force"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaBulkResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write"}},"/v1/stores/{storeId}/media/assets/{assetId}/transform":{"post":{"operationId":"createMediaTransform","summary":"A signed, cacheable URL of a public image resized, cropped or converted","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"width":{"anyOf":[{"type":"integer","minimum":16,"maximum":4096},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":16,"maximum":4096},{"type":"null"}]},"fit":{"type":"string","enum":["cover","contain","inside"]},"format":{"type":"string","enum":["webp","avif","jpeg","png"]},"quality":{"type":"integer","minimum":30,"maximum":100},"crop":{"anyOf":[{"type":"object","properties":{"x":{"type":"integer","minimum":0,"maximum":9007199254740991},"y":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"type":"integer","minimum":1,"maximum":9007199254740991},"height":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["x","y","width","height"]},{"type":"null"}]}},"required":["width","height","fit","format","quality","crop"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMediaTransformResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/media/assets/{assetId}/preview":{"post":{"operationId":"createMediaPreviewLink","summary":"A 10-minute signed link to view or download a file (private files included)","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaLink"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/media/assets/{assetId}/order-link":{"post":{"operationId":"createMediaOrderLink","summary":"A download link for a private file signed for one paid order (stops working if the order is refunded)","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},"hours":{"default":72,"type":"integer","minimum":1,"maximum":720}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaLink"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/stores/{storeId}/media/folders":{"post":{"operationId":"createMediaFolder","summary":"New folder","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"parentId":{"anyOf":[{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["name","parentId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaFolder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write"}},"/v1/stores/{storeId}/media/folders/{folderId}":{"patch":{"operationId":"renameMediaFolder","summary":"Rename a folder","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"folderId","in":"path","required":true,"schema":{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaFolder"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write"},"delete":{"operationId":"deleteMediaFolder","summary":"Delete a folder; its files and subfolders move to the parent","tags":["media"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"folderId","in":"path","required":true,"schema":{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write"}},"/v1/stores/{storeId}/ai-builder/limits":{"get":{"operationId":"getBuilderLimits","summary":"Runs left this hour, today's spend against the cost guard, and which model answers","tags":["ai-builder"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuilderLimits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/stores/{storeId}/ai-builder/runs":{"get":{"operationId":"listBuilderRuns","summary":"Recent builder runs, newest first","tags":["ai-builder"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBuilderRunsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"},"post":{"operationId":"streamBuilderRun","summary":"Describe the store; streams progress events (text/event-stream) and ends with the proposed patches. 429 when over the rate limit or budget","tags":["ai-builder"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","minLength":12,"maxLength":2000},"language":{"default":"en","type":"string","pattern":"^[a-z]{2}$"}},"required":["description"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuilderRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/ai-builder/runs/{runId}":{"get":{"operationId":"getBuilderRun","summary":"One run with its patches","tags":["ai-builder"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"runId","in":"path","required":true,"schema":{"type":"string","pattern":"^aib_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuilderRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read"}},"/v1/stores/{storeId}/ai-builder/runs/{runId}/apply":{"post":{"operationId":"applyBuilderRun","summary":"Apply the accepted patches (theme draft, draft products, policy pages, navigation) in one transaction","tags":["ai-builder"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"runId","in":"path","required":true,"schema":{"type":"string","pattern":"^aib_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accept":{"minItems":1,"maxItems":60,"type":"array","items":{"type":"string","pattern":"^p[0-9]{1,3}$"}}},"required":["accept"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuilderRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/stores/{storeId}/ai-builder/runs/{runId}/undo":{"post":{"operationId":"undoBuilderRun","summary":"Undo an applied run: restore the theme draft, delete the draft products and restore the pages it changed","tags":["ai-builder"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"runId","in":"path","required":true,"schema":{"type":"string","pattern":"^aib_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuilderRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write"}},"/v1/store/themes/{themeId}/ai/copy":{"post":{"operationId":"rewriteSectionCopy","summary":"Regenerate a section's copy, rewrite it in the seller's tone, or translate it. Returns validated ops to preview","tags":["themes"],"security":[{"apiKey":[]}],"parameters":[{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["regenerate","tone","translate"]},"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"file":{"type":"string","maxLength":120},"section":{"type":"string","maxLength":48},"tone":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"language":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z]{2}$"},{"type":"null"}]},"hint":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]}},"required":["action","baseRevision","file","section"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAiProposal"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/themes/{themeId}/ai/copy.","x-store-explicit-path":"/v1/stores/{storeId}/themes/{themeId}/ai/copy"}},"/v1/stores/{storeId}/themes/{themeId}/ai/copy":{"post":{"operationId":"rewriteSectionCopyWithStoreId","summary":"Regenerate a section's copy, rewrite it in the seller's tone, or translate it. Returns validated ops to preview","tags":["themes"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"themeId","in":"path","required":true,"schema":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["regenerate","tone","translate"]},"baseRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"file":{"type":"string","maxLength":120},"section":{"type":"string","maxLength":48},"tone":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"language":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z]{2}$"},{"type":"null"}]},"hint":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]}},"required":["action","baseRevision","file","section"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeAiProposal"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/themes/{themeId}/ai/copy, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/themes/{themeId}/ai/copy"}},"/v1/licenses/validate":{"post":{"operationId":"validateLicense","summary":"Validate a license key for a product (signed answer: valid, expired, revoked, hwid_mismatch, paused or invalid)","tags":["licenses"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":200},"product":{"type":"string","pattern":"^pk_[0-9a-hjkmnp-tv-z]{32}$"},"hwid":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":256},{"type":"null"}]},"nonce":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"},{"type":"null"}]},"deviceName":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]}},"required":["key","product"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseValidateResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/products/{productId}/licensing":{"get":{"operationId":"getProductLicensing","summary":"A product’s licensing: API keys, device binding, expiry clock, auto-pause and linked status","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLicensing"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/licensing.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/licensing"},"put":{"operationId":"saveProductLicensing","summary":"Save a product’s licensing settings (turning the API on mints its keys)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"apiEnabled":{"default":false,"type":"boolean"},"clock":{"default":"purchase","type":"string","enum":["purchase","activation"]},"hwid":{"default":{},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"maxDevices":{"default":1,"type":"integer","minimum":1,"maximum":50},"buyerResetsPer30d":{"default":2,"type":"integer","minimum":0,"maximum":30},"resetCooldownHours":{"default":24,"type":"integer","minimum":0,"maximum":720}}},"autoPause":{"default":{},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"when":{"default":"outage","type":"string","enum":["outage","degraded","not_live"]},"storefront":{"default":"show_disabled","type":"string","enum":["show_disabled","hide"]},"blockValidation":{"default":true,"type":"boolean"},"compensate":{"default":true,"type":"boolean"},"notifyBuyers":{"default":true,"type":"boolean"}}},"extendEnabled":{"default":true,"type":"boolean"},"metadata":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z0-9_.-]{1,40}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":500},{"type":"number"},{"type":"boolean"}]}},"rateLimitPerMinute":{"default":60,"type":"integer","minimum":10,"maximum":600}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLicensing"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/licensing.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/licensing"}},"/v1/stores/{storeId}/products/{productId}/licensing":{"get":{"operationId":"getProductLicensingWithStoreId","summary":"A product’s licensing: API keys, device binding, expiry clock, auto-pause and linked status","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLicensing"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/licensing, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/licensing"},"put":{"operationId":"saveProductLicensingWithStoreId","summary":"Save a product’s licensing settings (turning the API on mints its keys)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"apiEnabled":{"default":false,"type":"boolean"},"clock":{"default":"purchase","type":"string","enum":["purchase","activation"]},"hwid":{"default":{},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"maxDevices":{"default":1,"type":"integer","minimum":1,"maximum":50},"buyerResetsPer30d":{"default":2,"type":"integer","minimum":0,"maximum":30},"resetCooldownHours":{"default":24,"type":"integer","minimum":0,"maximum":720}}},"autoPause":{"default":{},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"when":{"default":"outage","type":"string","enum":["outage","degraded","not_live"]},"storefront":{"default":"show_disabled","type":"string","enum":["show_disabled","hide"]},"blockValidation":{"default":true,"type":"boolean"},"compensate":{"default":true,"type":"boolean"},"notifyBuyers":{"default":true,"type":"boolean"}}},"extendEnabled":{"default":true,"type":"boolean"},"metadata":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z0-9_.-]{1,40}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":500},{"type":"number"},{"type":"boolean"}]}},"rateLimitPerMinute":{"default":60,"type":"integer","minimum":10,"maximum":600}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLicensing"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/licensing, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/licensing"}},"/v1/store/products/{productId}/licensing/rotate":{"post":{"operationId":"rotateLicenseKeys","summary":"Replace the product’s publishable key or its signing key (old ones stop working at once)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"which":{"type":"string","enum":["publishable","signing"]}},"required":["which"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLicensing"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/licensing/rotate.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/licensing/rotate"}},"/v1/stores/{storeId}/products/{productId}/licensing/rotate":{"post":{"operationId":"rotateLicenseKeysWithStoreId","summary":"Replace the product’s publishable key or its signing key (old ones stop working at once)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"which":{"type":"string","enum":["publishable","signing"]}},"required":["which"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductLicensing"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/licensing/rotate, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/licensing/rotate"}},"/v1/store/licenses":{"get":{"operationId":"listLicenses","summary":"Sold keys with their state, devices and expiry. `q` matches an exact key, an email, an order number or a key id","tags":["licenses"],"security":[{"apiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","expiring","expired","not_started","revoked","suspended"]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"sold","type":"string","enum":["sold","product","buyer","state","left","devices","seen"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/licenses.","x-store-explicit-path":"/v1/stores/{storeId}/licenses"}},"/v1/stores/{storeId}/licenses":{"get":{"operationId":"listLicensesWithStoreId","summary":"Sold keys with their state, devices and expiry. `q` matches an exact key, an email, an order number or a key id","tags":["licenses"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","expiring","expired","not_started","revoked","suspended"]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"sold","type":"string","enum":["sold","product","buyer","state","left","devices","seen"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/licenses, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/licenses"}},"/v1/store/licenses/{licenseId}":{"get":{"operationId":"getLicense","summary":"One key: devices, history and limits","tags":["licenses"],"security":[{"apiKey":[]}],"parameters":[{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/licenses/{licenseId}.","x-store-explicit-path":"/v1/stores/{storeId}/licenses/{licenseId}"}},"/v1/stores/{storeId}/licenses/{licenseId}":{"get":{"operationId":"getLicenseWithStoreId","summary":"One key: devices, history and limits","tags":["licenses"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/licenses/{licenseId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/licenses/{licenseId}"}},"/v1/store/licenses/{licenseId}/actions":{"post":{"operationId":"licenseAction","summary":"Revoke, restore, suspend, resume, add time, start the clock, release or reset devices, or change the device limit","tags":["licenses"],"security":[{"apiKey":[]}],"parameters":[{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"revoke"},"reason":{"default":"","type":"string","maxLength":200}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"restore"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"suspend"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"resume"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"add_time"},"hours":{"type":"integer","minimum":-87600,"maximum":87600}},"required":["kind","hours"]},{"type":"object","properties":{"kind":{"type":"string","const":"start_clock"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"release_device"},"activationId":{"type":"string","pattern":"^lact_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","activationId"]},{"type":"object","properties":{"kind":{"type":"string","const":"reset_devices"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"set_max_devices"},"max":{"anyOf":[{"type":"integer","minimum":1,"maximum":50},{"type":"null"}]}},"required":["kind","max"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/licenses/{licenseId}/actions.","x-store-explicit-path":"/v1/stores/{storeId}/licenses/{licenseId}/actions"}},"/v1/stores/{storeId}/licenses/{licenseId}/actions":{"post":{"operationId":"licenseActionWithStoreId","summary":"Revoke, restore, suspend, resume, add time, start the clock, release or reset devices, or change the device limit","tags":["licenses"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"revoke"},"reason":{"default":"","type":"string","maxLength":200}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"restore"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"suspend"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"resume"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"add_time"},"hours":{"type":"integer","minimum":-87600,"maximum":87600}},"required":["kind","hours"]},{"type":"object","properties":{"kind":{"type":"string","const":"start_clock"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"release_device"},"activationId":{"type":"string","pattern":"^lact_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["kind","activationId"]},{"type":"object","properties":{"kind":{"type":"string","const":"reset_devices"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"set_max_devices"},"max":{"anyOf":[{"type":"integer","minimum":1,"maximum":50},{"type":"null"}]}},"required":["kind","max"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/licenses/{licenseId}/actions, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/licenses/{licenseId}/actions"}},"/v1/store/sales-pauses":{"get":{"operationId":"listSalesPauses","summary":"Sales paused by linked status (open and past), with the downtime credited to keys","tags":["sales-pauses"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSalesPausesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/sales-pauses.","x-store-explicit-path":"/v1/stores/{storeId}/sales-pauses"}},"/v1/stores/{storeId}/sales-pauses":{"get":{"operationId":"listSalesPausesWithStoreId","summary":"Sales paused by linked status (open and past), with the downtime credited to keys","tags":["sales-pauses"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSalesPausesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/sales-pauses, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/sales-pauses"}},"/v1/storefront/stores/{storeId}/licenses":{"post":{"operationId":"buyerLicenses","summary":"The buyer’s keys with their state, countdown, devices and extend options (order access link or signed-in account)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerLicenses"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/licenses/{licenseId}/reset":{"post":{"operationId":"buyerResetDevices","summary":"Release the devices bound to one of the buyer’s keys (within the seller’s reset limits)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerLicense"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/licenses/{licenseId}/extend":{"post":{"operationId":"buyerExtendLicense","summary":"Start a checkout that adds an option’s time to the same key","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]},"variantId":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},"amountMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"withdrawalWaiver":{"default":false,"type":"boolean"}},"required":["proof","variantId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseExtendStart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/discord/shop":{"get":{"operationId":"getDiscordShop","summary":"/buy in the server and Discord DMs: settings, Discord checkouts, DM delivery log and subscriber counts","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordShopOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"},"put":{"operationId":"saveDiscordShop","summary":"Turn /buy on or off, hide products from it, and set purchase DMs, quiet hours and the daily DM cap","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"buyEnabled":{"default":true,"type":"boolean"},"hiddenProductIds":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"deliveryDm":{"default":true,"type":"boolean"},"quietHours":{"default":{"enabled":true,"start":1320,"end":480},"type":"object","properties":{"enabled":{"type":"boolean"},"start":{"type":"integer","minimum":0,"maximum":1439},"end":{"type":"integer","minimum":0,"maximum":1439}},"required":["enabled","start","end"]},"dailyCap":{"default":2,"type":"integer","minimum":1,"maximum":10}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordShopOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/shop/checkouts":{"get":{"operationId":"listDiscordCheckouts","summary":"Every Pay press after /buy, newest first (or by buyer, item, price or status), and the order it became","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["open","opened","paid","expired"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","buyer","item","price","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDiscordCheckoutsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"}},"/v1/stores/{storeId}/discord/shop/dms":{"get":{"operationId":"listDiscordDms","summary":"Purchase and reminder DMs, newest first (or by recipient, subject or status). Keys are never stored here","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["queued","sent","simulated","skipped","failed"]},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["delivery","flow","test"]},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","to","about","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDiscordDmsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"}},"/v1/storefront/stores/{storeId}/discord/checkouts/claim":{"post":{"operationId":"claimDiscordCheckout","summary":"Open a /buy link: returns the cart bound to the Discord account that pressed Pay (the same cart on every open)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":600}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordCheckoutClaim"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/checkouts/cart/{cartId}":{"get":{"operationId":"discordCheckoutOfCart","summary":"The Discord account a cart is bound to (checkout shows it), or null","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordCheckoutOfCartResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/dm-preference":{"post":{"operationId":"getDmPreference","summary":"Read the Discord DM preference behind a signed unsubscribe link","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":600}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DmPreference"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/discord/dm-preference/set":{"post":{"operationId":"setDmPreference","summary":"Turn reminder DMs from this store on or off for the Discord account in a signed link","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":600},"subscribed":{"type":"boolean"}},"required":["token","subscribed"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DmPreference"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/refunds/credit":{"get":{"operationId":"getCreditRefunds","summary":"Refunds as store credit: settings, revenue kept in the store, bonus cost, offers and outstanding credit","tags":["refunds"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"default":"90","type":"string","enum":["30","90","365"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditRefundsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read"},"put":{"operationId":"saveCreditRefunds","summary":"Turn credit refunds on, set the bonus (0–25 %), the default and how long buyers have to choose","tags":["refunds"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"bonusBps":{"default":1000,"type":"integer","minimum":0,"maximum":2500},"mode":{"default":"offered","type":"string","enum":["offered","default"]},"offerDays":{"default":7,"type":"integer","minimum":1,"maximum":30}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditRefundsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write"}},"/v1/store/orders/{orderId}/refund-offer":{"get":{"operationId":"getOrderRefundOffer","summary":"The order’s open (or latest) refund offer and the store’s credit refund settings","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRefundOffers"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/orders/{orderId}/refund-offer.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/refund-offer"},"post":{"operationId":"createRefundOffer","summary":"Offer the buyer a refund they take as store credit with the bonus or as money back (emailed; shown on their order page)","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["amountMinor","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRefundOffers"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/refund-offer.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/refund-offer"}},"/v1/stores/{storeId}/orders/{orderId}/refund-offer":{"get":{"operationId":"getOrderRefundOfferWithStoreId","summary":"The order’s open (or latest) refund offer and the store’s credit refund settings","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRefundOffers"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/orders/{orderId}/refund-offer, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/refund-offer"},"post":{"operationId":"createRefundOfferWithStoreId","summary":"Offer the buyer a refund they take as store credit with the bonus or as money back (emailed; shown on their order page)","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["amountMinor","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRefundOffers"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/refund-offer, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/refund-offer"}},"/v1/store/orders/{orderId}/refund-offer/{offerId}/cancel":{"post":{"operationId":"cancelRefundOffer","summary":"Withdraw an offer the buyer has not answered","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rfo_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRefundOffers"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/refund-offer/{offerId}/cancel.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/refund-offer/{offerId}/cancel"}},"/v1/stores/{storeId}/orders/{orderId}/refund-offer/{offerId}/cancel":{"post":{"operationId":"cancelRefundOfferWithStoreId","summary":"Withdraw an offer the buyer has not answered","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rfo_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRefundOffers"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/refund-offer/{offerId}/cancel, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/refund-offer/{offerId}/cancel"}},"/v1/storefront/stores/{storeId}/refund-offer":{"post":{"operationId":"buyerRefundOffer","summary":"The refund offer on an order (order access link), or null","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"type":"object","properties":{"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["sessionId","access"]}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerRefundOfferResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/refund-offer/{offerId}/choose":{"post":{"operationId":"chooseRefundOffer","summary":"Take the refund as store credit with the bonus (instant) or as money back to the payment method","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rfo_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"type":"object","properties":{"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["sessionId","access"]},"choice":{"type":"string","enum":["credit","original"]}},"required":["proof","choice"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChooseRefundOfferResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/discord/tickets":{"get":{"operationId":"getDiscordTickets","summary":"Tickets in Discord: settings, the server's channels and roles, the posted panel and open ticket count","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordTicketsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:read"},"put":{"operationId":"saveDiscordTickets","summary":"Turn Discord tickets on or off and set the panel channel, staff roles, topics and limits","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"channelId":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"staffRoleIds":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","pattern":"^\\d{17,20}$"}},"topics":{"default":[{"id":"order","label":"An order","emoji":"📦","hint":"Your order number and what went wrong"},{"id":"billing","label":"Billing and payouts","emoji":"💳","hint":"What you were charged or paid, and when"},{"id":"technical","label":"Something is broken","emoji":"🛠️","hint":"What you did, what you expected, what happened"},{"id":"other","label":"Something else","emoji":"💬","hint":""}],"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"label":{"type":"string","minLength":1,"maxLength":80},"emoji":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":16},{"type":"null"}]},"hint":{"default":"","type":"string","maxLength":100}},"required":["id","label"]}},"panelTitle":{"default":"Need a hand?","type":"string","minLength":1,"maxLength":100},"panelText":{"default":"Pick what it is about and tell us in a few words. A private thread opens with you and our team; only you and staff can see it.","type":"string","maxLength":1000},"maxOpenPerMember":{"default":1,"type":"integer","minimum":1,"maximum":5},"logChannelId":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]},"closeOnSolve":{"default":true,"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordTicketsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/stores/{storeId}/discord/tickets/panel":{"post":{"operationId":"postDiscordTicketPanel","summary":"Post the ticket panel in the chosen channel, or rewrite the posted one with the current settings","tags":["discord"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscordTicketsOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"discord:write"}},"/v1/admin/desk/tickets":{"get":{"operationId":"listDeskTickets","summary":"ShopFast support desk: tickets in a view, newest activity first, with the count of every view","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"view","in":"query","required":false,"schema":{"default":"open","type":"string","enum":["open","mine","unassigned","pending","breached","solved","all"]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskTicketList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"openDeskTicket","summary":"Owner or support: open a ticket for a seller (by their account email); they are emailed and see it in the dashboard","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"topic":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"subject":{"type":"string","minLength":3,"maxLength":200},"body":{"type":"string","minLength":1,"maxLength":10000}},"required":["email","topic","subject","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/tickets/{ticketId}":{"get":{"operationId":"getDeskTicket","summary":"One desk ticket: messages, notes, timeline and who the seller is on ShopFast (marks it seen)","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"patch":{"operationId":"updateDeskTicket","summary":"Owner or support: status, priority, assignee, tags, topic or subject","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["open","pending","on_hold","solved","closed"]},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"assigneeId":{"anyOf":[{"type":"string","pattern":"^adm_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[\\w -]+$"}},"topic":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"subject":{"type":"string","minLength":1,"maxLength":200}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/tickets/{ticketId}/messages":{"post":{"operationId":"replyDeskTicket","summary":"Owner or support: reply (dashboard, email and the Discord thread) or add an internal note","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000},"internal":{"type":"boolean"},"status":{"anyOf":[{"type":"string","enum":["open","pending","on_hold","solved","closed"]},{"type":"null"}]},"attachmentIds":{"default":[],"maxItems":5,"type":"array","items":{"type":"string","pattern":"^dta_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["body","internal","status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/attachments":{"post":{"operationId":"startDeskAgentAttachment","summary":"Owner or support: a signed upload link for a file on a reply","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":160},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf","text/plain","application/zip"]},"bytes":{"type":"integer","minimum":1,"maximum":26214400}},"required":["filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartedDeskAttachment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/attachments/{attachmentId}/complete":{"post":{"operationId":"completeDeskAgentAttachment","summary":"Owner or support: check the uploaded file and make it usable","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^dta_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskAttachment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/canned":{"get":{"operationId":"listDeskCanned","summary":"Saved replies for the desk","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeskCannedResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"createDeskCanned","summary":"Owner or support: add a saved reply","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"shortcut":{"default":"","type":"string","maxLength":24,"pattern":"^[a-z0-9-]*$"},"body":{"type":"string","minLength":1,"maxLength":5000}},"required":["name","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskCanned"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/canned/{cannedId}":{"put":{"operationId":"updateDeskCanned","summary":"Owner or support: change a saved reply","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^dcr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"shortcut":{"default":"","type":"string","maxLength":24,"pattern":"^[a-z0-9-]*$"},"body":{"type":"string","minLength":1,"maxLength":5000}},"required":["name","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskCanned"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"delete":{"operationId":"deleteDeskCanned","summary":"Owner or support: delete a saved reply","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"cannedId","in":"path","required":true,"schema":{"type":"string","pattern":"^dcr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDeskCannedResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/me":{"get":{"operationId":"getDeskMe","summary":"Your @username on the desk (sellers never see your real name) and your linked Discord","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskMe"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"saveDeskMe","summary":"Pick or change your @username on the desk; your earlier replies show it too","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","pattern":"^[a-z0-9][a-z0-9._-]{1,23}$"}},"required":["handle"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskMe"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/settings":{"get":{"operationId":"getDeskSettings","summary":"Desk settings: topics, targets, rotation, auto-close, ratings, the first answer","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"saveDeskSettings","summary":"Owner or support: change the desk settings","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"topics":{"default":[{"id":"account","label":"Account and sign-in","emoji":"🔐","hint":"Your account email and what happens when you sign in","priority":"high"},{"id":"payouts","label":"Payouts and ShopFast Pay","emoji":"💸","hint":"Which payout, the amount and what you expected","priority":"high"},{"id":"billing","label":"Plans and billing","emoji":"🧾","hint":"Your plan, the invoice and what looks wrong","priority":"normal"},{"id":"store","label":"Store setup and domains","emoji":"🏪","hint":"Your store address and the step you are stuck on","priority":"normal"},{"id":"bots","label":"Discord and Telegram bots","emoji":"🤖","hint":"The server or bot, the command and what it answered","priority":"normal"},{"id":"api","label":"API and developers","emoji":"🧩","hint":"The endpoint, the request id and the response","priority":"normal"},{"id":"problem","label":"Report a problem","emoji":"🚨","hint":"What broke, where, and since when","priority":"urgent"},{"id":"other","label":"Something else","emoji":"💬","hint":"Tell us in a few words","priority":"low"}],"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"label":{"type":"string","minLength":1,"maxLength":80},"emoji":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":16},{"type":"null"}]},"hint":{"default":"","type":"string","maxLength":100},"priority":{"default":"normal","type":"string","enum":["low","normal","high","urgent"]}},"required":["id","label"]}},"firstResponse":{"default":{"low":1440,"normal":480,"high":120,"urgent":30},"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"]},"resolution":{"default":{"low":10080,"normal":4320,"high":1440,"urgent":240},"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"]},"autoAssign":{"default":"round_robin","type":"string","enum":["round_robin","off"]},"rotation":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^adm_[0-9a-hjkmnp-tv-z]{20}$"}},"autoCloseDays":{"default":3,"type":"integer","minimum":1,"maximum":30},"csat":{"default":true,"type":"boolean"},"acknowledgement":{"default":"Thanks for reaching out. A ShopFast teammate will reply here; we usually answer within {target}.","type":"string","maxLength":500},"maxOpenPerRequester":{"default":3,"type":"integer","minimum":1,"maximum":10}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/desk/stats":{"get":{"operationId":"deskStats","summary":"Desk numbers: volume, reply and solve times, targets met, ratings, per channel, topic and teammate","tags":["admin desk"],"security":[{"adminSession":[]}],"parameters":[{"name":"days","in":"query","required":false,"schema":{"default":"30","type":"string","enum":["7","30","90"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskStats"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/support":{"get":{"operationId":"myDesk","summary":"Your requests to ShopFast support, the topics and your stores","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyDeskOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"openMyDeskTicket","summary":"Ask ShopFast support for help (about your account or one of your stores)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"subject":{"type":"string","minLength":3,"maxLength":200},"body":{"type":"string","minLength":10,"maxLength":10000},"storeId":{"default":null,"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"attachmentIds":{"default":[],"maxItems":5,"type":"array","items":{"type":"string","pattern":"^dta_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["topic","subject","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyDeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/support/{ticketId}":{"get":{"operationId":"getMyDeskTicket","summary":"One of your requests to ShopFast support (marks the replies read)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyDeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/support/{ticketId}/messages":{"post":{"operationId":"replyMyDeskTicket","summary":"Reply on your request (reopens it when it was solved)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000},"attachmentIds":{"default":[],"maxItems":5,"type":"array","items":{"type":"string","pattern":"^dta_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyDeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/support/{ticketId}/close":{"post":{"operationId":"closeMyDeskTicket","summary":"Mark your request solved","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyDeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/support/{ticketId}/rating":{"post":{"operationId":"rateMyDeskTicket","summary":"Rate how ShopFast handled a solved request (1–5)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rating":{"type":"integer","minimum":1,"maximum":5},"comment":{"default":"","type":"string","maxLength":1000}},"required":["rating"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyDeskTicketDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/support/attachments":{"post":{"operationId":"startMyDeskAttachment","summary":"A signed upload link for a file on your request","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":160},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf","text/plain","application/zip"]},"bytes":{"type":"integer","minimum":1,"maximum":26214400}},"required":["filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartedDeskAttachment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/support/attachments/{attachmentId}/complete":{"post":{"operationId":"completeMyDeskAttachment","summary":"Check your uploaded file and make it usable","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^dta_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeskAttachment"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community":{"get":{"operationId":"getCommunity","summary":"ShopFast's Discord server: connection, bot health, setup state, panel, automations, counts and recent runs","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityServerOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/connect":{"post":{"operationId":"connectCommunity","summary":"Owner: where to add the ShopFast bot to ShopFast's server (with Administrator, for the setup)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"redirectUri":{"type":"string","format":"uri"}},"required":["redirectUri"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectCommunityResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/connect/complete":{"post":{"operationId":"completeCommunityConnect","summary":"Owner: finish adding the bot (Discord's code, state and server id)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","minLength":1,"maxLength":600},"guildId":{"type":"string","pattern":"^\\d{17,20}$"},"redirectUri":{"type":"string","format":"uri"}},"required":["code","state","guildId","redirectUri"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityServerOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/disconnect":{"post":{"operationId":"disconnectCommunity","summary":"Owner: forget the server (the bot stays in it until removed in Discord)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityServerOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/setup":{"get":{"operationId":"planCommunitySetup","summary":"What the setup would change in the server now (read from Discord, nothing applied)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityPlan"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"applyCommunitySetup","summary":"Owner: apply the setup (branding, roles, channels, AutoMod, onboarding, posts and the ticket panel) in the background","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/runs/{runId}":{"get":{"operationId":"getCommunityRun","summary":"A setup, check or sync run with its progress","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"runId","in":"path","required":true,"schema":{"type":"string","pattern":"^crun_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/settings":{"put":{"operationId":"saveCommunitySettings","summary":"Owner or support: automations, the channels and roles they use, ticket staff roles","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"automations":{"default":{"announcements":true,"incidents":true,"sellerRoles":true,"planRoles":true,"slaAlerts":true,"driftCheck":true,"alertsDigest":true,"ticketLog":true},"type":"object","properties":{"announcements":{"default":true,"type":"boolean"},"incidents":{"default":true,"type":"boolean"},"sellerRoles":{"default":true,"type":"boolean"},"planRoles":{"default":true,"type":"boolean"},"slaAlerts":{"default":true,"type":"boolean"},"driftCheck":{"default":true,"type":"boolean"},"alertsDigest":{"default":true,"type":"boolean"},"ticketLog":{"default":true,"type":"boolean"}}},"verification":{"default":{"minAccountAgeDays":7},"type":"object","properties":{"minAccountAgeDays":{"default":7,"type":"integer","minimum":0,"maximum":365}}},"channels":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["welcome","rules","announcements","status","changelog","general","openTicket","ticketLog","modLog","alerts"]},"additionalProperties":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]}},"roles":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["founder","admin","staff","support","moderator","partner","developer","seller","verifiedSeller","member"]},"additionalProperties":{"anyOf":[{"type":"string","pattern":"^\\d{17,20}$"},{"type":"null"}]}},"planRoles":{"default":{},"type":"object","propertyNames":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},"additionalProperties":{"type":"string","pattern":"^\\d{17,20}$"}},"ticketStaffRoleIds":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","pattern":"^\\d{17,20}$"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityServerOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/panel":{"post":{"operationId":"postCommunityPanel","summary":"Owner or support: post the ticket panel in #open-a-ticket, or rewrite it with the desk's current topics","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityServerOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/members":{"get":{"operationId":"listCommunityMembers","summary":"Sellers who linked their Discord: roles ShopFast gives them and whether they are in the server, filtered and sorted by any column","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","joined","not_joined","unknown","sync_error"]}},{"name":"sort","in":"query","required":false,"schema":{"default":"linked","type":"string","enum":["seller","discord","linked","joined","roles","stores","synced"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommunityMembersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/members/{userId}/sync":{"post":{"operationId":"syncCommunityMember","summary":"Owner or support: give a linked seller their roles now","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedSeller"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/roles/sync":{"post":{"operationId":"syncCommunityRoles","summary":"Owner or support: re-sync every linked seller's roles in the background","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/roles/cleanup":{"post":{"operationId":"cleanCommunityRoles","summary":"Owner: fix roles members picked for themselves (Member follows verification; Partner, Developer, Seller and Verified seller follow staff and ShopFast), in the background","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRun"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/moderation":{"get":{"operationId":"listCommunityModeration","summary":"AutoMod hits and moderation actions (newest first by default), searched, filtered by action and sorted by any column","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"show","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","automod","timeouts","removals","reversals","deleted"]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["when","action","member","what","by"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommunityModerationResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"moderateCommunityMember","summary":"Owner or support: time out, kick or ban a member (with a reason, in the audit log)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"discordUserId":{"type":"string","pattern":"^\\d{17,20}$"},"action":{"type":"string","enum":["timeout","untimeout","kick","ban","unban"]},"minutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":40320},{"type":"null"}]},"reason":{"type":"string","minLength":3,"maxLength":400}},"required":["discordUserId","action","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityModEvent"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/posts":{"get":{"operationId":"listCommunityPosts","summary":"Posts the bot made or will make (composer, mirrored announcements, incidents, digests), searched, filtered by status, source and channel and sorted by any column","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"status","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","scheduled","posted","failed","withdrawn"]}},{"name":"source","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["composer","announcement","incident","digest","drift","sla","seed"]},{"type":"null"}]}},{"name":"channel","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["post","source","channel","status","when"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityPostPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"createCommunityPost","summary":"Owner or support: post (or schedule) an announcement, changelog or status update with a banner","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","enum":["announcements","changelog","status","general","welcome"]},"title":{"type":"string","minLength":1,"maxLength":256},"body":{"type":"string","minLength":1,"maxLength":4000},"banner":{"default":"none","type":"string","enum":["none","launch","update","changelog","maintenance","incident","resolved","tips","welcome","rules","tickets"]},"buttons":{"default":[],"maxItems":3,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":80},"url":{"type":"string","format":"uri"}},"required":["label","url"]}},"ping":{"default":"none","type":"string","enum":["none","sellers","everyone"]},"crosspost":{"default":true,"type":"boolean"},"scheduleAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["channel","title","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityPost"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/posts/{postId}/withdraw":{"post":{"operationId":"withdrawCommunityPost","summary":"Owner or support: delete a posted message, or cancel a scheduled one","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string","pattern":"^cpst_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityPost"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/incidents":{"get":{"operationId":"listCommunityIncidents","summary":"Incidents and maintenance posted in #status: open or past ones, searched, filtered by impact and sorted by any column (newest first by default)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","open","past"]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"impact","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["minor","major","critical","maintenance"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["incident","impact","when","lasted"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommunityIncidentsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"createCommunityIncident","summary":"Owner or support: start an incident or maintenance (posted in #status with a thread for updates)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":3,"maxLength":200},"impact":{"type":"string","enum":["minor","major","critical","maintenance"]},"status":{"type":"string","enum":["investigating","identified","monitoring","resolved","scheduled","in_progress","completed"]},"components":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"body":{"type":"string","minLength":3,"maxLength":2000}},"required":["title","impact","status","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityIncident"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/incidents/{incidentId}/updates":{"post":{"operationId":"updateCommunityIncident","summary":"Owner or support: post an update; resolved or completed ends it","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"incidentId","in":"path","required":true,"schema":{"type":"string","pattern":"^cinc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["investigating","identified","monitoring","resolved","scheduled","in_progress","completed"]},"body":{"type":"string","minLength":3,"maxLength":2000}},"required":["status","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityIncident"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/me/link":{"post":{"operationId":"linkAdminDiscord","summary":"Where to approve ShopFast in Discord so your account is known in ShopFast's server","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"redirectUri":{"type":"string","format":"uri"}},"required":["redirectUri"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkAdminDiscordResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/me/link/complete":{"post":{"operationId":"completeAdminDiscordLink","summary":"Finish linking your Discord (Discord's code and state)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","minLength":1,"maxLength":600},"redirectUri":{"type":"string","format":"uri"}},"required":["code","state","redirectUri"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityServerOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/me":{"delete":{"operationId":"unlinkAdminDiscord","summary":"Unlink your Discord","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityServerOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/backup":{"get":{"operationId":"getCommunityBackup","summary":"Verified members: how many ShopFast could add back to a server, when the grants were last checked, and the latest move","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityBackup"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/verified":{"get":{"operationId":"listCommunityVerified","summary":"Verified members and linked sellers (newest first by default): grant, account age, whether they are in the server, filtered and sorted by any column","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","working","dead","left"]}},{"name":"source","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","verified","seller"]}},{"name":"sort","in":"query","required":false,"schema":{"default":"verified","type":"string","enum":["member","verified","age","grant","server","network"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommunityVerifiedResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/verified/{discordUserId}/revoke":{"post":{"operationId":"revokeCommunityVerified","summary":"Owner or support: delete a member's grant (revoked with Discord too) and take the Member role back (in the audit log)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"discordUserId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{17,20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":400}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeCommunityVerifiedResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/restore/check":{"post":{"operationId":"checkCommunityRestore","summary":"Owner: read a server before moving members there (the bot must be in it with Create Invite and Manage Roles)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"guildId":{"type":"string","pattern":"^\\d{17,20}$"}},"required":["guildId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRestoreTarget"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/restore":{"post":{"operationId":"startCommunityRestore","summary":"Owner: add every verified member with a working grant to a server in the background (optionally making it ShopFast's server); in the audit log","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"guildId":{"type":"string","pattern":"^\\d{17,20}$"},"switchServer":{"default":false,"type":"boolean"}},"required":["guildId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRestore"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/restore/{restoreId}":{"get":{"operationId":"getCommunityRestore","summary":"A move with its progress and counts","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"restoreId","in":"path","required":true,"schema":{"type":"string","pattern":"^crst_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRestore"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/restore/{restoreId}/cancel":{"post":{"operationId":"cancelCommunityRestore","summary":"Owner: stop a move (members already added stay)","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"restoreId","in":"path","required":true,"schema":{"type":"string","pattern":"^crst_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityRestore"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/community/restore/{restoreId}/result":{"get":{"operationId":"getCommunityRestoreResult","summary":"Owner: a move's result per member, as CSV","tags":["admin community"],"security":[{"adminSession":[]}],"parameters":[{"name":"restoreId","in":"path","required":true,"schema":{"type":"string","pattern":"^crst_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommunityRestoreResultResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/community/verify/withdraw":{"post":{"operationId":"withdrawCommunityVerification","summary":"Withdraw a verification from the success page (its one-hour token): ShopFast deletes the grant, revokes it with Discord and takes the Member role back","tags":["community"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":10,"maxLength":400}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawCommunityVerificationResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/status":{"get":{"operationId":"getPlatformStatus","summary":"ShopFast's status: each part of the platform now and over 90 days, current and past incidents, planned maintenance","tags":["status"],"security":[],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformStatus"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/community":{"get":{"operationId":"myCommunity","summary":"ShopFast's Discord: your linked account, whether you are in and the roles you have","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyCommunity"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"delete":{"operationId":"unlinkMyCommunity","summary":"Unlink your Discord (ShopFast's seller roles are taken away; you stay in the server)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyCommunity"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/community/link":{"post":{"operationId":"linkMyCommunity","summary":"Where to approve ShopFast in Discord (joins you to the server with your seller roles)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"redirectUri":{"type":"string","format":"uri"}},"required":["redirectUri"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkMyCommunityResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/community/link/complete":{"post":{"operationId":"completeMyCommunityLink","summary":"Finish linking your Discord (Discord's code and state)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","minLength":1,"maxLength":600},"redirectUri":{"type":"string","format":"uri"}},"required":["code","state","redirectUri"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MyCommunity"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/push":{"get":{"operationId":"getPushSettings","summary":"Your push devices and preferences in this store, and the VAPID public key to subscribe with","tags":["push"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/push/subscriptions":{"post":{"operationId":"subscribePush","summary":"Register this browser for push in this store (idempotent per endpoint)","tags":["push"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"type":"object","properties":{"endpoint":{"type":"string","maxLength":2000,"format":"uri"},"expirationTime":{"type":["number","null"]},"keys":{"type":"object","properties":{"p256dh":{"type":"string","pattern":"^[A-Za-z0-9_-]{80,100}={0,2}$"},"auth":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,24}={0,2}$"}},"required":["p256dh","auth"]}},"required":["endpoint","keys"]},"timeZone":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]}},"required":["subscription","timeZone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/push/subscriptions/remove":{"post":{"operationId":"unsubscribePush","summary":"Stop push to one of your devices, by id or by its push endpoint (this browser)","tags":["push"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","pattern":"^psh_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"endpoint":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["id","endpoint"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/push/preferences":{"put":{"operationId":"updatePushPreferences","summary":"Which pushes you get in this store, and your quiet hours","tags":["push"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kinds":{"type":"object","properties":{"sale":{"type":"boolean"},"dispute":{"type":"boolean"},"payout":{"type":"boolean"},"low_stock":{"type":"boolean"},"fraud_review":{"type":"boolean"},"ticket_new":{"default":true,"type":"boolean"},"ticket_reply":{"type":"boolean"},"payment_waiting":{"default":true,"type":"boolean"},"payment_review":{"default":true,"type":"boolean"}},"required":["sale","dispute","payout","low_stock","fraud_review","ticket_reply"]},"quietHours":{"type":"object","properties":{"enabled":{"type":"boolean"},"start":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"end":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"timeZone":{"type":"string","minLength":1,"maxLength":64}},"required":["enabled","start","end","timeZone"]}},"required":["kinds","quietHours"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/push/test":{"post":{"operationId":"testPush","summary":"Send a test push now to one of your devices (this browser) or all of them; ignores quiet hours","tags":["push"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"endpoint":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["endpoint"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushTestResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/store/storefront/password":{"get":{"operationId":"getStorePassword","summary":"Whether the storefront is password protected, if a password is set, and the message buyers see","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePasswordSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/storefront/password.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/password"},"put":{"operationId":"updateStorePassword","summary":"Turn password protection on or off, set a new password (stored as a hash) and the message buyers see","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"password":{"anyOf":[{"type":"string","minLength":4,"maxLength":100},{"type":"null"}]},"message":{"type":"string","maxLength":300}},"required":["enabled","password","message"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePasswordSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/storefront/password.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/password"}},"/v1/stores/{storeId}/storefront/password":{"get":{"operationId":"getStorePasswordWithStoreId","summary":"Whether the storefront is password protected, if a password is set, and the message buyers see","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePasswordSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/storefront/password, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/password"},"put":{"operationId":"updateStorePasswordWithStoreId","summary":"Turn password protection on or off, set a new password (stored as a hash) and the message buyers see","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"password":{"anyOf":[{"type":"string","minLength":4,"maxLength":100},{"type":"null"}]},"message":{"type":"string","maxLength":300}},"required":["enabled","password","message"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorePasswordSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/storefront/password, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/password"}},"/v1/storefront/stores/{storeId}/unlock":{"post":{"operationId":"storefrontUnlock","summary":"Check a buyer's store password (rate limited per network and per store); the storefront then sets its unlock cookie","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","minLength":1,"maxLength":200}},"required":["password"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontUnlockResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/storefront/social":{"get":{"operationId":"getStoreSocial","summary":"Social links of the store and where templates show them (header, footer or both), shared by every template","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreSocialSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/storefront/social.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/social"},"put":{"operationId":"updateStoreSocial","summary":"Replace the social links (in order) and where they show; every template picks them up at once","tags":["storefront"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"placement":{"default":"footer","type":"string","enum":["footer","header","both"]},"links":{"maxItems":18,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","github","facebook","threads","bluesky","website","telegram","reddit","whatsapp","twitch","kick","steam","email","custom"]},"url":{"type":"string","maxLength":400},"label":{"default":"","type":"string","maxLength":30}},"required":["network","url"]}}},"required":["links"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreSocialSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/storefront/social.","x-store-explicit-path":"/v1/stores/{storeId}/storefront/social"}},"/v1/stores/{storeId}/storefront/social":{"get":{"operationId":"getStoreSocialWithStoreId","summary":"Social links of the store and where templates show them (header, footer or both), shared by every template","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreSocialSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/storefront/social, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/social"},"put":{"operationId":"updateStoreSocialWithStoreId","summary":"Replace the social links (in order) and where they show; every template picks them up at once","tags":["storefront"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"placement":{"default":"footer","type":"string","enum":["footer","header","both"]},"links":{"maxItems":18,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","github","facebook","threads","bluesky","website","telegram","reddit","whatsapp","twitch","kick","steam","email","custom"]},"url":{"type":"string","maxLength":400},"label":{"default":"","type":"string","maxLength":30}},"required":["network","url"]}}},"required":["links"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreSocialSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/storefront/social, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/storefront/social"}},"/v1/store/products/{productId}/replacement-policy":{"get":{"operationId":"getReplacementPolicy","summary":"A product’s self-serve replacement policy (window, limit, reason and proof, automatic or reviewed) and its queue numbers","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductReplacementPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/replacement-policy.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/replacement-policy"},"put":{"operationId":"saveReplacementPolicy","summary":"Save a product’s self-serve replacement policy","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"windowDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"maxReplacements":{"default":1,"type":"integer","minimum":1,"maximum":20},"requireReason":{"default":true,"type":"boolean"},"requireProofText":{"default":false,"type":"boolean"},"requireProofUpload":{"default":false,"type":"boolean"},"approval":{"default":"review","type":"string","enum":["auto","review"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductReplacementPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/replacement-policy.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/replacement-policy"}},"/v1/stores/{storeId}/products/{productId}/replacement-policy":{"get":{"operationId":"getReplacementPolicyWithStoreId","summary":"A product’s self-serve replacement policy (window, limit, reason and proof, automatic or reviewed) and its queue numbers","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductReplacementPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/replacement-policy, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/replacement-policy"},"put":{"operationId":"saveReplacementPolicyWithStoreId","summary":"Save a product’s self-serve replacement policy","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"windowDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"maxReplacements":{"default":1,"type":"integer","minimum":1,"maximum":20},"requireReason":{"default":true,"type":"boolean"},"requireProofText":{"default":false,"type":"boolean"},"requireProofUpload":{"default":false,"type":"boolean"},"approval":{"default":"review","type":"string","enum":["auto","review"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductReplacementPolicy"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/replacement-policy, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/replacement-policy"}},"/v1/store/replacements":{"get":{"operationId":"listReplacements","summary":"Replacement requests from buyers: waiting for review, approved (automatic or by a teammate) and rejected","tags":["replacements"],"security":[{"apiKey":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"pending","type":"string","enum":["pending","approved","rejected","all"]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["when","key","buyer","reason","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["asc","desc"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplacementQueue"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/replacements.","x-store-explicit-path":"/v1/stores/{storeId}/replacements"}},"/v1/stores/{storeId}/replacements":{"get":{"operationId":"listReplacementsWithStoreId","summary":"Replacement requests from buyers: waiting for review, approved (automatic or by a teammate) and rejected","tags":["replacements"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"pending","type":"string","enum":["pending","approved","rejected","all"]}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["when","key","buyer","reason","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["asc","desc"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplacementQueue"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/replacements, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/replacements"}},"/v1/store/replacements/{requestId}/decide":{"post":{"operationId":"decideReplacement","summary":"Approve (a fresh key from the same pool replaces the old one, which is revoked) or reject a replacement request","tags":["replacements"],"security":[{"apiKey":[]}],"parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","pattern":"^krq_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","reject"]},"note":{"default":"","type":"string","maxLength":500}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplacementRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/replacements/{requestId}/decide.","x-store-explicit-path":"/v1/stores/{storeId}/replacements/{requestId}/decide"}},"/v1/stores/{storeId}/replacements/{requestId}/decide":{"post":{"operationId":"decideReplacementWithStoreId","summary":"Approve (a fresh key from the same pool replaces the old one, which is revoked) or reject a replacement request","tags":["replacements"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"requestId","in":"path","required":true,"schema":{"type":"string","pattern":"^krq_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["approve","reject"]},"note":{"default":"","type":"string","maxLength":500}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplacementRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/replacements/{requestId}/decide, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/replacements/{requestId}/decide"}},"/v1/storefront/stores/{storeId}/licenses/{licenseId}/replace":{"post":{"operationId":"buyerReplaceLicense","summary":"Ask for a replacement key within the seller’s warranty: swapped at once when automatic, else queued for the seller","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]},"reason":{"default":null,"anyOf":[{"type":"string","enum":["not_working","already_used","banned","wrong_region","other"]},{"type":"null"}]},"details":{"default":"","type":"string","maxLength":1000},"attachments":{"default":[],"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"},"claim":{"type":"string","minLength":10,"maxLength":200}},"required":["id","claim"]}}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerReplaceResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/licenses/{licenseId}/replace/proof":{"post":{"operationId":"buyerStartProofUpload","summary":"A signed upload link for a replacement proof file (screenshot, PDF or text; checked by its bytes)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]},"filename":{"type":"string","minLength":1,"maxLength":160},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf","text/plain"]},"bytes":{"type":"integer","minimum":1,"maximum":10485760}},"required":["proof","filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProofUploadTicket"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/licenses/{licenseId}/replace/proof/{attachmentId}/complete":{"post":{"operationId":"buyerCompleteProofUpload","summary":"Check an uploaded replacement proof file","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]},"claim":{"type":"string","minLength":10,"maxLength":200}},"required":["proof","claim"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCompleteProofUploadResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/telegram/shop":{"get":{"operationId":"getTelegramShop","summary":"The Telegram shop bot: connection, settings, checkouts started in Telegram and the bot log","tags":["telegram"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramShopOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read"},"put":{"operationId":"saveTelegramShop","summary":"Turn the bot on or off, purchase messages, hidden products and the welcome line","tags":["telegram"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"deliveryMessages":{"default":true,"type":"boolean"},"hiddenProductIds":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"welcome":{"default":"","type":"string","maxLength":300}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramShopOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/telegram/shop/connect":{"post":{"operationId":"connectTelegramShop","summary":"Connect a bot by its BotFather token (sealed, never sent back) and point its webhook at ShopFast","tags":["telegram"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^\\d{5,15}:[A-Za-z0-9_-]{30,50}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramShopOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/telegram/shop/disconnect":{"post":{"operationId":"disconnectTelegramShop","summary":"Remove the bot’s webhook and forget its token","tags":["telegram"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramShopOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/telegram/shop/simulate":{"post":{"operationId":"simulateTelegram","summary":"Try the bot as a buyer: the message or button runs through the real bot, and its answers are recorded instead of sent","tags":["telegram"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"data":{"default":null,"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramShopOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/storefront/stores/{storeId}/telegram/checkouts/claim":{"post":{"operationId":"claimTelegramCheckout","summary":"Open a Telegram Pay link: returns the cart bound to the Telegram account that pressed Pay (the same cart on every open)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":20,"maxLength":600}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramCheckoutClaim"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/telegram/order-link":{"post":{"operationId":"telegramOrderLink","summary":"For an order paid from the Telegram bot: the start link that proves the buyer’s account and sends the key to the chat","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["sessionId","access"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramOrderLinkResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/telegram/checkouts/cart/{cartId}":{"get":{"operationId":"telegramCheckoutOfCart","summary":"The Telegram account a cart is bound to (checkout shows it), or null","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelegramCheckoutOfCartResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/rescue-imports":{"get":{"operationId":"listRescueImports","summary":"Imports from Sellix, Billgang, SellAuth, Shoppy and Sellhub, newest first, with how many transfers are left today","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRescueImportsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read"},"post":{"operationId":"createRescueImport","summary":"Start a new import from another platform (a draft until it runs)","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["sellix","billgang","sellauth","shoppy","sellhub","myvouches"]}},"required":["platform"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}":{"get":{"operationId":"getRescueImport","summary":"An import: its files and column mapping, the dry run, progress and errors","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:read"}},"/v1/stores/{storeId}/rescue-imports/{importId}/files":{"post":{"operationId":"addRescueFile","summary":"Add an export file (CSV or JSON). What it holds and its columns are recognized; the content is sealed","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":200},"text":{"type":"string","minLength":1,"maxLength":4000000}},"required":["fileName","text"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}/files/{fileId}":{"put":{"operationId":"updateRescueFile","summary":"Change what a file holds and which column feeds each field","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsf_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"type":"string","enum":["products","keys","customers","coupons","orders","discord_roles","store","pages","categories","reviews","blocklist","affiliates","checkout_fields","deals"]},"mapping":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}},"required":["entity","mapping"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"},"delete":{"operationId":"removeRescueFile","summary":"Remove a file from a draft import","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsf_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}/pull":{"post":{"operationId":"pullRescueApi","summary":"Read everything over the platform’s API with the seller’s key (used once, never stored; simulated in development)","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"apiKey":{"default":"","type":"string","maxLength":400},"shopId":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"profile":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueApiPullResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}/options":{"put":{"operationId":"saveRescueOptions","summary":"Merge durations into options, import products as drafts, include order history","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mergeDurations":{"default":true,"type":"boolean"},"productsAsDrafts":{"default":false,"type":"boolean"},"importOrders":{"default":true,"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}/dry-run":{"post":{"operationId":"dryRunRescue","summary":"Check every row against the store without writing anything: what will be created, skipped and why","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}/start":{"post":{"operationId":"startRescue","summary":"Run the import in the background (it re-checks first and refuses while the dry run has errors)","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}/resume":{"post":{"operationId":"resumeRescue","summary":"Continue an import (or a rollback) that stopped, from the first row not yet written","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/rescue-imports/{importId}/rollback":{"post":{"operationId":"rollbackRescue","summary":"Undo the whole batch: remove what it created (keys already sold and customers with new orders stay)","tags":["rescue-imports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"importId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RescueImport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/store/products/{productId}/broadcasts/audience":{"post":{"operationId":"broadcastAudience","summary":"Who owns the product and who each channel would reach with these filters (consent applied)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastAudience"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/broadcasts/audience.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/broadcasts/audience"}},"/v1/stores/{storeId}/products/{productId}/broadcasts/audience":{"post":{"operationId":"broadcastAudienceWithStoreId","summary":"Who owns the product and who each channel would reach with these filters (consent applied)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastAudience"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/broadcasts/audience, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/broadcasts/audience"}},"/v1/stores/{storeId}/broadcasts":{"get":{"operationId":"listBroadcasts","summary":"Updates sent to owners, newest first (one product or all)","tags":["broadcasts"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BroadcastList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/stores/{storeId}/broadcasts/{broadcastId}":{"get":{"operationId":"getBroadcast","summary":"One update: what was sent and to whom, per channel (the first 300 owners, searched, filtered and sorted)","tags":["broadcasts"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string","pattern":"^pbc_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"email","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["queued","sent","skipped","failed","none"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"added","type":"string","enum":["added","buyer","order","email","discord","telegram"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"asc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBroadcastDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read"}},"/v1/store/products/{productId}/broadcasts":{"post":{"operationId":"sendBroadcast","summary":"Post an update to owners: adds the version to the history, attaches the new file version and sends in the background","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"version":{"default":"","type":"string","maxLength":40},"changelog":{"default":"","type":"string","maxLength":10000},"channels":{"type":"object","properties":{"email":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["email","discord","telegram"]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"dmText":{"default":"","type":"string","maxLength":1500},"filters":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}},"file":{"default":null,"anyOf":[{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"default":"","type":"string","maxLength":120},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40}},"required":["fileId","uploadId","version"]},{"type":"null"}]},"showInLibrary":{"default":true,"type":"boolean"}},"required":["title","channels","doc","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBroadcast"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/broadcasts.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/broadcasts"}},"/v1/stores/{storeId}/products/{productId}/broadcasts":{"post":{"operationId":"sendBroadcastWithStoreId","summary":"Post an update to owners: adds the version to the history, attaches the new file version and sends in the background","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"version":{"default":"","type":"string","maxLength":40},"changelog":{"default":"","type":"string","maxLength":10000},"channels":{"type":"object","properties":{"email":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["email","discord","telegram"]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"dmText":{"default":"","type":"string","maxLength":1500},"filters":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}},"file":{"default":null,"anyOf":[{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"default":"","type":"string","maxLength":120},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40}},"required":["fileId","uploadId","version"]},{"type":"null"}]},"showInLibrary":{"default":true,"type":"boolean"}},"required":["title","channels","doc","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBroadcast"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/broadcasts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/broadcasts"}},"/v1/store/products/{productId}/broadcasts/test":{"post":{"operationId":"testBroadcast","summary":"Send the update email to yourself with sample values","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"version":{"default":"","type":"string","maxLength":40},"changelog":{"default":"","type":"string","maxLength":10000},"channels":{"type":"object","properties":{"email":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["email","discord","telegram"]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"dmText":{"default":"","type":"string","maxLength":1500},"filters":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}},"file":{"default":null,"anyOf":[{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"default":"","type":"string","maxLength":120},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40}},"required":["fileId","uploadId","version"]},{"type":"null"}]},"showInLibrary":{"default":true,"type":"boolean"}},"required":["title","channels","doc","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestBroadcastResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/broadcasts/test.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/broadcasts/test"}},"/v1/stores/{storeId}/products/{productId}/broadcasts/test":{"post":{"operationId":"testBroadcastWithStoreId","summary":"Send the update email to yourself with sample values","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"version":{"default":"","type":"string","maxLength":40},"changelog":{"default":"","type":"string","maxLength":10000},"channels":{"type":"object","properties":{"email":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["email","discord","telegram"]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"dmText":{"default":"","type":"string","maxLength":1500},"filters":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}},"file":{"default":null,"anyOf":[{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"default":"","type":"string","maxLength":120},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40}},"required":["fileId","uploadId","version"]},{"type":"null"}]},"showInLibrary":{"default":true,"type":"boolean"}},"required":["title","channels","doc","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestBroadcastResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/broadcasts/test, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/broadcasts/test"}},"/v1/storefront/stores/{storeId}/updates":{"post":{"operationId":"buyerProductUpdates","summary":"Version history of the products the buyer owns (order access link or signed-in account)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerProductUpdates"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/products/{productId}/watermark":{"get":{"operationId":"getProductWatermark","summary":"Whether the product’s downloads are marked per buyer, and how","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductWatermark"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/watermark.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/watermark"},"put":{"operationId":"saveProductWatermark","summary":"Turn per-buyer watermarks on or off for PDFs, images, ZIP archives and text files","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"pdf":{"default":true,"type":"boolean"},"image":{"default":true,"type":"boolean"},"archive":{"default":true,"type":"boolean"},"text":{"default":true,"type":"boolean"},"label":{"default":"email","type":"string","enum":["email","order","code"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductWatermark"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/watermark.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/watermark"}},"/v1/stores/{storeId}/products/{productId}/watermark":{"get":{"operationId":"getProductWatermarkWithStoreId","summary":"Whether the product’s downloads are marked per buyer, and how","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductWatermark"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/watermark, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/watermark"},"put":{"operationId":"saveProductWatermarkWithStoreId","summary":"Turn per-buyer watermarks on or off for PDFs, images, ZIP archives and text files","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"pdf":{"default":true,"type":"boolean"},"image":{"default":true,"type":"boolean"},"archive":{"default":true,"type":"boolean"},"text":{"default":true,"type":"boolean"},"label":{"default":"email","type":"string","enum":["email","order","code"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductWatermark"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/watermark, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/watermark"}},"/v1/stores/{storeId}/leak-trace":{"post":{"operationId":"traceLeak","summary":"Read the watermark of a leaked file (a finished private upload) and name the order it came from","tags":["leak-trace"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"}},"required":["uploadId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeakTraceResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read"}},"/v1/stores/{storeId}/checkout-boost":{"get":{"operationId":"getCheckoutBoost","summary":"Gateway failover, the circuit breaker, tips and whether checkout opens as a sheet","tags":["checkout-boost"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutBoostSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read"},"put":{"operationId":"saveCheckoutBoost","summary":"Save failover, breaker, tip and sheet settings (applies to new checkouts)","tags":["checkout-boost"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"open":{"default":"page","type":"string","enum":["sheet","page"]},"tips":{"default":{},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"presets":{"default":[5,10,20],"minItems":1,"maxItems":4,"type":"array","items":{"type":"integer","minimum":1,"maximum":100}},"allowCustom":{"default":true,"type":"boolean"},"heading":{"default":"Add a tip","type":"string","minLength":1,"maxLength":60},"note":{"default":"Tips go to the creator in full.","type":"string","maxLength":160},"maxMinor":{"default":50000,"type":"integer","minimum":100,"maximum":10000000}}},"failover":{"default":{},"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"triggers":{"default":["declined","provider_error","outage","risk_declined"],"maxItems":4,"type":"array","items":{"type":"string","enum":["declined","provider_error","outage","risk_declined"]}},"methods":{"default":[],"maxItems":40,"type":"array","items":{"type":"string","pattern":"^[a-z_]{3,20}:[a-z0-9_]{3,40}$"}},"breakerThreshold":{"default":3,"type":"integer","minimum":2,"maximum":20},"breakerCooldownMinutes":{"default":10,"type":"integer","minimum":1,"maximum":240},"alertSeller":{"default":true,"type":"boolean"}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutBoostSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write"}},"/v1/stores/{storeId}/checkout-boost/stats":{"get":{"operationId":"getCheckoutBoostStats","summary":"Last 30 days: payment attempts, failures by kind, revenue recovered by failover, provider health, tips and pay what you want","tags":["checkout-boost"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutBoostStats"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read"}},"/v1/stores/{storeId}/checkout-boost/health/{provider}/reset":{"post":{"operationId":"resetGatewayHealth","summary":"Mark a degraded provider healthy again (closes its breaker)","tags":["checkout-boost"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"provider","in":"path","required":true,"schema":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutBoostStats"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write"}},"/v1/store/products/{productId}/update-support":{"get":{"operationId":"getUpdateSupport","summary":"Pay what you want for updates (owners chip in) and for renewals (Extend at a price the buyer picks)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupportSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/update-support.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/update-support"},"put":{"operationId":"saveUpdateSupport","summary":"Save pay what you want for updates and renewals","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"minimumMinor":{"default":0,"type":"integer","minimum":0,"maximum":10000000},"suggestedMinor":{"default":500,"type":"integer","minimum":0,"maximum":10000000},"heading":{"default":"Support the next update","type":"string","minLength":1,"maxLength":60},"message":{"default":"Like the updates? Chip in what you want. You keep everything you own either way.","type":"string","maxLength":240},"renewalPwyw":{"default":false,"type":"boolean"},"renewalMinimumPct":{"default":50,"type":"integer","minimum":0,"maximum":100}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupportSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/update-support.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/update-support"}},"/v1/stores/{storeId}/products/{productId}/update-support":{"get":{"operationId":"getUpdateSupportWithStoreId","summary":"Pay what you want for updates (owners chip in) and for renewals (Extend at a price the buyer picks)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupportSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/update-support, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/update-support"},"put":{"operationId":"saveUpdateSupportWithStoreId","summary":"Save pay what you want for updates and renewals","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"minimumMinor":{"default":0,"type":"integer","minimum":0,"maximum":10000000},"suggestedMinor":{"default":500,"type":"integer","minimum":0,"maximum":10000000},"heading":{"default":"Support the next update","type":"string","minLength":1,"maxLength":60},"message":{"default":"Like the updates? Chip in what you want. You keep everything you own either way.","type":"string","maxLength":240},"renewalPwyw":{"default":false,"type":"boolean"},"renewalMinimumPct":{"default":50,"type":"integer","minimum":0,"maximum":100}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupportSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/update-support, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/update-support"}},"/v1/storefront/checkouts/{sessionId}/failover":{"get":{"operationId":"storefrontFailover","summary":"After a failed payment: why it failed, the buyer’s details to restore and what was tried (order access token)","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailoverRestore"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/sandbox/checkout/{sessionId}/fail":{"post":{"operationId":"sandboxFail","summary":"Sandbox gateway: refuse the payment (decline, provider error, outage, risk decline) through a signed webhook (dev and test sales only)","tags":["sandbox"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["declined","provider_error","outage","risk_declined"]},"method":{"default":"card","type":"string","enum":["card","apple_pay","google_pay","paypal","crypto"]}},"required":["kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxFailResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/update-support/offers":{"post":{"operationId":"buyerUpdateSupportOffers","summary":"Products the buyer owns that take pay what you want support for updates (order access link or signed-in account)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]}},"required":["proof"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerUpdateSupportOffersResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/update-support":{"post":{"operationId":"buyerStartUpdateSupport","summary":"Chip in for a product the buyer owns, at a price they pick (a normal checkout that delivers nothing new)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"proof":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"order"},"sessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["kind","sessionId","access"]},{"type":"object","properties":{"kind":{"type":"string","const":"account"}},"required":["kind"]}]},"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"amountMinor":{"type":"integer","minimum":0,"maximum":10000000}},"required":["proof","productId","amountMinor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCheckoutStart"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/crypto":{"get":{"operationId":"getCryptoSettings","summary":"Crypto to your own wallet: keys and addresses, coins, rate lock, tolerances and what is live","tags":["crypto"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read"},"put":{"operationId":"saveCryptoSettings","summary":"Save crypto settings. Extended public keys and addresses are checked; private keys are refused","tags":["crypto"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"btcXpub":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"ltcXpub":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"evmAddress":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"solanaAddress":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"rails":{"default":["btc","ltc","usdc_polygon","usdc_base","usdt_ethereum","eth_ethereum","usdc_solana"],"maxItems":13,"type":"array","items":{"type":"string","enum":["btc","ltc","eth_ethereum","eth_base","eth_arbitrum","usdc_ethereum","usdc_polygon","usdc_base","usdc_arbitrum","usdt_ethereum","usdt_polygon","usdt_arbitrum","usdc_solana"]}},"quoteMinutes":{"default":30,"type":"integer","minimum":10,"maximum":120},"underpayToleranceBps":{"default":50,"type":"integer","minimum":0,"maximum":500},"underpayToleranceMinor":{"default":0,"type":"integer","minimum":0,"maximum":10000},"topupMinutes":{"default":60,"type":"integer","minimum":10,"maximum":1440},"overpayment":{"default":"keep","type":"string","enum":["keep","store_credit"]},"late":{"default":"reprice","type":"string","enum":["reprice","accept","manual"]},"confirmations":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["bitcoin","litecoin","ethereum","polygon","base","arbitrum","solana"]},"additionalProperties":{"type":"integer","minimum":1,"maximum":200}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCryptoSettingsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write"}},"/v1/stores/{storeId}/crypto/preview":{"post":{"operationId":"previewCryptoKey","summary":"The first receiving addresses an xpub/zpub derives, to compare with the wallet before saving","tags":["crypto"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rail":{"type":"string","enum":["btc","ltc"]},"key":{"type":"string","minLength":1,"maxLength":200}},"required":["rail","key"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XpubCheck"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read"}},"/v1/stores/{storeId}/crypto/payments":{"get":{"operationId":"listCryptoPayments","summary":"Crypto payments: waiting, confirming, underpaid, late and paid, with every transfer","tags":["crypto"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","open","attention","paid"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoPaymentList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read"}},"/v1/stores/{storeId}/crypto/payments/{paymentId}/resolve":{"post":{"operationId":"resolveCryptoPayment","summary":"Count an underpaid or late payment as paid, or record that you refunded it from your wallet","tags":["crypto"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"paymentId","in":"path","required":true,"schema":{"type":"string","pattern":"^cpay_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["accept","refunded"]},"note":{"default":"","type":"string","maxLength":300}},"required":["action"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoPaymentRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/stores/{storeId}/chargeback-shield":{"get":{"operationId":"getChargebackShield","summary":"Steer risky buyers to crypto and store credit, card limits for new buyers, the crypto discount","tags":["chargeback-shield"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackShieldSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"},"put":{"operationId":"saveChargebackShield","summary":"Save the chargeback shield (applies to new checkouts)","tags":["chargeback-shield"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"riskScoreAtLeast":{"default":60,"type":"integer","minimum":1,"maximum":100},"onReview":{"default":true,"type":"boolean"},"newBuyerCardCapMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"cryptoDiscountBps":{"default":0,"type":"integer","minimum":0,"maximum":3000},"autoEvidence":{"default":true,"type":"boolean"},"message":{"default":"For this order, pay with crypto or store credit.","type":"string","minLength":1,"maxLength":200}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackShieldSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/stores/{storeId}/chargeback-shield/stats":{"get":{"operationId":"getChargebackShieldStats","summary":"Checkouts steered, paid with irreversible methods, chargebacks avoided (estimated), card dispute rate","tags":["chargeback-shield"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"default":30,"type":"integer","minimum":7,"maximum":365}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShieldStats"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/storefront/checkouts/{sessionId}/crypto":{"get":{"operationId":"storefrontCryptoCheckout","summary":"The crypto payment panel: coins to pick, the locked quote, address, amount and live confirmations","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoCheckoutView"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}/crypto/quote":{"post":{"operationId":"storefrontCryptoQuote","summary":"Lock a rate for one coin: a fresh address (or unique amount, or Solana Pay reference) for this order","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"},"rail":{"type":"string","enum":["btc","ltc","eth_ethereum","eth_base","eth_arbitrum","usdc_ethereum","usdc_polygon","usdc_base","usdc_arbitrum","usdt_ethereum","usdt_polygon","usdt_arbitrum","usdc_solana"]}},"required":["access","rail"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoCheckoutView"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/dev/crypto/{sessionId}/simulate":{"post":{"operationId":"devCryptoSimulate","summary":"Development only: broadcast on the simulated chain (pay, underpay, overpay, top up, reorg, drop)","tags":["dev"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"},"kind":{"type":"string","enum":["pay","underpay","overpay","topup","reorg","drop"]}},"required":["access","kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CryptoCheckoutView"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/billing/card":{"post":{"operationId":"startBillingCard","summary":"Start saving the card ShopFast charges plan invoices to (Stripe card fields, or a test card on the sandbox)","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCardStart"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"},"put":{"operationId":"finishBillingCard","summary":"Save the confirmed card (replaces the one on file)","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"setupIntentId":{"default":null,"anyOf":[{"type":"string","maxLength":100,"format":"starts_with","pattern":"^seti_.*"},{"type":"null"}]},"sandboxCard":{"default":null,"anyOf":[{"type":"string","enum":["success","declined","authentication_required","expired_card"]},{"type":"null"}]},"slot":{"default":"main","type":"string","enum":["main","backup"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCardView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"},"delete":{"operationId":"removeBillingCard","summary":"Remove a card on file. The main one: the backup becomes the main card, or without one later months are paid from the balance or not at all","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"slot","in":"query","required":false,"schema":{"default":"main","type":"string","enum":["main","backup"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/store/balance/summary":{"get":{"operationId":"getBalanceSummary","summary":"Your ShopFast Pay balance by category: withdrawable, clearing, high-risk hold, reserve, chargeback holds and payouts on their way","tags":["balance"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/balance/summary.","x-store-explicit-path":"/v1/stores/{storeId}/balance/summary"}},"/v1/stores/{storeId}/balance/summary":{"get":{"operationId":"getBalanceSummaryWithStoreId","summary":"Your ShopFast Pay balance by category: withdrawable, clearing, high-risk hold, reserve, chargeback holds and payouts on their way","tags":["balance"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceSummary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"balance:read","description":"The explicit form of GET /v1/store/balance/summary, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/balance/summary"}},"/v1/stores/{storeId}/payout-wallet/verification":{"post":{"operationId":"startPayoutWalletVerification","summary":"Before the payout wallet is set or changed: checks the address, then asks for your two-factor code, or emails you a 6-digit code for that address","tags":["payout-wallet"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rail":{"type":"string","enum":["usdt_tron","usdt_bsc","usdt_ethereum","usdt_solana","usdc_base","usdc_polygon","usdc_solana","btc","ltc","eth"]},"address":{"type":"string","minLength":20,"maxLength":120}},"required":["rail","address"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutWalletVerification"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/stores/{storeId}/payout-wallet":{"put":{"operationId":"savePayoutWallet","summary":"Set (or change) the crypto wallet ShopFast sends payouts to: coin and network, the address (checked for that network), and your two-factor or emailed code","tags":["payout-wallet"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rail":{"type":"string","enum":["usdt_tron","usdt_bsc","usdt_ethereum","usdt_solana","usdc_base","usdc_polygon","usdc_solana","btc","ltc","eth"]},"address":{"type":"string","minLength":20,"maxLength":120},"code":{"type":"string","pattern":"^(?:\\d{6}|[a-z0-9]{4}-[a-z0-9]{4})$"},"verifyToken":{"default":null,"anyOf":[{"type":"string","maxLength":800},{"type":"null"}]}},"required":["rail","address","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutWallet"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/store/payouts":{"post":{"operationId":"requestWithdrawal","summary":"Withdraw: a payout request from the withdrawable balance to the payout wallet, reviewed and sent by ShopFast","tags":["payouts"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payout"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write","x-api-key-scope":"balance:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/payouts.","x-store-explicit-path":"/v1/stores/{storeId}/payouts"}},"/v1/stores/{storeId}/payouts":{"post":{"operationId":"requestWithdrawalWithStoreId","summary":"Withdraw: a payout request from the withdrawable balance to the payout wallet, reviewed and sent by ShopFast","tags":["payouts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payout"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write","x-api-key-scope":"balance:write","description":"The explicit form of POST /v1/store/payouts, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payouts"}},"/v1/admin/stores/{storeId}/plan-state":{"get":{"operationId":"adminGetStorePlanState","summary":"A store's plan: a complimentary plan running, an invoice waiting, the card on file, or \"review\"","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePlanState"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/billing/plan-invoice/pay":{"post":{"operationId":"payPlanInvoice","summary":"Pay the plan invoice that is waiting with the card on file; the plan starts once it is paid (may ask for 3-D Secure)","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanPayResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"},"put":{"operationId":"finishPlanInvoicePayment","summary":"After the bank confirmed the payment (3-D Secure): read it back and start the plan","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paymentIntentId":{"type":"string","maxLength":100,"format":"starts_with","pattern":"^pi_.*"}},"required":["paymentIntentId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanPayResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/stores/{storeId}/plan":{"get":{"operationId":"getPlanOverview","summary":"What the store's plan allows (a trial's plan while one runs) and how much of it is used","tags":["plan"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/admin/stores/{storeId}/plan-limits":{"get":{"operationId":"adminGetStorePlanLimits","summary":"A store's limits as enforced, its usage, the admin override and its trial","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePlanLimits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"adminSetStorePlanLimits","summary":"Change some limits for one store (fields left out come from its plan); audited with the reason","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limits":{"type":"object","properties":{"products":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"ordersPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000000},{"type":"null"}]},"teamMembers":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"customDomains":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000},{"type":"null"}]},"removeBranding":{"type":"boolean"},"developerTools":{"type":"boolean"},"themeCode":{"type":"boolean"},"shopfastPay":{"type":"boolean"},"addOns":{"maxItems":3,"type":"array","items":{"type":"string","enum":["licensing","email_marketing","leak_tracer"]}}}},"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["limits","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePlanLimits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"delete":{"operationId":"adminClearStorePlanLimits","summary":"Remove a store's limit override: its plan's limits apply again","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePlanLimits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/trial":{"put":{"operationId":"adminSetStoreTrial","summary":"Start, extend or end a store's trial (endsAt null ends it now); audited with the reason","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planId":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["planId","endsAt","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStorePlanLimits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/plan-invoices/{invoiceId}/void":{"post":{"operationId":"adminVoidPlanInvoice","summary":"Void an open plan invoice (nothing is charged); audited with the reason","tags":["admin plan-invoices"],"security":[{"adminSession":[]}],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","pattern":"^pinv_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":1,"maxLength":280}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPlanInvoiceRow"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/plan-vouchers":{"get":{"operationId":"adminListPlanVouchers","summary":"Plan vouchers, newest first, with how many were redeemed","tags":["admin plan-vouchers"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListPlanVouchersResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"adminCreatePlanVoucher","summary":"Make a voucher: a paid plan free for some months, optionally for the first N sellers","tags":["admin plan-vouchers"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"anyOf":[{"type":"string","pattern":"^[A-Z0-9][A-Z0-9-]{2,31}$"},{"type":"null"}]},"planId":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},"months":{"type":"integer","minimum":1,"maximum":36},"maxRedemptions":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"note":{"default":"","type":"string","maxLength":280}},"required":["code","planId","months","maxRedemptions","expiresAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanVoucher"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/plan-vouchers/{voucherId}":{"put":{"operationId":"adminUpdatePlanVoucher","summary":"Pause or resume a voucher, end it, change its cap or note","tags":["admin plan-vouchers"],"security":[{"adminSession":[]}],"parameters":[{"name":"voucherId","in":"path","required":true,"schema":{"type":"string","pattern":"^pvc_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paused":{"type":"boolean"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"maxRedemptions":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"note":{"type":"string","maxLength":280}},"required":["paused","expiresAt","maxRedemptions","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanVoucher"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/plan-vouchers/{voucherId}/redemptions":{"get":{"operationId":"adminListPlanVoucherRedemptions","summary":"Who redeemed a voucher, and until when their plan is free","tags":["admin plan-vouchers"],"security":[{"adminSession":[]}],"parameters":[{"name":"voucherId","in":"path","required":true,"schema":{"type":"string","pattern":"^pvc_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListPlanVoucherRedemptionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/plan-vouchers/{code}":{"get":{"operationId":"checkPlanVoucher","summary":"What a voucher code gives, and whether it can be redeemed now (sign-up, Billing)","tags":["plan-vouchers"],"security":[],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9-]{2,31}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanVoucherPreview"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/billing/voucher":{"post":{"operationId":"redeemPlanVoucher","summary":"Redeem a voucher on this store: its plan free for the voucher's months (after a running trial)","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9-]{2,31}$"}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/stores/{storeId}/billing/plan/preview":{"get":{"operationId":"previewPlanChange","summary":"What picking a plan would do: when it starts, what is charged now (with the credit for unused days) and next","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"planId","in":"query","required":true,"schema":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"now","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanChangePreview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/stores/{storeId}/billing/checkout":{"post":{"operationId":"startBillingCheckout","summary":"Open Stripe's hosted page to save the card on file or to pay the open plan invoice","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"purpose":{"type":"string","const":"card"}},"required":["purpose"]},{"type":"object","properties":{"purpose":{"type":"string","const":"invoice"}},"required":["purpose"]},{"type":"object","properties":{"purpose":{"type":"string","const":"backup_card"}},"required":["purpose"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingCheckoutLink"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"},"put":{"operationId":"finishBillingCheckout","summary":"Back from Stripe's page: save the card and settle the invoice it paid (idempotent; a task does it too)","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","maxLength":200,"format":"starts_with","pattern":"^cs_.*"}},"required":["sessionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/stores/{storeId}/billing/card/swap":{"post":{"operationId":"swapBillingCards","summary":"Make the backup card the main one (the main card becomes the backup)","tags":["billing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/me/command-center":{"get":{"operationId":"getCommandCenter","summary":"Every store you belong to: revenue per currency, orders, visitors, the cross-store inboxes and alerts (each store read in its own tenant context, per your permissions there)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandCenter"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/wholesale/me":{"get":{"operationId":"wholesaleApiMe","summary":"Reseller API: your account, tier, store credit balance and this key (Bearer rk_…; any scope)","tags":["wholesale"],"security":[],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleMe"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/wholesale/catalog":{"get":{"operationId":"wholesaleApiCatalog","summary":"Reseller API: products at your tier price with live stock (scope catalog:read)","tags":["wholesale"],"security":[],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleApiCatalogResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/wholesale/orders":{"get":{"operationId":"wholesaleApiOrders","summary":"Reseller API: your wholesale orders, newest first (scope orders:read)","tags":["wholesale"],"security":[],"parameters":[{"name":"status","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["awaiting_payment","paid","fulfilled","cancelled"]},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleApiOrdersResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"wholesaleApiCreateOrder","summary":"Reseller API: place a wholesale order at your tier price; pay on the returned checkout or from store credit (scope orders:write)","tags":["wholesale"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"quantity":{"type":"integer","minimum":1,"maximum":10000},"payWith":{"default":"checkout","type":"string","enum":["checkout","store_credit"]},"reference":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,64}$"},{"type":"null"}]}},"required":["productId","quantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleApiOrder"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/wholesale/orders/{orderId}":{"get":{"operationId":"wholesaleApiOrder","summary":"Reseller API: one wholesale order (scope orders:read)","tags":["wholesale"],"security":[],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^rso_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleApiOrder"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/wholesale/orders/{orderId}/keys":{"get":{"operationId":"wholesaleApiOrderKeys","summary":"Reseller API: the keys delivered for a paid wholesale order (scope keys:read)","tags":["wholesale"],"security":[],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^rso_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleKeys"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/wholesale/webhook":{"put":{"operationId":"wholesaleApiSaveWebhook","summary":"Reseller API: where to send signed events for your orders (Standard Webhooks; scope webhooks:write)","tags":["wholesale"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":500,"format":"uri"},"enabled":{"default":true,"type":"boolean"},"events":{"default":["wholesale_order.created","wholesale_order.paid","wholesale_order.fulfilled","wholesale_order.cancelled"],"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["wholesale_order.created","wholesale_order.paid","wholesale_order.fulfilled","wholesale_order.cancelled"]}},"rotateSecret":{"default":false,"type":"boolean"}},"required":["url"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerWebhookSaved"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/wholesale/panel":{"post":{"operationId":"wholesalePanel","summary":"Wholesale portal: balance, orders, API keys, webhook and recent API calls (portal link token)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":10,"maxLength":2000}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesalePanel"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/wholesale/keys":{"post":{"operationId":"wholesalePanelCreateKey","summary":"Wholesale portal: create an API key (the secret is returned once)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"scopes":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"string","enum":["catalog:read","orders:read","orders:write","keys:read","webhooks:write"]}},"token":{"type":"string","minLength":10,"maxLength":2000}},"required":["name","scopes","token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesalePanelCreateKeyResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/wholesale/keys/{keyId}/revoke":{"post":{"operationId":"wholesalePanelRevokeKey","summary":"Wholesale portal: revoke one of your API keys","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^rak_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":10,"maxLength":2000}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerApiKey"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/wholesale/webhook":{"post":{"operationId":"wholesalePanelSaveWebhook","summary":"Wholesale portal: set the webhook endpoint for your orders","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":500,"format":"uri"},"enabled":{"default":true,"type":"boolean"},"events":{"default":["wholesale_order.created","wholesale_order.paid","wholesale_order.fulfilled","wholesale_order.cancelled"],"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["wholesale_order.created","wholesale_order.paid","wholesale_order.fulfilled","wholesale_order.cancelled"]}},"rotateSecret":{"default":false,"type":"boolean"},"token":{"type":"string","minLength":10,"maxLength":2000}},"required":["url","token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerWebhookSaved"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/wholesale/orders/{orderId}/keys":{"post":{"operationId":"wholesalePanelKeys","summary":"Wholesale portal: the keys of one of your paid orders","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^rso_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":10,"maxLength":2000}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WholesaleKeys"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/resellers/{resellerId}/api":{"get":{"operationId":"getResellerApi","summary":"A reseller's API keys, webhook, recent calls and webhook deliveries","tags":["resellers"],"security":[{"apiKey":[]}],"parameters":[{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerApiOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/resellers/{resellerId}/api.","x-store-explicit-path":"/v1/stores/{storeId}/resellers/{resellerId}/api"}},"/v1/stores/{storeId}/resellers/{resellerId}/api":{"get":{"operationId":"getResellerApiWithStoreId","summary":"A reseller's API keys, webhook, recent calls and webhook deliveries","tags":["resellers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerApiOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:read","x-api-key-scope":"marketing:read","description":"The explicit form of GET /v1/store/resellers/{resellerId}/api, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resellers/{resellerId}/api"}},"/v1/store/resellers/{resellerId}/api/keys/{keyId}/revoke":{"post":{"operationId":"revokeResellerApiKey","summary":"Revoke a reseller's API key","tags":["resellers"],"security":[{"apiKey":[]}],"parameters":[{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^rak_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerApiOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/resellers/{resellerId}/api/keys/{keyId}/revoke.","x-store-explicit-path":"/v1/stores/{storeId}/resellers/{resellerId}/api/keys/{keyId}/revoke"}},"/v1/stores/{storeId}/resellers/{resellerId}/api/keys/{keyId}/revoke":{"post":{"operationId":"revokeResellerApiKeyWithStoreId","summary":"Revoke a reseller's API key","tags":["resellers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"resellerId","in":"path","required":true,"schema":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^rak_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResellerApiOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/resellers/{resellerId}/api/keys/{keyId}/revoke, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/resellers/{resellerId}/api/keys/{keyId}/revoke"}},"/v1/store/products/{productId}/telegram-access":{"get":{"operationId":"getCommunityAccess","summary":"The Telegram group or channel this product invites buyers to, and how long access lasts","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityProductView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/telegram-access.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/telegram-access"},"put":{"operationId":"saveCommunityAccess","summary":"Save Telegram access for a product (the bot must be an admin of the chat who can invite and remove members)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"chatId":{"default":null,"anyOf":[{"type":"string","pattern":"^(-?\\d{5,20}|@[A-Za-z][A-Za-z0-9_]{4,31})$"},{"type":"null"}]},"chatTitle":{"default":"","type":"string","maxLength":128},"chatType":{"default":null,"anyOf":[{"type":"string","enum":["group","supergroup","channel"]},{"type":"null"}]},"duration":{"default":"auto","type":"string","enum":["auto","fixed","lifetime"]},"fixedDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"removeOnRefund":{"default":true,"type":"boolean"},"removeOnChargeback":{"default":true,"type":"boolean"},"removeOnExpiry":{"default":true,"type":"boolean"},"inviteHours":{"default":24,"type":"integer","minimum":1,"maximum":168}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityProductView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/telegram-access.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/telegram-access"}},"/v1/stores/{storeId}/products/{productId}/telegram-access":{"get":{"operationId":"getCommunityAccessWithStoreId","summary":"The Telegram group or channel this product invites buyers to, and how long access lasts","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityProductView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/telegram-access, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/telegram-access"},"put":{"operationId":"saveCommunityAccessWithStoreId","summary":"Save Telegram access for a product (the bot must be an admin of the chat who can invite and remove members)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"chatId":{"default":null,"anyOf":[{"type":"string","pattern":"^(-?\\d{5,20}|@[A-Za-z][A-Za-z0-9_]{4,31})$"},{"type":"null"}]},"chatTitle":{"default":"","type":"string","maxLength":128},"chatType":{"default":null,"anyOf":[{"type":"string","enum":["group","supergroup","channel"]},{"type":"null"}]},"duration":{"default":"auto","type":"string","enum":["auto","fixed","lifetime"]},"fixedDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"removeOnRefund":{"default":true,"type":"boolean"},"removeOnChargeback":{"default":true,"type":"boolean"},"removeOnExpiry":{"default":true,"type":"boolean"},"inviteHours":{"default":24,"type":"integer","minimum":1,"maximum":168}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityProductView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/telegram-access, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/telegram-access"}},"/v1/stores/{storeId}/telegram-access":{"get":{"operationId":"listCommunityGrants","summary":"Telegram access: who was invited, who is waiting to link Telegram, and who was removed","tags":["telegram-access"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","active","waiting","removed","failed"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","buyer","telegram","status","ends"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read"}},"/v1/stores/{storeId}/telegram-access/{grantId}/remove":{"post":{"operationId":"revokeCommunityGrant","summary":"Remove a buyer from the Telegram chat now","tags":["telegram-access"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"grantId","in":"path","required":true,"schema":{"type":"string","pattern":"^cgr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityGrant"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/stores/{storeId}/telegram-access/{grantId}/restore":{"post":{"operationId":"restoreCommunityGrant","summary":"Give access back (or retry a failed invite): the bot sends a fresh single-use invite","tags":["telegram-access"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"grantId","in":"path","required":true,"schema":{"type":"string","pattern":"^cgr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunityGrant"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/storefront/checkouts/{sessionId}/telegram-access":{"get":{"operationId":"buyerCommunityAccess","summary":"Order page: the Telegram groups and channels this order grants, with a link that opens the store's bot (order access token)","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCommunityAccess"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/telegram-access/sweep":{"post":{"operationId":"communityPing","summary":"Run the access check now: remove ended, refunded and charged-back access, retry failed invites","tags":["telegram-access"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/admin/feature-flags":{"get":{"operationId":"adminListFeatureFlags","summary":"Every feature flag with who has it","tags":["admin feature-flags"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureFlagsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/feature-flags/{key}":{"put":{"operationId":"adminSetFeatureFlag","summary":"Turn a feature on or off for every store","tags":["admin feature-flags"],"security":[{"adminSession":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","enum":["licensing","email_marketing","leak_tracer","pricing_tiers"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabledForAll":{"type":"boolean"}},"required":["enabledForAll"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureFlagView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/feature-flags/{key}/grants":{"post":{"operationId":"adminAddFeatureGrant","summary":"Give a feature to one store or one user","tags":["admin feature-flags"],"security":[{"adminSession":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","enum":["licensing","email_marketing","leak_tracer","pricing_tiers"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"store"},"store":{"type":"string","minLength":1,"maxLength":120}},"required":["kind","store"]},{"type":"object","properties":{"kind":{"type":"string","const":"user"},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["kind","email"]}]},"note":{"default":"","type":"string","maxLength":280}},"required":["target"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureFlagView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/feature-flags/{key}/grants/{grantId}":{"delete":{"operationId":"adminRemoveFeatureGrant","summary":"Take a feature back from a store or user","tags":["admin feature-flags"],"security":[{"adminSession":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","enum":["licensing","email_marketing","leak_tracer","pricing_tiers"]}},{"name":"grantId","in":"path","required":true,"schema":{"type":"string","pattern":"^ffg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureFlagView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/features":{"get":{"operationId":"adminGetStoreFeatures","summary":"A store’s features and where each comes from","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFeaturesView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/features/{key}":{"put":{"operationId":"adminSetStoreFeature","summary":"Give a feature to this store or take its grant back","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"key","in":"path","required":true,"schema":{"type":"string","enum":["licensing","email_marketing","leak_tracer","pricing_tiers"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"note":{"default":"","type":"string","maxLength":280}},"required":["enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreFeaturesView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/search/suggest":{"get":{"operationId":"storefrontSearchSuggest","summary":"Instant search suggestions: products, categories, collections and pages, typo-tolerant (popular searches for an empty query)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":200}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"category","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":80}},{"name":"v","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontSuggest"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/search":{"get":{"operationId":"storefrontSearch","summary":"Search products with filters, facet counts, sorting and pages","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":200}},{"name":"sort","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":20}},{"name":"category","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":900}},{"name":"game","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":400}},{"name":"platform","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":200}},{"name":"type","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"duration","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":80}},{"name":"status","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":80}},{"name":"stock","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":2}},{"name":"rating","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":2}},{"name":"min","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":14}},{"name":"max","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":14}},{"name":"page","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":4}},{"name":"perPage","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"v","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontSearchResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/search/events":{"post":{"operationId":"storefrontSearchTrack","summary":"Record a search or a click on a result (search analytics)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["search","click"]},"id":{"type":"string","pattern":"^[a-z0-9]{12,32}$"},"source":{"type":"string","enum":["page","instant"]},"q":{"type":"string","maxLength":200},"results":{"type":"integer","minimum":0,"maximum":1000000},"ref":{"default":null,"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["product","collection","page","category","query"]},"handle":{"type":"string","minLength":1,"maxLength":140}},"required":["kind","handle"]},{"type":"null"}]},"position":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":500},{"type":"null"}]}},"required":["kind","id","source","q","results"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/search/settings":{"get":{"operationId":"getSearchSettings","summary":"Synonyms, pinned results, redirects and the state of the search index","tags":["search"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/search/settings.","x-store-explicit-path":"/v1/stores/{storeId}/search/settings"}},"/v1/stores/{storeId}/search/settings":{"get":{"operationId":"getSearchSettingsWithStoreId","summary":"Synonyms, pinned results, redirects and the state of the search index","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/search/settings, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/settings"}},"/v1/store/search/synonyms":{"post":{"operationId":"createSearchSynonym","summary":"Add a synonym rule","tags":["search"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terms":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"oneWay":{"default":false,"type":"boolean"}},"required":["terms"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSynonym"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/search/synonyms.","x-store-explicit-path":"/v1/stores/{storeId}/search/synonyms"}},"/v1/stores/{storeId}/search/synonyms":{"post":{"operationId":"createSearchSynonymWithStoreId","summary":"Add a synonym rule","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terms":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"oneWay":{"default":false,"type":"boolean"}},"required":["terms"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSynonym"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/search/synonyms, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/synonyms"}},"/v1/store/search/synonyms/{synonymId}":{"put":{"operationId":"updateSearchSynonym","summary":"Change a synonym rule","tags":["search"],"security":[{"apiKey":[]}],"parameters":[{"name":"synonymId","in":"path","required":true,"schema":{"type":"string","pattern":"^ssy_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terms":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"oneWay":{"default":false,"type":"boolean"}},"required":["terms"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSynonym"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/search/synonyms/{synonymId}.","x-store-explicit-path":"/v1/stores/{storeId}/search/synonyms/{synonymId}"},"delete":{"operationId":"deleteSearchSynonym","summary":"Remove a synonym rule","tags":["search"],"security":[{"apiKey":[]}],"parameters":[{"name":"synonymId","in":"path","required":true,"schema":{"type":"string","pattern":"^ssy_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/search/synonyms/{synonymId}.","x-store-explicit-path":"/v1/stores/{storeId}/search/synonyms/{synonymId}"}},"/v1/stores/{storeId}/search/synonyms/{synonymId}":{"put":{"operationId":"updateSearchSynonymWithStoreId","summary":"Change a synonym rule","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"synonymId","in":"path","required":true,"schema":{"type":"string","pattern":"^ssy_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terms":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"oneWay":{"default":false,"type":"boolean"}},"required":["terms"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSynonym"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/search/synonyms/{synonymId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/synonyms/{synonymId}"},"delete":{"operationId":"deleteSearchSynonymWithStoreId","summary":"Remove a synonym rule","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"synonymId","in":"path","required":true,"schema":{"type":"string","pattern":"^ssy_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/search/synonyms/{synonymId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/synonyms/{synonymId}"}},"/v1/store/search/rules":{"post":{"operationId":"createSearchRule","summary":"Pin products to a search, or send a search to a page","tags":["search"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["pin","redirect"]},"query":{"type":"string","minLength":1,"maxLength":80},"productIds":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"url":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"enabled":{"default":true,"type":"boolean"}},"required":["kind","query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/search/rules.","x-store-explicit-path":"/v1/stores/{storeId}/search/rules"}},"/v1/stores/{storeId}/search/rules":{"post":{"operationId":"createSearchRuleWithStoreId","summary":"Pin products to a search, or send a search to a page","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["pin","redirect"]},"query":{"type":"string","minLength":1,"maxLength":80},"productIds":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"url":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"enabled":{"default":true,"type":"boolean"}},"required":["kind","query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/search/rules, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/rules"}},"/v1/store/search/rules/{ruleId}":{"put":{"operationId":"updateSearchRule","summary":"Change a pin or redirect","tags":["search"],"security":[{"apiKey":[]}],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^srl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["pin","redirect"]},"query":{"type":"string","minLength":1,"maxLength":80},"productIds":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"url":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"enabled":{"default":true,"type":"boolean"}},"required":["kind","query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/search/rules/{ruleId}.","x-store-explicit-path":"/v1/stores/{storeId}/search/rules/{ruleId}"},"delete":{"operationId":"deleteSearchRule","summary":"Remove a pin or redirect","tags":["search"],"security":[{"apiKey":[]}],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^srl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as DELETE /v1/stores/{storeId}/search/rules/{ruleId}.","x-store-explicit-path":"/v1/stores/{storeId}/search/rules/{ruleId}"}},"/v1/stores/{storeId}/search/rules/{ruleId}":{"put":{"operationId":"updateSearchRuleWithStoreId","summary":"Change a pin or redirect","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^srl_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["pin","redirect"]},"query":{"type":"string","minLength":1,"maxLength":80},"productIds":{"default":[],"maxItems":12,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"url":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"enabled":{"default":true,"type":"boolean"}},"required":["kind","query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRule"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of PUT /v1/store/search/rules/{ruleId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/rules/{ruleId}"},"delete":{"operationId":"deleteSearchRuleWithStoreId","summary":"Remove a pin or redirect","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","pattern":"^srl_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of DELETE /v1/store/search/rules/{ruleId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/rules/{ruleId}"}},"/v1/store/search/reindex":{"post":{"operationId":"rebuildSearchIndex","summary":"Rebuild the search index now (it also refreshes itself after catalog changes)","tags":["search"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebuildSearchIndexResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/search/reindex.","x-store-explicit-path":"/v1/stores/{storeId}/search/reindex"}},"/v1/stores/{storeId}/search/reindex":{"post":{"operationId":"rebuildSearchIndexWithStoreId","summary":"Rebuild the search index now (it also refreshes itself after catalog changes)","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebuildSearchIndexResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:write","x-api-key-scope":"storefront:write","description":"The explicit form of POST /v1/store/search/reindex, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/reindex"}},"/v1/store/search/preview":{"get":{"operationId":"previewSearch","summary":"What buyers get for a search (synonyms, typos, pins and redirects applied), not counted in analytics","tags":["search"],"security":[{"apiKey":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontSuggest"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/search/preview.","x-store-explicit-path":"/v1/stores/{storeId}/search/preview"}},"/v1/stores/{storeId}/search/preview":{"get":{"operationId":"previewSearchWithStoreId","summary":"What buyers get for a search (synonyms, typos, pins and redirects applied), not counted in analytics","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontSuggest"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"storefront:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/search/preview, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/preview"}},"/v1/store/search/analytics":{"get":{"operationId":"getSearchAnalytics","summary":"Top searches, searches with no results, click-through and searches that led to a purchase","tags":["search"],"security":[{"apiKey":[]}],"parameters":[{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d"]}},{"name":"terms","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"termsSort","in":"query","required":false,"schema":{"default":"searches","type":"string","enum":["searches","query","ctr","purchases"]}},{"name":"termsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"zero","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"zeroSort","in":"query","required":false,"schema":{"default":"searches","type":"string","enum":["searches","query"]}},{"name":"zeroDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"storefront:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/search/analytics.","x-store-explicit-path":"/v1/stores/{storeId}/search/analytics"}},"/v1/stores/{storeId}/search/analytics":{"get":{"operationId":"getSearchAnalyticsWithStoreId","summary":"Top searches, searches with no results, click-through and searches that led to a purchase","tags":["search"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"range","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d"]}},{"name":"terms","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"termsSort","in":"query","required":false,"schema":{"default":"searches","type":"string","enum":["searches","query","ctr","purchases"]}},{"name":"termsDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"zero","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]}},{"name":"zeroSort","in":"query","required":false,"schema":{"default":"searches","type":"string","enum":["searches","query"]}},{"name":"zeroDir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAnalytics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"storefront:read","description":"The explicit form of GET /v1/store/search/analytics, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/search/analytics"}},"/v1/storefront/stores/{storeId}/shop":{"get":{"operationId":"storefrontShop","summary":"The store, its navigation (collections without product lists, pages), promotions, store-wide stats and latest reviews","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontShop"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/page-data":{"post":{"operationId":"storefrontPageData","summary":"What one page shows: products by handle or id (and what they link to), and sorted, paginated collection slices","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handles":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"ids":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"related":{"default":false,"type":"boolean"},"slices":{"default":[],"maxItems":8,"type":"array","items":{"type":"object","properties":{"handle":{"type":"string","minLength":1,"maxLength":140},"source":{"default":"collection","type":"string","enum":["collection","category"]},"sort":{"default":"featured","type":"string","enum":["featured","best-selling","newest","price-ascending","price-descending","title-ascending"]},"offset":{"default":0,"type":"integer","minimum":0,"maximum":10000000},"after":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"limit":{"type":"integer","minimum":1,"maximum":250}},"required":["handle","limit"]}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDataResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/image-variants":{"post":{"operationId":"storefrontImageVariants","summary":"For the public images a page shows: their version, size and the ladder rungs stored for the media domain (image-variants.ts)","tags":["storefront"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","maxLength":300}}},"required":["keys"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageVariantsResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/sitemaps":{"get":{"operationId":"storefrontSitemapIndex","summary":"The child sitemaps of a store (products cut by id prefix, collections, pages) with their lastmod, size and fingerprint","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontSitemapIndex"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/sitemaps/entries":{"get":{"operationId":"storefrontSitemapPage","summary":"One page of a child sitemap's URLs, in keyset order (pass `next` as `after`)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["products","collections","pages","categories"]}},{"name":"prefix","in":"query","required":false,"schema":{"default":"","type":"string","pattern":"^[0-9a-z]{0,2}$"}},{"name":"after","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"until","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitemapPage"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/feed":{"get":{"operationId":"storefrontFeedPage","summary":"One page of the product feed (eligible products, catalog order, keyset cursor)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"after","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedPage"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/orders/{orderId}/refunds/queue":{"post":{"operationId":"queueOrderRefund","summary":"Queue a refund for 10 seconds (undo window), then send it like createOrderRefund","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":280},"destination":{"default":"original","type":"string","enum":["original","store_credit"]},"idempotencyKey":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,80}$"},"bonus":{"type":"boolean"}},"required":["amountMinor","reason","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/orders/{orderId}/refunds/queue.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/refunds/queue"}},"/v1/stores/{storeId}/orders/{orderId}/refunds/queue":{"post":{"operationId":"queueOrderRefundWithStoreId","summary":"Queue a refund for 10 seconds (undo window), then send it like createOrderRefund","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":280},"destination":{"default":"original","type":"string","enum":["original","store_credit"]},"idempotencyKey":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,80}$"},"bonus":{"type":"boolean"}},"required":["amountMinor","reason","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write","x-api-key-scope":"orders:write","description":"The explicit form of POST /v1/store/orders/{orderId}/refunds/queue, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/refunds/queue"}},"/v1/stores/{storeId}/marketing/campaigns/{campaignId}/send-queue":{"post":{"operationId":"queueCampaignSend","summary":"Queue \"Send now\" for 10 seconds (undo window); the same checks as scheduleCampaign run first","tags":["marketing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write"}},"/v1/store/products/{productId}/broadcasts/queue":{"post":{"operationId":"queueBroadcast","summary":"Queue a product update for 10 seconds (undo window), then post it like sendBroadcast","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"version":{"default":"","type":"string","maxLength":40},"changelog":{"default":"","type":"string","maxLength":10000},"channels":{"type":"object","properties":{"email":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["email","discord","telegram"]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"dmText":{"default":"","type":"string","maxLength":1500},"filters":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}},"file":{"default":null,"anyOf":[{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"default":"","type":"string","maxLength":120},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40}},"required":["fileId","uploadId","version"]},{"type":"null"}]},"showInLibrary":{"default":true,"type":"boolean"}},"required":["title","channels","doc","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/{productId}/broadcasts/queue.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/broadcasts/queue"}},"/v1/stores/{storeId}/products/{productId}/broadcasts/queue":{"post":{"operationId":"queueBroadcastWithStoreId","summary":"Queue a product update for 10 seconds (undo window), then post it like sendBroadcast","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"version":{"default":"","type":"string","maxLength":40},"changelog":{"default":"","type":"string","maxLength":10000},"channels":{"type":"object","properties":{"email":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["email","discord","telegram"]},"doc":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"type":"object","properties":{"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"background":{"default":"#f4f4f7","type":"string","pattern":"^#[0-9a-f]{6}$"},"surface":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"text":{"default":"#171724","type":"string","pattern":"^#[0-9a-f]{6}$"},"muted":{"default":"#6b6c78","type":"string","pattern":"^#[0-9a-f]{6}$"},"border":{"default":"#e6e6ec","type":"string","pattern":"^#[0-9a-f]{6}$"},"buttonText":{"default":"#ffffff","type":"string","pattern":"^#[0-9a-f]{6}$"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","type":"string","enum":["system","humanist","geometric","serif","mono"]},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}}},"blocks":{"maxItems":80,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","title","url"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["blocks"]}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"url":{"type":"string","maxLength":800}},"required":["network","url"]}}},"required":["id","type","links"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text"]},{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"]}]}}},"required":["subject","blocks"]},"dmText":{"default":"","type":"string","maxLength":1500},"filters":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"}},"purchasedAfter":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}}},"file":{"default":null,"anyOf":[{"type":"object","properties":{"fileId":{"anyOf":[{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"name":{"default":"","type":"string","maxLength":120},"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"version":{"type":"string","minLength":1,"maxLength":40}},"required":["fileId","uploadId","version"]},{"type":"null"}]},"showInLibrary":{"default":true,"type":"boolean"}},"required":["title","channels","doc","filters"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/{productId}/broadcasts/queue, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/broadcasts/queue"}},"/v1/store/products/bulk-delete-queue":{"post":{"operationId":"queueProductsDelete","summary":"Queue deleting products for 10 seconds (undo window)","tags":["products"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["productIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/products/bulk-delete-queue.","x-store-explicit-path":"/v1/stores/{storeId}/products/bulk-delete-queue"}},"/v1/stores/{storeId}/products/bulk-delete-queue":{"post":{"operationId":"queueProductsDeleteWithStoreId","summary":"Queue deleting products for 10 seconds (undo window)","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"productIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["productIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of POST /v1/store/products/bulk-delete-queue, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/bulk-delete-queue"}},"/v1/store/discounts/bulk-delete-queue":{"post":{"operationId":"queueDiscountsDelete","summary":"Queue deleting discounts for 10 seconds (undo window), then delete like bulkDeleteDiscounts","tags":["discounts"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The store comes from the API key or OAuth token. Same as POST /v1/stores/{storeId}/discounts/bulk-delete-queue.","x-store-explicit-path":"/v1/stores/{storeId}/discounts/bulk-delete-queue"}},"/v1/stores/{storeId}/discounts/bulk-delete-queue":{"post":{"operationId":"queueDiscountsDeleteWithStoreId","summary":"Queue deleting discounts for 10 seconds (undo window), then delete like bulkDeleteDiscounts","tags":["discounts"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"}}},"required":["ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"marketing:write","x-api-key-scope":"marketing:write","description":"The explicit form of POST /v1/store/discounts/bulk-delete-queue, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/discounts/bulk-delete-queue"}},"/v1/stores/{storeId}/pending-actions":{"get":{"operationId":"listPendingActions","summary":"Actions still in their undo window, plus ones settled in the last minute (so a reload can show the outcome)","tags":["pending-actions"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPendingActionsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/pending-actions/{actionId}":{"get":{"operationId":"getPendingAction","summary":"One queued action: pending, committed, cancelled or failed","tags":["pending-actions"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","pattern":"^pact_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/pending-actions/{actionId}/undo":{"post":{"operationId":"undoPendingAction","summary":"Cancel a queued action before it commits (409 once it ran); needs the permission of the action itself","tags":["pending-actions"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","pattern":"^pact_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/store/products/{productId}/status":{"get":{"operationId":"getProductStatus","summary":"The product's one status: badge, label, note (the open incident's title while one is open) and auto-pause","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductStatusResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/status.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/status"}},"/v1/stores/{storeId}/products/{productId}/status":{"get":{"operationId":"getProductStatusWithStoreId","summary":"The product's one status: badge, label, note (the open incident's title while one is open) and auto-pause","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductStatusResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/status, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/status"}},"/v1/stores/{storeId}/fraud/explain":{"get":{"operationId":"explainBuyerRisk","summary":"Why an order or a customer was blocked, held or sent to review: the trace with thresholds and signal sources","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"customerId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerRiskExplanation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:read"}},"/v1/stores/{storeId}/fraud/allow-buyer":{"post":{"operationId":"allowFraudBuyer","summary":"Put an order's or a customer's email, device or IP on the allowlist (recorded in the audit log)","tags":["fraud"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"default":null,"anyOf":[{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"customerId":{"default":null,"anyOf":[{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"kinds":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["email","device","ip"]}},"reason":{"default":"","type":"string","maxLength":200}},"required":["kinds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowBuyerResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"fraud:write"}},"/v1/store/payments/limits":{"get":{"operationId":"getPaymentLimits","summary":"Order limits per payment method: yours, ShopFast's caps for your currency and what checkout enforces","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLimitsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/payments/limits.","x-store-explicit-path":"/v1/stores/{storeId}/payments/limits"},"put":{"operationId":"savePaymentLimits","summary":"Set the smallest and largest order each kind of payment takes, and the card limit for first orders (clamped to ShopFast's caps)","tags":["payments"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"methods":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["card","paypal","crypto","bank"]},"additionalProperties":{"type":"object","properties":{"minMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"maxMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]}},"required":["minMinor","maxMinor"]}},"newBuyerCardMaxMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLimitsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/payments/limits.","x-store-explicit-path":"/v1/stores/{storeId}/payments/limits"}},"/v1/stores/{storeId}/payments/limits":{"get":{"operationId":"getPaymentLimitsWithStoreId","summary":"Order limits per payment method: yours, ShopFast's caps for your currency and what checkout enforces","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLimitsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The explicit form of GET /v1/store/payments/limits, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/limits"},"put":{"operationId":"savePaymentLimitsWithStoreId","summary":"Set the smallest and largest order each kind of payment takes, and the card limit for first orders (clamped to ShopFast's caps)","tags":["payments"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"methods":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["card","paypal","crypto","bank"]},"additionalProperties":{"type":"object","properties":{"minMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"maxMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]}},"required":["minMinor","maxMinor"]}},"newBuyerCardMaxMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLimitsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of PUT /v1/store/payments/limits, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/payments/limits"}},"/v1/admin/payment-limits":{"get":{"operationId":"adminGetMethodCaps","summary":"Hard caps per payment method and currency that no store can go past","tags":["admin payment-limits"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformMethodCapsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"adminSetMethodCaps","summary":"Owner or finance: set the hard caps per payment method and currency","tags":["admin payment-limits"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"byCurrency":{"default":{},"type":"object","propertyNames":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"additionalProperties":{"type":"object","propertyNames":{"type":"string","enum":["card","paypal","crypto","bank"]},"additionalProperties":{"type":"object","properties":{"minMinor":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"maxMinor":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]}},"required":["minMinor","maxMinor"]}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformMethodCapsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/carts/{cartId}/auto-renew":{"get":{"operationId":"storefrontAutoRenewOffers","summary":"The \"Renew automatically\" boxes for a cart: subscriptions and duration keys whose seller allows auto-renew","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"cartId","in":"path","required":true,"schema":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoRenewOffers"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/auto-renew":{"get":{"operationId":"buyerAutoRenewList","summary":"The signed-in buyer's subscriptions with the next charge, the card on file and auto-renew state","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerAutoRenewList"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/subscriptions/{subscriptionId}/auto-renew":{"post":{"operationId":"buyerSetAutoRenew","summary":"Turn auto-renew off, or back on with the card on file (the sentence shown is stored as consent)","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","pattern":"^sub_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"on":{"type":"boolean"},"consentText":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]}},"required":["on"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerAutoRenewSubscription"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/account/subscriptions/{subscriptionId}/payment-method":{"post":{"operationId":"buyerStartCardUpdate","summary":"Start saving a new card or PayPal account for this subscription: the store's own card step (Stripe) or PayPal's page","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","pattern":"^sub_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerStartCardUpdateResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/payment-setups/{setupId}/complete":{"post":{"operationId":"buyerCompleteCardUpdate","summary":"Back from the provider: read the new payment method from the provider and put it on the subscription","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"setupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pms_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCompleteCardUpdateResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/sandbox/stores/{storeId}/payment-setups/{setupId}":{"post":{"operationId":"sandboxCompleteSetup","summary":"Sandbox gateway: save a test card for renewals (dev and test only)","tags":["sandbox"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"setupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pms_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"testCard":{"type":"string","enum":["success","declined","authentication_required","expired_card"]}},"required":["testCard"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/products/{productId}/auto-renew":{"get":{"operationId":"getProductAutoRenew","summary":"Auto-renew for one product: whether buyers can opt in, the dunning schedule and who renews","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAutoRenewView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/products/{productId}/auto-renew.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/auto-renew"},"put":{"operationId":"saveProductAutoRenew","summary":"Allow auto-renew on a subscription or duration product and set its retry days","tags":["products"],"security":[{"apiKey":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowed":{"type":"boolean"},"retryDays":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"integer","minimum":1,"maximum":30}},"graceDays":{"type":"integer","minimum":0,"maximum":30}},"required":["allowed","retryDays","graceDays"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAutoRenewView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/products/{productId}/auto-renew.","x-store-explicit-path":"/v1/stores/{storeId}/products/{productId}/auto-renew"}},"/v1/stores/{storeId}/products/{productId}/auto-renew":{"get":{"operationId":"getProductAutoRenewWithStoreId","summary":"Auto-renew for one product: whether buyers can opt in, the dunning schedule and who renews","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAutoRenewView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:read","x-api-key-scope":"catalog:read","description":"The explicit form of GET /v1/store/products/{productId}/auto-renew, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/auto-renew"},"put":{"operationId":"saveProductAutoRenewWithStoreId","summary":"Allow auto-renew on a subscription or duration product and set its retry days","tags":["products"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowed":{"type":"boolean"},"retryDays":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"integer","minimum":1,"maximum":30}},"graceDays":{"type":"integer","minimum":0,"maximum":30}},"required":["allowed","retryDays","graceDays"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductAutoRenewView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"catalog:write","x-api-key-scope":"catalog:write","description":"The explicit form of PUT /v1/store/products/{productId}/auto-renew, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/products/{productId}/auto-renew"}},"/v1/store/orders/{orderId}/auto-renew":{"get":{"operationId":"listOrderAutoRenew","summary":"Subscriptions this order started or renewed, with auto-renew state, charges and the audit trail","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAutoRenewList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/orders/{orderId}/auto-renew.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/auto-renew"}},"/v1/stores/{storeId}/orders/{orderId}/auto-renew":{"get":{"operationId":"listOrderAutoRenewWithStoreId","summary":"Subscriptions this order started or renewed, with auto-renew state, charges and the audit trail","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAutoRenewList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/orders/{orderId}/auto-renew, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/auto-renew"}},"/v1/store/customers/{customerId}/auto-renew":{"get":{"operationId":"listCustomerAutoRenew","summary":"A customer's subscriptions with auto-renew state","tags":["customers"],"security":[{"apiKey":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAutoRenewList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:read","x-api-key-scope":"customers:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/customers/{customerId}/auto-renew.","x-store-explicit-path":"/v1/stores/{storeId}/customers/{customerId}/auto-renew"}},"/v1/stores/{storeId}/customers/{customerId}/auto-renew":{"get":{"operationId":"listCustomerAutoRenewWithStoreId","summary":"A customer's subscriptions with auto-renew state","tags":["customers"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAutoRenewList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"customers:read","x-api-key-scope":"customers:read","description":"The explicit form of GET /v1/store/customers/{customerId}/auto-renew, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/customers/{customerId}/auto-renew"}},"/v1/stores/{storeId}/subscriptions/{subscriptionId}/auto-renew/stop":{"post":{"operationId":"sellerStopAutoRenew","summary":"Stop charging a buyer automatically; their renewals go out as an emailed pay link","tags":["subscriptions"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","pattern":"^sub_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/store/analytics/auto-renew":{"get":{"operationId":"getAutoRenewMetrics","summary":"Recurring revenue from auto-renewing subscriptions (MRR), retries and recoveries","tags":["analytics"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoRenewMetrics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/analytics/auto-renew.","x-store-explicit-path":"/v1/stores/{storeId}/analytics/auto-renew"}},"/v1/stores/{storeId}/analytics/auto-renew":{"get":{"operationId":"getAutoRenewMetricsWithStoreId","summary":"Recurring revenue from auto-renewing subscriptions (MRR), retries and recoveries","tags":["analytics"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoRenewMetrics"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"analytics:read","x-api-key-scope":"analytics:read","description":"The explicit form of GET /v1/store/analytics/auto-renew, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/analytics/auto-renew"}},"/v1/admin/auto-renew/gateways":{"get":{"operationId":"adminAutoRenewGateways","summary":"Auto-renew on or off per gateway","tags":["admin auto-renew"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoRenewGatewaysView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"adminSetAutoRenewGateway","summary":"Owner or finance: turn auto-renew on or off for one gateway","tags":["admin auto-renew"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},"enabled":{"type":"boolean"}},"required":["provider","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoRenewGatewaysView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}/card":{"get":{"operationId":"storefrontCardCheckout","summary":"The card step of a checkout: amount, lines and what Stripe.js needs to show the card fields on the store page","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardCheckoutView"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/checkouts/{sessionId}/card/finalize":{"post":{"operationId":"storefrontCardFinalize","summary":"After the browser confirmed the card: read the payment back from the provider and record the order (idempotent)","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,100}$"}},"required":["access"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardFinalizeResult"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/storefront/stores/{storeId}/payment-setups/{setupId}/card":{"get":{"operationId":"buyerCardSetup","summary":"The signed-in buyer's \"update card\" step: what Stripe.js needs to save a card for renewals on the store page","tags":["storefront"],"security":[],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"setupId","in":"path","required":true,"schema":{"type":"string","pattern":"^pms_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardSetupView"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/ai-credits":{"get":{"operationId":"getAiCredits","summary":"AI credits: the store's balance, what AI actions reserve, recent usage and top-ups","tags":["ai-credits"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiCreditsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/ai-credits/transfers":{"post":{"operationId":"transferToAiCredits","summary":"Move money from the withdrawable ShopFast Pay balance into AI credits. One way: AI credit never moves back to the balance.","tags":["ai-credits"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMinor":{"type":"integer","minimum":1,"maximum":100000000},"idempotencyKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["amountMinor","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiCreditTransferResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/stores/{storeId}/ai-credits/top-ups":{"post":{"operationId":"startAiTopUp","summary":"Start a top-up: a card payment on ShopFast's Stripe account, confirmed on the dashboard page","tags":["ai-credits"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountCents":{"type":"integer","minimum":100,"maximum":1000000}},"required":["amountCents"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiTopUpStart"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/stores/{storeId}/ai-credits/top-ups/{topUpId}/finalize":{"post":{"operationId":"finalizeAiTopUp","summary":"After the card was confirmed: read the payment back and credit the balance once (the webhook does the same)","tags":["ai-credits"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"topUpId","in":"path","required":true,"schema":{"type":"string","pattern":"^aitu_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiTopUpResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:write"}},"/v1/admin/stores/{storeId}/ai-credits":{"get":{"operationId":"adminGetAiCredits","summary":"A store's AI balance, its full ledger and top-ups","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAiCredits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/ai-credits/adjustments":{"post":{"operationId":"adminAdjustAiCredits","summary":"Credit or debit a store's AI balance by hand, with a note (audited)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMicroUsd":{"type":"integer","minimum":-1000000000,"maximum":1000000000},"note":{"type":"string","minLength":3,"maxLength":500}},"required":["amountMicroUsd","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAiCredits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/ai-credits/grants":{"post":{"operationId":"adminGrantAiCredits","summary":"Give a store free AI credit (spent first, never withdrawable; audited)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountMicroUsd":{"type":"integer","minimum":10000,"maximum":1000000000},"note":{"default":"","type":"string","maxLength":200}},"required":["amountMicroUsd"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAiCredits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/assistant/ask":{"post":{"operationId":"askAssistant","summary":"Ask AI: a question about ShopFast or this store, answered from ShopFast's docs and the store's own data within your role; changes come back as previews to apply. Streams events (text/event-stream) and draws on the store's AI credits. 402 without credits, 429 over the rate limit","tags":["assistant"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string","minLength":1,"maxLength":2000},"history":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"text":{"type":"string","maxLength":6000}},"required":["role","text"]}},"page":{"default":null,"anyOf":[{"type":"object","properties":{"path":{"type":"string","maxLength":300,"pattern":"^\\/"},"title":{"type":"string","maxLength":80}},"required":["path","title"]},{"type":"null"}]},"pages":{"default":[],"maxItems":120,"type":"array","items":{"type":"object","properties":{"href":{"type":"string","maxLength":80,"pattern":"^\\/[A-Za-z0-9/_-]*$"},"label":{"type":"string","minLength":1,"maxLength":60},"group":{"type":"string","maxLength":40}},"required":["href","label","group"]}},"locale":{"default":null,"anyOf":[{"type":"string","maxLength":35,"pattern":"^[A-Za-z]{2,3}(-[A-Za-z0-9]{1,8})*$"},{"type":"null"}]},"attachments":{"default":[],"maxItems":4,"type":"array","items":{"type":"object","properties":{"uploadId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"name":{"type":"string","minLength":1,"maxLength":200},"contentType":{"type":"string","maxLength":100}},"required":["uploadId","name","contentType"]}},"mode":{"default":"panel","type":"string","enum":["panel","builder"]},"conversationId":{"default":null,"anyOf":[{"type":"string","pattern":"^aicv_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["question"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantAnswer"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"ai:write"}},"/v1/stores/{storeId}/assistant/actions/{actionId}/apply":{"post":{"operationId":"applyAssistantAction","summary":"Apply a change Ask AI proposed (only the member it was proposed to). A `confirm` change needs confirmed: true. 409 when it was already applied, dismissed or expired","tags":["assistant"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","pattern":"^aiac_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"default":false,"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"ai:write"}},"/v1/stores/{storeId}/assistant/actions/{actionId}/discard":{"post":{"operationId":"discardAssistantAction","summary":"Dismiss a change Ask AI proposed","tags":["assistant"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","pattern":"^aiac_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantAction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"ai:write"}},"/v1/stores/{storeId}/ai-data":{"get":{"operationId":"getAiDataSettings","summary":"Whether this store's AI conversations help improve ShopFast's AI (on unless the owner turns it off), and how long they are kept","tags":["ai-data"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiDataSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/ai-data/training":{"put":{"operationId":"setAiTraining","summary":"Owner only: let this store's AI conversations help improve ShopFast's AI (on by default; turning it on again counts from then), or stop (turning it off also withdraws everything collected so far)","tags":["ai-data"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiDataSettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/stores/{storeId}/ai/turns/{turnId}/feedback":{"put":{"operationId":"rateAiTurn","summary":"Thumbs up or down (and an optional comment) on an AI answer you asked for","tags":["ai"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"turnId","in":"path","required":true,"schema":{"type":"string","pattern":"^aitn_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rating":{"anyOf":[{"type":"string","enum":["up","down"]},{"type":"null"}]},"comment":{"default":null,"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["rating"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiTurnFeedback"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"ai:write"}},"/v1/stores/{storeId}/ai/proposals/{proposalId}/decision":{"post":{"operationId":"decideAiProposal","summary":"Record that a theme AI proposal was discarded (applying it is recorded with the theme save)","tags":["ai"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"proposalId","in":"path","required":true,"schema":{"type":"string","pattern":"^aipr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","const":"rejected"}},"required":["decision"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"ai:write"}},"/v1/stores/{storeId}/ai-usage":{"get":{"operationId":"getAiUsage","summary":"Where the store's AI credits went: totals by tool, by teammate and by day for a period, and each charge with what was asked (filter by area or teammate; page with cursor)","tags":["ai-usage"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"period","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d","365d"]}},{"name":"area","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"member","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["when","request","result","tokens","cost"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiUsageReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"member"}},"/v1/admin/ai-usage":{"get":{"operationId":"adminGetAiUsage","summary":"AI across every store for a period: what was charged and what the models cost, by tool, model, store and day, and what sellers did with the previews (owner and finance admins)","tags":["admin ai-usage"],"security":[{"adminSession":[]}],"parameters":[{"name":"period","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d","365d"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAiUsageReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/ai-usage/stores":{"get":{"operationId":"adminListAiStores","summary":"Every store that used AI in a period: requests, members, charges, free credit and the tool it uses most, searchable and sorted by any column (owner and finance admins)","tags":["admin ai-usage"],"security":[{"adminSession":[]}],"parameters":[{"name":"period","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d","365d"]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"surface","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["ask_ai","builder_change","builder_store","builder_copy","theme_edit"]},{"type":"null"}]}},{"name":"training","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","in","out"]}},{"name":"sort","in":"query","required":false,"schema":{"default":"charged","type":"string","enum":["store","requests","members","charged","free","top","last","training"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAiStorePage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/ai-usage/conversations":{"get":{"operationId":"adminListAiConversations","summary":"AI conversations (owner and support admins) by store, tool, period or what was asked, sorted by any column (last active first by default)","tags":["admin ai-usage"],"security":[{"adminSession":[]}],"parameters":[{"name":"period","in":"query","required":false,"schema":{"default":"30d","type":"string","enum":["7d","30d","90d","365d"]}},{"name":"storeId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"surface","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["ask_ai","builder_change","builder_store","builder_copy","theme_edit"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":120}},{"name":"sort","in":"query","required":false,"schema":{"default":"when","type":"string","enum":["store","area","request","turns","cost","applied","thumbs","when"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListAiConversationsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/ai-usage/conversations/{conversationId}":{"get":{"operationId":"adminGetAiConversation","summary":"One AI conversation in full: every turn's messages, the previews and what the seller did with them, feedback and cost (owner and support admins)","tags":["admin ai-usage"],"security":[{"adminSession":[]}],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string","pattern":"^aicv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAiConversation"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/client-errors":{"post":{"operationId":"reportClientErrors","summary":"Internal: the ShopFast dashboard, admin and storefront report their own errors (rate limited, 64 KB)","tags":["client-errors"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string","enum":["dashboard","admin","storefront"]},"release":{"type":"string","pattern":"^[A-Za-z0-9._-]{1,64}$"},"sessionId":{"type":"string","pattern":"^[A-Za-z0-9_-]{8,40}$"},"reports":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["error","rejection","render","router","chunk","api","island"]},"message":{"type":"string","minLength":1,"maxLength":1000},"stack":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}]},"componentStack":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"path":{"type":"string","maxLength":300,"pattern":"^\\/"},"prevPath":{"anyOf":[{"type":"string","maxLength":300,"pattern":"^\\/"},{"type":"null"}]},"viewport":{"anyOf":[{"type":"string","pattern":"^\\d{1,5}x\\d{1,5}$"},{"type":"null"}]},"sinceLoadMs":{"type":"integer","minimum":0,"maximum":2147483647},"visible":{"type":"boolean"},"count":{"type":"integer","minimum":1,"maximum":100000},"storeId":{"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"userId":{"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"method":{"anyOf":[{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]},{"type":"null"}]},"status":{"anyOf":[{"type":"integer","minimum":100,"maximum":599},{"type":"null"}]}},"required":["kind","message","stack","componentStack","path","prevPath","viewport","sinceLoadMs","visible","count","storeId","userId","method","status"],"additionalProperties":false}}},"required":["app","release","sessionId","reports"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientErrorAccepted"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/errors":{"get":{"operationId":"adminListErrors","summary":"Owner or support: errors from the browsers, the API, the storefront and the worker, grouped, newest first","tags":["admin errors"],"security":[{"adminSession":[]}],"parameters":[{"name":"window","in":"query","required":false,"schema":{"default":"24h","type":"string","enum":["1h","24h","7d","14d"]}},{"name":"app","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["dashboard","admin","storefront","api","worker"]},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["error","rejection","render","router","chunk","api","island","server","job"]},{"type":"null"}]}},{"name":"release","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9._-]{1,64}$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"seen","type":"string","enum":["error","count","seen","release","path"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListErrorsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/errors/{errorId}":{"get":{"operationId":"adminGetError","summary":"Owner or support: one error report in full (stack, component stack, path, user agent) and its latest occurrences","tags":["admin errors"],"security":[{"adminSession":[]}],"parameters":[{"name":"errorId","in":"path","required":true,"schema":{"type":"string","pattern":"^err_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminGetErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/economy/subscriptions":{"get":{"operationId":"adminEconomySubscriptions","summary":"Owner or finance: ShopFast plan payments in a window, MRR now and over the window, and where each store’s plan stands","tags":["admin economy"],"security":[{"adminSession":[]}],"parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"currency","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomySubscriptions"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/economy/commission":{"get":{"operationId":"adminEconomyCommission","summary":"Owner or finance: fees ShopFast earned in a window (ShopFast Pay, own gateways, payouts) net of refunds and lost disputes, per store","tags":["admin economy"],"security":[{"adminSession":[]}],"parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"currency","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomyCommission"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/economy/owed":{"get":{"operationId":"adminEconomyOwed","summary":"Owner or finance: what ShopFast holds for each store now (clearing, available, reserve, disputes, in flight), next payouts, payouts in a window","tags":["admin economy"],"security":[{"adminSession":[]}],"parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"currency","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomyOwed"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/economy/ai-credits":{"get":{"operationId":"adminEconomyAiCredits","summary":"Owner or finance: AI credit top-ups in a window, balances left, usage and margin (US dollars)","tags":["admin economy"],"security":[{"adminSession":[]}],"parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"currency","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomyAiCredits"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/economy/refunds":{"get":{"operationId":"adminEconomyRefunds","summary":"Owner or finance: refunds and chargebacks in a window and what each took back from fees, tax and seller balances","tags":["admin economy"],"security":[{"adminSession":[]}],"parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"currency","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EconomyAdjustments"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/abuse-reports":{"post":{"operationId":"submitAbuseReport","summary":"Report illegal content or a policy breach on a ShopFast store, including copyright notices (rate limited per network)","tags":["abuse-reports"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["copyright","trademark","illegal_goods","stolen_goods","fraud","malware","personal_data","child_safety","sanctions","other"]},"store":{"default":"","type":"string","maxLength":200},"urls":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"string","maxLength":500,"pattern":"^https?:\\/\\/[^\\s<>\"]+$"}},"explanation":{"type":"string","minLength":30,"maxLength":5000},"reporterName":{"default":"","type":"string","maxLength":120},"reporterEmail":{"default":"","anyOf":[{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"string","const":""}]},"work":{"default":"","type":"string","maxLength":1000},"rightsHolder":{"default":"","type":"string","maxLength":200},"goodFaith":{"type":"boolean","const":true},"unauthorized":{"default":false,"type":"boolean"},"sworn":{"default":false,"type":"boolean"},"signature":{"default":"","type":"string","maxLength":120}},"required":["kind","urls","explanation","goodFaith"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbuseReportReceipt"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/abuse-reports":{"get":{"operationId":"adminListAbuseReports","summary":"Reports of illegal content and policy breaches, newest first, with counts per status","tags":["admin abuse-reports"],"security":[{"adminSession":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"default":"received","anyOf":[{"type":"string","enum":["received","reviewing","actioned","rejected"]},{"type":"string","const":"all"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["copyright","trademark","illegal_goods","stolen_goods","fraud","malware","personal_data","child_safety","sanctions","other"]},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"received","type":"string","enum":["report","store","reporter","received","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAbuseReportList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/abuse-reports/{reportId}":{"get":{"operationId":"adminGetAbuseReport","summary":"One report with everything the reporter sent and the decision so far","tags":["admin abuse-reports"],"security":[{"adminSession":[]}],"parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^abr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAbuseReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/abuse-reports/{reportId}/decision":{"post":{"operationId":"adminDecideAbuseReport","summary":"Owner or support: decide a report with a statement of reasons; takes down the chosen products or suspends the store when that is the action, emails the seller and the reporter","tags":["admin abuse-reports"],"security":[{"adminSession":[]}],"parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","pattern":"^abr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["reviewing","actioned","rejected"]},"action":{"default":"none","type":"string","enum":["none","content_removed","store_suspended","seller_warned"]},"reasons":{"default":"","type":"string","maxLength":5000},"removeProductIds":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}},"notifySeller":{"default":true,"type":"boolean"},"notifyReporter":{"default":true,"type":"boolean"}},"required":["status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAbuseReport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/step-up":{"get":{"operationId":"adminGetStepUp","summary":"Whether you can confirm sensitive actions with a two-factor code","tags":["admin step-up"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepUpStatus"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users":{"get":{"operationId":"adminListSellerAccounts","summary":"Seller accounts, newest first, searched by email, name or id","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","locked","unconfirmed","two_factor","google"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["user","created","email","signin","stores","seen","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListSellerAccountsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}":{"get":{"operationId":"adminGetSellerAccount","summary":"One seller account: sign-in state, sessions, stores, tickets, notes and admin actions","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/password-reset":{"post":{"operationId":"adminSendSellerPasswordReset","summary":"Owner or support: email the seller a password reset link (the normal 15-minute, single-use link)","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/email":{"put":{"operationId":"adminChangeSellerEmail","summary":"Owner, step-up: change the sign-in email (one account per mailbox). Confirmation is cleared, a link goes to the new address, the old one is told, every session ends.","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"reason":{"type":"string","minLength":3,"maxLength":500},"code":{"default":"","type":"string","maxLength":20}},"required":["email","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/email/resend-confirmation":{"post":{"operationId":"adminResendSellerConfirmation","summary":"Owner or support: send the email confirmation link again","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/email/confirm":{"post":{"operationId":"adminConfirmSellerEmail","summary":"Owner: mark the email confirmed (money features unlock)","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/two-factor/reset":{"post":{"operationId":"adminResetSellerTwoFactor","summary":"Owner, step-up: remove the authenticator and recovery codes (the seller is told)","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500},"code":{"default":"","type":"string","maxLength":20}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/google/unlink":{"post":{"operationId":"adminUnlinkSellerGoogle","summary":"Owner, step-up: disconnect Google sign-in. An account without a password gets a link to set one, so it keeps a way in.","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500},"code":{"default":"","type":"string","maxLength":20}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/sign-out":{"post":{"operationId":"adminSignOutSeller","summary":"Owner or support: end every session of the account","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/lock":{"post":{"operationId":"adminLockSeller","summary":"Owner, step-up: lock the account. No sign-in works (password, Google, sessions, API keys) until it is unlocked; the seller is emailed the reason.","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500},"code":{"default":"","type":"string","maxLength":20}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/unlock":{"post":{"operationId":"adminUnlockSeller","summary":"Owner, step-up: unlock the account (the seller is told)","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500},"code":{"default":"","type":"string","maxLength":20}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/name":{"put":{"operationId":"adminRenameSeller","summary":"Owner or support: change the display name","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["name","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/notes":{"post":{"operationId":"adminAddSellerNote","summary":"Owner or support: add a staff note (every admin reads them; sellers never do)","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerAccountResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/export":{"post":{"operationId":"adminExportSeller","summary":"Owner: what ShopFast holds about this seller, as JSON, for an access request (audited)","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/controls":{"get":{"operationId":"adminGetStoreControls","summary":"Team, address, test mode, custom domains, search index and staff notes of a store","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControls"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/handle-check":{"get":{"operationId":"adminCheckStoreHandle","summary":"Whether an address is free for this store (reserved and taken addresses, other stores' old ones)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"handle","in":"query","required":true,"schema":{"type":"string","maxLength":60}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCheckStoreHandleResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/handle":{"put":{"operationId":"adminChangeStoreHandle","summary":"Owner, step-up: change the store address. The old address keeps redirecting; caches are purged; the owner is told.","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},"reason":{"type":"string","minLength":3,"maxLength":500},"code":{"default":"","type":"string","maxLength":20}},"required":["handle","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/members/{userId}/role":{"put":{"operationId":"adminSetStoreMemberRole","summary":"Owner or support: change a member's role (never the owner's; ownership moves by transfer)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assignment":{"type":"object","properties":{"role":{"type":"string","enum":["admin","staff","support","finance","custom"]},"customRoleId":{"anyOf":[{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["role","customRoleId"]},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["assignment","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/members/{userId}/remove":{"post":{"operationId":"adminRemoveStoreMember","summary":"Owner or support: remove a member (never the owner); they are told","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/ownership":{"post":{"operationId":"adminTransferStoreOwnership","summary":"Owner, step-up: make an existing member the owner. The old owner stays as an admin member; both are told.","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},"reason":{"type":"string","minLength":3,"maxLength":500},"code":{"default":"","type":"string","maxLength":20}},"required":["userId","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/test-mode":{"put":{"operationId":"adminSetStoreTestMode","summary":"Owner or support: turn store-wide test mode on for a few hours (checkouts are simulated and marked test) or off; the owner is told","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"on":{"type":"boolean"},"hours":{"default":24,"anyOf":[{"type":"number","const":1},{"type":"number","const":24},{"type":"number","const":72}]},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["on","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/domains/{domainId}/remove":{"post":{"operationId":"adminRemoveStoreDomain","summary":"Owner or support: disconnect a custom domain (the store answers on its ShopFast address); the owner is told","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"domainId","in":"path","required":true,"schema":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/products":{"get":{"operationId":"adminListStoreProducts","summary":"A store's products with status and takedowns, newest first","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListStoreProductsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/products/{productId}/takedown":{"put":{"operationId":"adminSetProductTakedown","summary":"Owner or support: take a product down (archived, private and locked; the owner gets a statement of reasons) or lift a takedown","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"takenDown":{"type":"boolean"},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["takenDown","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSetProductTakedownResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/maintenance/purge-cache":{"post":{"operationId":"adminPurgeStoreCache","summary":"Owner or support: drop the store's cached storefront pages (storefront and edge)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"default":"","type":"string","maxLength":500}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/maintenance/rebuild-search":{"post":{"operationId":"adminRebuildStoreSearch","summary":"Owner or support: rebuild the store's search index from scratch (big stores finish in the background)","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"default":"","type":"string","maxLength":500}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRebuildStoreSearchResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/notes":{"post":{"operationId":"adminAddStoreNote","summary":"Owner or support: add a staff note to the store","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreControlsResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/tax-reviews":{"get":{"operationId":"adminListTaxReviews","summary":"ShopFast Pay products whose tax category lowers the tax (e-books, exempt), waiting for a check or decided","tags":["admin tax-reviews"],"security":[{"adminSession":[]}],"parameters":[{"name":"state","in":"query","required":false,"schema":{"default":"pending","type":"string","enum":["pending","decided"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListTaxReviewsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/tax-reviews/{productId}":{"put":{"operationId":"adminDecideTaxReview","summary":"Owner or finance: approve or decline a product's tax category (the store is told); a category the seller changed since is refused","tags":["admin tax-reviews"],"security":[{"adminSession":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"type":"string","enum":["digital_goods","ebook","software","saas","online_course","membership","service","exempt"]},"approve":{"type":"boolean"},"reason":{"default":"","type":"string","maxLength":500}},"required":["category","approve"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTaxReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/referrals":{"get":{"operationId":"getReferrals","summary":"The store's referral link, the terms, the stores it brought and what they earned it, month by month","tags":["referrals"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/referral":{"get":{"operationId":"adminGetStoreReferral","summary":"Which store brought this one (and on what terms), and how many stores it brought","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStoreReferral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/stores/{storeId}/referral/remove":{"post":{"operationId":"adminRemoveStoreReferral","summary":"Owner or finance: end this store's referral (self-referral, fraud). Nothing more is added; what was added stays","tags":["admin stores"],"security":[{"adminSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminStoreReferral"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/impersonations":{"post":{"operationId":"adminStartImpersonation","summary":"Owners and support: log in to the seller dashboard as a seller for 30 minutes (your two-factor; audited, the seller is not told)","tags":["admin impersonations"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"default":null,"anyOf":[{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"storeId":{"default":null,"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"reason":{"default":"","type":"string","maxLength":500},"code":{"default":"","type":"string","maxLength":20},"returnPath":{"default":"/","type":"string","maxLength":500,"pattern":"^\\/(?![/\\\\])[^\\s\\\\]*$"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonationHandoff"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/impersonation":{"post":{"operationId":"exchangeImpersonation","summary":"Dashboard: trade a Login as code for this browser's session cookie","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":20,"maxLength":200}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeImpersonationResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/auth/impersonation/end":{"post":{"operationId":"endImpersonation","summary":"Dashboard: end this browser's Login as session (only that one) and say which admin page to go back to","tags":["auth"],"security":[],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"how":{"default":"ended","type":"string","enum":["ended","signed_out"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndImpersonationResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/activity/sessions":{"post":{"operationId":"startActivitySession","summary":"Internal: the dashboard starts a visit; says whether page views are collected and whether this visit is recorded (sampled)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"storeId":{"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"device":{"type":"string","enum":["desktop","tablet","mobile"]},"viewportW":{"type":"integer","minimum":100,"maximum":10000},"viewportH":{"type":"integer","minimum":100,"maximum":10000}},"required":["storeId","device","viewportW","viewportH"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivitySessionStarted"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/activity/events":{"post":{"operationId":"recordActivityEvents","summary":"Internal: the dashboard's page views (route patterns, time on page) and clicks (element selectors), batched and rate limited","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","pattern":"^asn_[0-9a-hjkmnp-tv-z]{20}$"},"pageViews":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[a-z0-9]{8,32}$"},"route":{"type":"string","maxLength":400},"referrer":{"anyOf":[{"type":"string","maxLength":400},{"type":"null"}]},"storeId":{"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"enteredAt":{"type":"integer","minimum":1600000000000,"maximum":4102444800000},"durationMs":{"type":"integer","minimum":0,"maximum":21600000},"device":{"type":"string","enum":["desktop","tablet","mobile"]},"viewportW":{"type":"integer","minimum":100,"maximum":10000},"viewportH":{"type":"integer","minimum":100,"maximum":10000}},"required":["key","route","referrer","storeId","enteredAt","durationMs","device","viewportW","viewportH"]}},"clicks":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"at":{"type":"integer","minimum":1600000000000,"maximum":4102444800000},"route":{"type":"string","maxLength":400},"storeId":{"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]},"selector":{"type":"string","minLength":1,"maxLength":300,"pattern":"^[A-Za-z0-9 >.#:_()-]+$"},"rx":{"type":"number","minimum":0,"maximum":1},"ry":{"type":"number","minimum":0,"maximum":1},"px":{"type":"number","minimum":0,"maximum":1},"py":{"type":"integer","minimum":0,"maximum":200000},"viewportW":{"type":"integer","minimum":100,"maximum":10000},"device":{"type":"string","enum":["desktop","tablet","mobile"]}},"required":["at","route","storeId","selector","rx","ry","px","py","viewportW","device"]}}},"required":["sessionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityEventsAccepted"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/me/activity/sessions/{sessionId}/chunks":{"post":{"operationId":"uploadRecordingChunk","summary":"Internal: one gzip chunk of a sampled visit's masked screen recording (size capped; refused when recording is off)","tags":["me"],"security":[{"sellerSession":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^asn_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"seq":{"type":"integer","minimum":0,"maximum":100000},"events":{"type":"integer","minimum":1,"maximum":20000},"firstAt":{"type":"integer","minimum":1600000000000,"maximum":4102444800000},"lastAt":{"type":"integer","minimum":1600000000000,"maximum":4102444800000},"data":{"type":"string","minLength":4,"maxLength":699059,"pattern":"^[A-Za-z0-9+/]*={0,2}$"}},"required":["seq","events","firstAt","lastAt","data"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingChunkAccepted"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/activity":{"get":{"operationId":"adminGetUserActivity","summary":"Owner or support: everything a seller did, newest first: store changes, sign-ins and security events, admin actions and dashboard visits","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"kind","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","store","security","admin","navigation"]}},{"name":"storeId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},{"type":"null"}]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserActivityPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/journey":{"get":{"operationId":"adminGetUserJourney","summary":"Owner or support: where a seller goes in the dashboard: visits per day, top pages, common paths and where visits end","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"storeId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserJourney"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/sessions":{"get":{"operationId":"adminListUserSessions","summary":"Owner or support: a seller's dashboard visits, newest first, each as its path of pages with time spent","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"storeId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSessionsPage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/users/{userId}/activity-exclusion":{"put":{"operationId":"adminSetActivityExclusion","summary":"Owner or support: never record this seller's screen (or record them again); audited","tags":["admin users"],"security":[{"adminSession":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"excluded":{"type":"boolean"},"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["excluded","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordingExclusion"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/activity/replay-access":{"get":{"operationId":"adminGetReplayAccess","summary":"Whether this admin may watch screen recordings and whether the next one asks for their two-factor code","tags":["admin activity"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayAccess"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/activity/sessions/{sessionId}/replay":{"post":{"operationId":"adminOpenReplay","summary":"Owner, step-up once per admin session: open a visit's screen recording (chunk list, pages, clicks). Every opening is in the audit log.","tags":["admin activity"],"security":[{"adminSession":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^asn_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"default":"","type":"string","maxLength":20},"purpose":{"default":"replay","type":"string","enum":["replay","heatmap"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayManifest"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/activity/sessions/{sessionId}/replay/chunks/{seq}":{"get":{"operationId":"adminGetReplayChunk","summary":"Owner: one gzip chunk of a recording this admin opened in the last two hours","tags":["admin activity"],"security":[{"adminSession":[]}],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^asn_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"seq","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,6}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayChunk"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/activity/heatmap":{"get":{"operationId":"adminGetHeatmap","summary":"Owner or support: clicks on one dashboard route across every seller, by element and position, for a device class and window","tags":["admin activity"],"security":[{"adminSession":[]}],"parameters":[{"name":"route","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":200,"pattern":"^\\/(?:(?::[A-Za-z][A-Za-z0-9]{0,30}|[a-z][a-z0-9-]{0,39})(?:\\/(?::[A-Za-z][A-Za-z0-9]{0,30}|[a-z][a-z0-9-]{0,39}))*)?$"},{"type":"null"}]}},{"name":"device","in":"query","required":false,"schema":{"default":"desktop","type":"string","enum":["desktop","tablet","mobile"]}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Heatmap"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/activity":{"get":{"operationId":"adminGetActivityOverview","summary":"Owner or support: activity collection settings, excluded sellers and what is stored","tags":["admin activity"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/activity/settings":{"put":{"operationId":"adminUpdateActivitySettings","summary":"Owner: turn page views and clicks or screen recording on or off, and the share of visits recorded; audited","tags":["admin activity"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"analyticsEnabled":{"type":"boolean"},"recordingEnabled":{"type":"boolean"},"samplePercent":{"type":"integer","minimum":0,"maximum":100}},"required":["analyticsEnabled","recordingEnabled","samplePercent"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivitySettings"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/blog/posts":{"get":{"operationId":"adminListBlogPosts","summary":"Blog posts on shopfa.st/blog, newest first, with counts per status","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","published","draft"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["article","comparison"]},{"type":"null"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"status","type":"string","enum":["title","kind","size","status"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListBlogPostsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"adminCreateBlogPost","summary":"Owner or support: write a blog post (a draft, or published at once)","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"status":{"default":"draft","type":"string","enum":["draft","published"]},"title":{"type":"string","minLength":5,"maxLength":140},"answer":{"type":"string","minLength":20,"maxLength":400},"excerpt":{"type":"string","minLength":20,"maxLength":300},"body":{"default":"","type":"string","maxLength":100000},"cover":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"art"},"art":{"type":"string","enum":["versus","stack","ribbon","grid"]},"hue":{"type":"integer","minimum":0,"maximum":360}},"required":["kind","art","hue"]},{"type":"object","properties":{"kind":{"type":"string","const":"image"},"src":{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},"alt":{"type":"string","minLength":1,"maxLength":300},"width":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]},"height":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]}},"required":["kind","src","alt"]}]},"authorName":{"default":"ShopFast team","type":"string","minLength":2,"maxLength":80},"tags":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":2,"maxLength":32,"pattern":"^[a-z0-9][a-z0-9 -]*$"}},"seoTitle":{"default":"","type":"string","maxLength":70},"seoDescription":{"default":"","type":"string","maxLength":170},"ogImage":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},{"type":"null"}]},"canonicalUrl":{"default":null,"anyOf":[{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"},{"type":"null"}]},"noindex":{"default":false,"type":"boolean"},"publishedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"faq":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"question":{"type":"string","minLength":3,"maxLength":300},"answer":{"type":"string","minLength":3,"maxLength":2000}},"required":["question","answer"]}},"comparison":{"default":null,"anyOf":[{"type":"object","properties":{"competitor":{"type":"string","minLength":1,"maxLength":60},"caption":{"default":"","type":"string","maxLength":300},"rows":{"minItems":1,"maxItems":40,"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","minLength":1,"maxLength":200},"shopfast":{"type":"string","maxLength":500},"competitor":{"type":"string","maxLength":500}},"required":["feature","shopfast","competitor"]}}},"required":["competitor","rows"]},{"type":"null"}]},"chart":{"default":null,"anyOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":140},"caption":{"default":"","type":"string","maxLength":400},"bars":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":80},"value":{"type":"number","minimum":0,"maximum":1000000000},"display":{"default":"","type":"string","maxLength":40},"highlight":{"default":false,"type":"boolean"}},"required":["label","value"]}}},"required":["title","bars"]},{"type":"null"}]},"video":{"default":null,"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"embed"},"url":{"type":"string","maxLength":500},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","url","title"]},{"type":"object","properties":{"kind":{"type":"string","const":"file"},"src":{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},"poster":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","src","title"]}]},{"type":"null"}]},"howTo":{"default":null,"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":200},"steps":{"minItems":2,"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"text":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","text"]}}},"required":["name","steps"]},{"type":"null"}]},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":200},"url":{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"}},"required":["label","url"]}},"checkedOn":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"related":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}}},"required":["slug","title","answer","excerpt","cover"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBlogPost"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/blog/posts/{postId}":{"get":{"operationId":"adminGetBlogPost","summary":"One blog post with everything the editor shows","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string","pattern":"^blg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBlogPost"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"put":{"operationId":"adminUpdateBlogPost","summary":"Owner or support: save a blog post (publish, unpublish, edit). A changed address keeps the old one as a redirect. Live on the site at once","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string","pattern":"^blg_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"status":{"default":"draft","type":"string","enum":["draft","published"]},"title":{"type":"string","minLength":5,"maxLength":140},"answer":{"type":"string","minLength":20,"maxLength":400},"excerpt":{"type":"string","minLength":20,"maxLength":300},"body":{"default":"","type":"string","maxLength":100000},"cover":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"art"},"art":{"type":"string","enum":["versus","stack","ribbon","grid"]},"hue":{"type":"integer","minimum":0,"maximum":360}},"required":["kind","art","hue"]},{"type":"object","properties":{"kind":{"type":"string","const":"image"},"src":{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},"alt":{"type":"string","minLength":1,"maxLength":300},"width":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]},"height":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]}},"required":["kind","src","alt"]}]},"authorName":{"default":"ShopFast team","type":"string","minLength":2,"maxLength":80},"tags":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":2,"maxLength":32,"pattern":"^[a-z0-9][a-z0-9 -]*$"}},"seoTitle":{"default":"","type":"string","maxLength":70},"seoDescription":{"default":"","type":"string","maxLength":170},"ogImage":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},{"type":"null"}]},"canonicalUrl":{"default":null,"anyOf":[{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"},{"type":"null"}]},"noindex":{"default":false,"type":"boolean"},"publishedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"faq":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"question":{"type":"string","minLength":3,"maxLength":300},"answer":{"type":"string","minLength":3,"maxLength":2000}},"required":["question","answer"]}},"comparison":{"default":null,"anyOf":[{"type":"object","properties":{"competitor":{"type":"string","minLength":1,"maxLength":60},"caption":{"default":"","type":"string","maxLength":300},"rows":{"minItems":1,"maxItems":40,"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","minLength":1,"maxLength":200},"shopfast":{"type":"string","maxLength":500},"competitor":{"type":"string","maxLength":500}},"required":["feature","shopfast","competitor"]}}},"required":["competitor","rows"]},{"type":"null"}]},"chart":{"default":null,"anyOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":140},"caption":{"default":"","type":"string","maxLength":400},"bars":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":80},"value":{"type":"number","minimum":0,"maximum":1000000000},"display":{"default":"","type":"string","maxLength":40},"highlight":{"default":false,"type":"boolean"}},"required":["label","value"]}}},"required":["title","bars"]},{"type":"null"}]},"video":{"default":null,"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"embed"},"url":{"type":"string","maxLength":500},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","url","title"]},{"type":"object","properties":{"kind":{"type":"string","const":"file"},"src":{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},"poster":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","src","title"]}]},{"type":"null"}]},"howTo":{"default":null,"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":200},"steps":{"minItems":2,"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"text":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","text"]}}},"required":["name","steps"]},{"type":"null"}]},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":200},"url":{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"}},"required":["label","url"]}},"checkedOn":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"related":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}},"baseUpdatedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["slug","title","answer","excerpt","cover"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBlogPost"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"delete":{"operationId":"adminDeleteBlogPost","summary":"Owner or support: delete a blog post for good (its address then answers 404)","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string","pattern":"^blg_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/blog/preview":{"post":{"operationId":"adminPreviewBlogPost","summary":"The page a post would render as, for the editor's live preview. Saves nothing","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"status":{"default":"draft","type":"string","enum":["draft","published"]},"title":{"type":"string","minLength":5,"maxLength":140},"answer":{"type":"string","minLength":20,"maxLength":400},"excerpt":{"type":"string","minLength":20,"maxLength":300},"body":{"default":"","type":"string","maxLength":100000},"cover":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"art"},"art":{"type":"string","enum":["versus","stack","ribbon","grid"]},"hue":{"type":"integer","minimum":0,"maximum":360}},"required":["kind","art","hue"]},{"type":"object","properties":{"kind":{"type":"string","const":"image"},"src":{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},"alt":{"type":"string","minLength":1,"maxLength":300},"width":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]},"height":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]}},"required":["kind","src","alt"]}]},"authorName":{"default":"ShopFast team","type":"string","minLength":2,"maxLength":80},"tags":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":2,"maxLength":32,"pattern":"^[a-z0-9][a-z0-9 -]*$"}},"seoTitle":{"default":"","type":"string","maxLength":70},"seoDescription":{"default":"","type":"string","maxLength":170},"ogImage":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},{"type":"null"}]},"canonicalUrl":{"default":null,"anyOf":[{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"},{"type":"null"}]},"noindex":{"default":false,"type":"boolean"},"publishedAt":{"default":null,"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"faq":{"default":[],"maxItems":20,"type":"array","items":{"type":"object","properties":{"question":{"type":"string","minLength":3,"maxLength":300},"answer":{"type":"string","minLength":3,"maxLength":2000}},"required":["question","answer"]}},"comparison":{"default":null,"anyOf":[{"type":"object","properties":{"competitor":{"type":"string","minLength":1,"maxLength":60},"caption":{"default":"","type":"string","maxLength":300},"rows":{"minItems":1,"maxItems":40,"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","minLength":1,"maxLength":200},"shopfast":{"type":"string","maxLength":500},"competitor":{"type":"string","maxLength":500}},"required":["feature","shopfast","competitor"]}}},"required":["competitor","rows"]},{"type":"null"}]},"chart":{"default":null,"anyOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":140},"caption":{"default":"","type":"string","maxLength":400},"bars":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":80},"value":{"type":"number","minimum":0,"maximum":1000000000},"display":{"default":"","type":"string","maxLength":40},"highlight":{"default":false,"type":"boolean"}},"required":["label","value"]}}},"required":["title","bars"]},{"type":"null"}]},"video":{"default":null,"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"embed"},"url":{"type":"string","maxLength":500},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","url","title"]},{"type":"object","properties":{"kind":{"type":"string","const":"file"},"src":{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},"poster":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","src","title"]}]},{"type":"null"}]},"howTo":{"default":null,"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":200},"steps":{"minItems":2,"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"text":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","text"]}}},"required":["name","steps"]},{"type":"null"}]},"sources":{"default":[],"maxItems":30,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":200},"url":{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"}},"required":["label","url"]}},"checkedOn":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"related":{"default":[],"maxItems":4,"type":"array","items":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}}},"required":["slug","title","answer","excerpt","cover"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminPreviewBlogPostResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/blog/media":{"get":{"operationId":"adminListBlogMedia","summary":"Images and videos uploaded for the blog, newest first","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListBlogMediaResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}},"post":{"operationId":"adminStartBlogMedia","summary":"Owner or support: a signed upload link for an image or video for the blog","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"maxLength":160},"contentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","video/mp4","video/webm"]},"bytes":{"type":"integer","minimum":1,"maximum":209715200}},"required":["filename","contentType","bytes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartedBlogMedia"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/admin/blog/media/{mediaId}/complete":{"post":{"operationId":"adminCompleteBlogMedia","summary":"Owner or support: check the uploaded file (size, real type, pixels) and publish it","tags":["admin blog"],"security":[{"adminSession":[]}],"parameters":[{"name":"mediaId","in":"path","required":true,"schema":{"type":"string","pattern":"^bmd_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogMedia"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/store/gateways/gift-codes":{"get":{"operationId":"getGiftCodeSettings","summary":"Gift cards: the cards the store takes (the defaults until the first save) and how many codes wait for review","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCodeSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/gateways/gift-codes.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/gift-codes"},"put":{"operationId":"saveGiftCodeSettings","summary":"Gift cards: save the cards, their values, pictures and Eneba and G2A links (links are checked)","tags":["gateways"],"security":[{"apiKey":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"types":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,23}$"},"preset":{"type":"string","enum":["binance","steam","custom"]},"enabled":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":40},"image":{"default":null,"anyOf":[{"type":"object","properties":{"uploadId":{"type":"string","minLength":1,"maxLength":64},"url":{"type":"string","maxLength":1000,"format":"uri"}},"required":["uploadId","url"]},{"type":"null"}]},"currencies":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"unit":{"type":"string","minLength":1,"maxLength":8,"pattern":"^[A-Za-z0-9$\\u20AC\\u00A3\\u00A5\\u20B9 .-]+$"},"faces":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"valueMinor":{"type":"integer","minimum":1,"maximum":100000000},"links":{"type":"object","properties":{"eneba":{"type":"string","maxLength":500},"g2a":{"type":"string","maxLength":500}}}},"required":["valueMinor"]}}},"required":["currency","unit","faces"]}},"links":{"type":"object","properties":{"eneba":{"type":"string","maxLength":500},"g2a":{"type":"string","maxLength":500}}},"instructions":{"default":"","type":"string","maxLength":1000}},"required":["id","preset","enabled","name","currencies"]}},"change":{"default":"store_credit","type":"string","enum":["store_credit","none"]},"reviewHours":{"default":48,"type":"integer","minimum":1,"maximum":168}},"required":["types"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCodeSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The store comes from the API key or OAuth token. Same as PUT /v1/stores/{storeId}/gateways/gift-codes.","x-store-explicit-path":"/v1/stores/{storeId}/gateways/gift-codes"}},"/v1/stores/{storeId}/gateways/gift-codes":{"get":{"operationId":"getGiftCodeSettingsWithStoreId","summary":"Gift cards: the cards the store takes (the defaults until the first save) and how many codes wait for review","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCodeSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:read","x-api-key-scope":"payments:read","description":"The explicit form of GET /v1/store/gateways/gift-codes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/gift-codes"},"put":{"operationId":"saveGiftCodeSettingsWithStoreId","summary":"Gift cards: save the cards, their values, pictures and Eneba and G2A links (links are checked)","tags":["gateways"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"types":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,23}$"},"preset":{"type":"string","enum":["binance","steam","custom"]},"enabled":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":40},"image":{"default":null,"anyOf":[{"type":"object","properties":{"uploadId":{"type":"string","minLength":1,"maxLength":64},"url":{"type":"string","maxLength":1000,"format":"uri"}},"required":["uploadId","url"]},{"type":"null"}]},"currencies":{"minItems":1,"maxItems":8,"type":"array","items":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"unit":{"type":"string","minLength":1,"maxLength":8,"pattern":"^[A-Za-z0-9$\\u20AC\\u00A3\\u00A5\\u20B9 .-]+$"},"faces":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"valueMinor":{"type":"integer","minimum":1,"maximum":100000000},"links":{"type":"object","properties":{"eneba":{"type":"string","maxLength":500},"g2a":{"type":"string","maxLength":500}}}},"required":["valueMinor"]}}},"required":["currency","unit","faces"]}},"links":{"type":"object","properties":{"eneba":{"type":"string","maxLength":500},"g2a":{"type":"string","maxLength":500}}},"instructions":{"default":"","type":"string","maxLength":1000}},"required":["id","preset","enabled","name","currencies"]}},"change":{"default":"store_credit","type":"string","enum":["store_credit","none"]},"reviewHours":{"default":48,"type":"integer","minimum":1,"maximum":168}},"required":["types"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCodeSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"payments:write","x-api-key-scope":"payments:write","description":"The explicit form of PUT /v1/store/gateways/gift-codes, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/gateways/gift-codes"}},"/v1/stores/{storeId}/gift-code-reviews":{"get":{"operationId":"listGiftCodeReviews","summary":"Gift card codes buyers sent: waiting for review, accepted or rejected (never the codes themselves)","tags":["gift-code-reviews"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"status","in":"query","required":false,"schema":{"default":"pending","type":"string","enum":["pending","accepted","rejected"]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sessionId","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGiftCodeReviewsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read"}},"/v1/stores/{storeId}/gift-code-reviews/{reviewId}":{"get":{"operationId":"getGiftCodeReview","summary":"One gift card payment with its codes and receipt, to redeem them (recorded in the store’s activity)","tags":["gift-code-reviews"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^gcr_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCodeReviewDetail"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/stores/{storeId}/gift-code-reviews/{reviewId}/accept":{"post":{"operationId":"acceptGiftCode","summary":"The codes worked: the order is paid and delivered (and any difference becomes the buyer’s store credit)","tags":["gift-code-reviews"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^gcr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"default":"","type":"string","maxLength":280}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCodeReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/stores/{storeId}/gift-code-reviews/{reviewId}/reject":{"post":{"operationId":"rejectGiftCode","summary":"The codes did not work: the buyer is told why and may send another code, or the checkout closes","tags":["gift-code-reviews"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string","pattern":"^gcr_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":280},"allowRetry":{"default":true,"type":"boolean"}},"required":["reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCodeReview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:write"}},"/v1/stores/{storeId}/invoicing":{"get":{"operationId":"getInvoiceSettings","summary":"Invoice settings: the legal details, numbering, logo, footer, language and what buyers get","tags":["invoicing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"},"put":{"operationId":"updateInvoiceSettings","summary":"Save the invoice settings and the legal details (409 numbering-started when the start number changes after the first invoice)","tags":["invoicing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"prefix":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9/-]{0,15}$"},"creditNotePrefix":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9/-]{0,15}$"},"yearly":{"default":false,"type":"boolean"},"startNumber":{"default":1,"type":"integer","minimum":1,"maximum":99999999},"footer":{"default":"","type":"string","maxLength":600},"language":{"default":"en","type":"string","enum":["en","de","fr","es","it","nl","pt","pl"]},"matchBuyerLanguage":{"default":true,"type":"boolean"},"emailToBuyer":{"default":true,"type":"boolean"},"showLogo":{"default":true,"type":"boolean"},"logoKey":{"default":null,"anyOf":[{"type":"string","maxLength":400},{"type":"null"}]},"paper":{"default":"auto","type":"string","enum":["auto","a4","letter"]},"ownGatewayTax":{"default":"none","type":"string","enum":["none","included_buyer_rate","included_fixed","exempt"]},"fixedRateBps":{"default":0,"type":"integer","minimum":0,"maximum":10000},"exemptionNote":{"default":"","type":"string","maxLength":200}},"required":["prefix","creditNotePrefix"]},"legal":{"type":"object","properties":{"businessName":{"type":"string","maxLength":120},"registrationNumber":{"type":"string","maxLength":60},"vatNumber":{"type":"string","maxLength":40},"addressLine1":{"type":"string","maxLength":120},"addressLine2":{"type":"string","maxLength":120},"city":{"type":"string","maxLength":80},"postalCode":{"type":"string","maxLength":20},"region":{"type":"string","maxLength":80},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"required":["businessName","registrationNumber","vatNumber","addressLine1","addressLine2","city","postalCode","region","country"]}},"required":["settings","legal"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSettingsView"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"settings:write"}},"/v1/stores/{storeId}/invoicing/preview":{"post":{"operationId":"previewInvoice","summary":"A sample invoice PDF with these settings (nothing is saved or numbered)","tags":["invoicing"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"prefix":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9/-]{0,15}$"},"creditNotePrefix":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9/-]{0,15}$"},"yearly":{"default":false,"type":"boolean"},"startNumber":{"default":1,"type":"integer","minimum":1,"maximum":99999999},"footer":{"default":"","type":"string","maxLength":600},"language":{"default":"en","type":"string","enum":["en","de","fr","es","it","nl","pt","pl"]},"matchBuyerLanguage":{"default":true,"type":"boolean"},"emailToBuyer":{"default":true,"type":"boolean"},"showLogo":{"default":true,"type":"boolean"},"logoKey":{"default":null,"anyOf":[{"type":"string","maxLength":400},{"type":"null"}]},"paper":{"default":"auto","type":"string","enum":["auto","a4","letter"]},"ownGatewayTax":{"default":"none","type":"string","enum":["none","included_buyer_rate","included_fixed","exempt"]},"fixedRateBps":{"default":0,"type":"integer","minimum":0,"maximum":10000},"exemptionNote":{"default":"","type":"string","maxLength":200}},"required":["prefix","creditNotePrefix"]},"legal":{"type":"object","properties":{"businessName":{"type":"string","maxLength":120},"registrationNumber":{"type":"string","maxLength":60},"vatNumber":{"type":"string","maxLength":40},"addressLine1":{"type":"string","maxLength":120},"addressLine2":{"type":"string","maxLength":120},"city":{"type":"string","maxLength":80},"postalCode":{"type":"string","maxLength":20},"region":{"type":"string","maxLength":80},"country":{"anyOf":[{"type":"string","pattern":"^[A-Z]{2}$"},{"type":"null"}]}},"required":["businessName","registrationNumber","vatNumber","addressLine1","addressLine2","city","postalCode","region","country"]}},"required":["settings","legal"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewInvoiceResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/store/invoices":{"get":{"operationId":"listInvoices","summary":"Invoices and credit notes issued to buyers, newest first, with totals per currency","tags":["invoices"],"security":[{"apiKey":[]}],"parameters":[{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","invoice","credit_note"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"test","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"date","type":"string","enum":["date","number","buyer","order","net","tax","total"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/invoices.","x-store-explicit-path":"/v1/stores/{storeId}/invoices"}},"/v1/stores/{storeId}/invoices":{"get":{"operationId":"listInvoicesWithStoreId","summary":"Invoices and credit notes issued to buyers, newest first, with totals per currency","tags":["invoices"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"from","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"to","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]}},{"name":"kind","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","invoice","credit_note"]}},{"name":"q","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},{"name":"test","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"date","type":"string","enum":["date","number","buyer","order","net","tax","total"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/invoices, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/invoices"}},"/v1/store/invoices/{invoiceId}":{"get":{"operationId":"getInvoice","summary":"One invoice or credit note as issued","tags":["invoices"],"security":[{"apiKey":[]}],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/invoices/{invoiceId}.","x-store-explicit-path":"/v1/stores/{storeId}/invoices/{invoiceId}"}},"/v1/stores/{storeId}/invoices/{invoiceId}":{"get":{"operationId":"getInvoiceWithStoreId","summary":"One invoice or credit note as issued","tags":["invoices"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/invoices/{invoiceId}, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/invoices/{invoiceId}"}},"/v1/store/invoices/{invoiceId}/download":{"get":{"operationId":"downloadInvoice","summary":"A link to the PDF or the UBL 2.1 (EN 16931) XML","tags":["invoices"],"security":[{"apiKey":[]}],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"format","in":"query","required":false,"schema":{"default":"pdf","type":"string","enum":["pdf","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLink"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/invoices/{invoiceId}/download.","x-store-explicit-path":"/v1/stores/{storeId}/invoices/{invoiceId}/download"}},"/v1/stores/{storeId}/invoices/{invoiceId}/download":{"get":{"operationId":"downloadInvoiceWithStoreId","summary":"A link to the PDF or the UBL 2.1 (EN 16931) XML","tags":["invoices"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"format","in":"query","required":false,"schema":{"default":"pdf","type":"string","enum":["pdf","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLink"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/invoices/{invoiceId}/download, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/invoices/{invoiceId}/download"}},"/v1/stores/{storeId}/invoice-exports":{"get":{"operationId":"exportInvoices","summary":"A ZIP of a period: invoices.csv for the accountant plus each PDF and, optionally, UBL XML","tags":["invoice-exports"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"pdf","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]}},{"name":"xml","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]}},{"name":"test","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string","enum":["true","false"]}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceExport"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/store/orders/{orderId}/invoices":{"get":{"operationId":"listOrderInvoices","summary":"The order's invoice and credit notes","tags":["orders"],"security":[{"apiKey":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrderInvoicesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The store comes from the API key or OAuth token. Same as GET /v1/stores/{storeId}/orders/{orderId}/invoices.","x-store-explicit-path":"/v1/stores/{storeId}/orders/{orderId}/invoices"}},"/v1/stores/{storeId}/orders/{orderId}/invoices":{"get":{"operationId":"listOrderInvoicesWithStoreId","summary":"The order's invoice and credit notes","tags":["orders"],"security":[{"sellerSession":[]},{"apiKey":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"orderId","in":"path","required":true,"schema":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrderInvoicesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"orders:read","x-api-key-scope":"orders:read","description":"The explicit form of GET /v1/store/orders/{orderId}/invoices, with the store id in the path. Dashboard sessions use this form.","x-store-implicit-path":"/v1/store/orders/{orderId}/invoices"}},"/v1/stores/{storeId}/shopfast-invoices":{"get":{"operationId":"listPlatformInvoices","summary":"ShopFast's invoices to the store: plans, ShopFast Pay fees by month, AI credits","tags":["shopfast-invoices"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPlatformInvoicesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/stores/{storeId}/shopfast-invoices/{invoiceId}/download":{"get":{"operationId":"downloadPlatformInvoice","summary":"A link to one of ShopFast's invoices as PDF or UBL XML","tags":["shopfast-invoices"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","pattern":"^pinv_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"format","in":"query","required":false,"schema":{"default":"pdf","type":"string","enum":["pdf","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLink"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/stores/{storeId}/statements/download":{"get":{"operationId":"downloadStatement","summary":"A month of sales, fees, refunds and payouts as a PDF statement or CSV","tags":["statements"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"month","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"}},{"name":"format","in":"query","required":false,"schema":{"default":"pdf","type":"string","enum":["pdf","csv"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLink"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"finance:read"}},"/v1/storefront/checkouts/{sessionId}/documents":{"get":{"operationId":"storefrontOrderDocuments","summary":"The order's invoice and credit notes (with the order's access token or the signed-in buyer)","tags":["storefront"],"security":[],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"access","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDocuments"}}}},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}}}},"/v1/stores/{storeId}/headless":{"get":{"operationId":"getHeadlessOverview","summary":"MCP and Storefront API endpoints, AI access and counts","tags":["headless"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeadlessOverview"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/headless/keys":{"get":{"operationId":"listStorefrontKeys","summary":"Storefront API keys, newest first (or by name, kind or last use)","tags":["headless"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"sort","in":"query","required":false,"schema":{"default":"created","type":"string","enum":["created","name","kind","used"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStorefrontKeysResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"},"post":{"operationId":"createStorefrontKey","summary":"Create a storefront key. A private key's secret is in the response, once","tags":["headless"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"kind":{"type":"string","enum":["publishable","private"]},"allowedOrigins":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["name","kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStorefrontKeyResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/headless/keys/{keyId}":{"patch":{"operationId":"updateStorefrontKey","summary":"Rename a key or change its allowed origins","tags":["headless"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^sfk_[0-9a-hjkmnp-tv-z]{20}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"allowedOrigins":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontKey"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"},"delete":{"operationId":"revokeStorefrontKey","summary":"Revoke a key. It stops working at once","tags":["headless"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"keyId","in":"path","required":true,"schema":{"type":"string","pattern":"^sfk_[0-9a-hjkmnp-tv-z]{20}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:write"}},"/v1/stores/{storeId}/headless/mcp-calls":{"get":{"operationId":"listMcpCalls","summary":"MCP tool calls, newest first (or sorted by tool, AI tool, outcome, teammate or duration)","tags":["headless"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"server","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["seller","shop"]},{"type":"null"}]}},{"name":"outcome","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","enum":["ok","error","refused","invalid_input","confirmation_required","dry_run","replayed","rate_limited"]},{"type":"null"}]}},{"name":"client","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"tool","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"default":"","type":"string","maxLength":100}},{"name":"cursor","in":"query","required":false,"schema":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}},{"name":"sort","in":"query","required":false,"schema":{"default":"time","type":"string","enum":["time","tool","client","outcome","actor","duration"]}},{"name":"dir","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMcpCallsResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}},"/v1/stores/{storeId}/headless/mcp-usage":{"get":{"operationId":"getMcpUsage","summary":"MCP calls per day, per AI tool and per tool","tags":["headless"],"security":[{"sellerSession":[]}],"parameters":[{"name":"storeId","in":"path","required":true,"schema":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"string","pattern":"^-?\\d+$"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/McpUsage"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Invalid"},"429":{"$ref":"#/components/responses/TooManyRequests"},"default":{"$ref":"#/components/responses/Problem"}},"x-permission":"developers:read"}}},"components":{"schemas":{"AbTest":{"type":"object","properties":{"enabled":{"type":"boolean"},"subjectB":{"type":"string","maxLength":200},"testPercent":{"type":"integer","minimum":10,"maximum":100},"winnerBy":{"type":"string","enum":["opens","clicks"]},"decideAfterMinutes":{"type":"integer","minimum":30,"maximum":2880}},"required":["enabled","subjectB","testPercent","winnerBy","decideAfterMinutes"],"additionalProperties":false},"AbuseReportAction":{"type":"string","enum":["none","content_removed","store_suspended","seller_warned"]},"AbuseReportCounts":{"type":"object","propertyNames":{"$ref":"#/components/schemas/AbuseReportStatus"},"additionalProperties":{"type":"integer","minimum":0,"maximum":9007199254740991},"required":["received","reviewing","actioned","rejected"]},"AbuseReportId":{"type":"string","pattern":"^abr_[0-9a-hjkmnp-tv-z]{20}$"},"AbuseReportKind":{"type":"string","enum":["copyright","trademark","illegal_goods","stolen_goods","fraud","malware","personal_data","child_safety","sanctions","other"]},"AbuseReportProductRef":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"visibility":{"type":"string"},"removed":{"type":"boolean"}},"required":["id","name","slug","status","visibility","removed"],"additionalProperties":false},"AbuseReportReceipt":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AbuseReportId"},"receivedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","receivedAt"],"additionalProperties":false},"AbuseReportStatus":{"type":"string","enum":["received","reviewing","actioned","rejected"]},"AbuseReportStoreRef":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"type":"string"},"status":{"type":"string"}},"required":["id","name","handle","status"],"additionalProperties":false},"AcceptInviteResponse":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/StoreSummary"}},"required":["store"],"additionalProperties":false},"AccessContact":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"role":{"$ref":"#/components/schemas/MemberRoleKind"},"roleName":{"type":"string"}},"required":["name","email","role","roleName"],"additionalProperties":false},"AccessDecidedBy":{"type":"string","enum":["owner","role","policy_allow","policy_deny","two_factor","no_permission"]},"AccessDecision":{"type":"object","properties":{"allowed":{"type":"boolean"},"decidedBy":{"$ref":"#/components/schemas/AccessDecidedBy"},"policy":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"message":{"type":"string"},"trace":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTrace"}}},"required":["allowed","decidedBy","policy","message","trace"],"additionalProperties":false},"AccessPolicy":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"effect":{"$ref":"#/components/schemas/PolicyEffect"},"enabled":{"default":true,"type":"boolean"},"subjects":{"$ref":"#/components/schemas/PolicySubjects"},"permissions":{"minItems":1,"maxItems":40,"type":"array","items":{"$ref":"#/components/schemas/PermissionPattern"}},"conditions":{"$ref":"#/components/schemas/PolicyGroup"},"id":{"$ref":"#/components/schemas/AccessPolicyId"},"createdBy":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","description","effect","enabled","subjects","permissions","conditions","id","createdBy","createdAt","updatedAt"],"additionalProperties":false},"AccessPolicyId":{"type":"string","pattern":"^pol_[0-9a-hjkmnp-tv-z]{20}$"},"AccessSimulationResult":{"type":"object","properties":{"subject":{"type":"object","properties":{"name":{"type":"string"},"roleName":{"type":"string"},"department":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"twoFactor":{"type":"boolean"}},"required":["name","roleName","department","tags","twoFactor"],"additionalProperties":false},"attributes":{"$ref":"#/components/schemas/AttributeSnapshot"},"decision":{"anyOf":[{"$ref":"#/components/schemas/AccessDecision"},{"type":"null"}]},"matrix":{"type":"array","items":{"type":"object","properties":{"permission":{"$ref":"#/components/schemas/StorePermission"},"allowed":{"type":"boolean"},"decidedBy":{"$ref":"#/components/schemas/AccessDecidedBy"},"policy":{"type":["string","null"]}},"required":["permission","allowed","decidedBy","policy"],"additionalProperties":false}}},"required":["subject","attributes","decision","matrix"],"additionalProperties":false},"AccountEvent":{"type":"object","properties":{"id":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"},"kind":{"$ref":"#/components/schemas/AccountEventKind"},"method":{"anyOf":[{"$ref":"#/components/schemas/SignInMethod"},{"type":"null"}]},"ip":{"type":"string"},"country":{"type":["string","null"]},"browser":{"type":["string","null"]},"os":{"type":["string","null"]},"device":{"anyOf":[{"$ref":"#/components/schemas/DeviceClass"},{"type":"null"}]},"detail":{"type":["string","null"]},"store":{"anyOf":[{"$ref":"#/components/schemas/ActivityStoreRef"},{"type":"null"}]}},"required":["id","at","kind","method","ip","country","browser","os","device","detail","store"],"additionalProperties":false},"AccountEventKind":{"type":"string","enum":["sign_in","sign_in_failed","signed_out","password_changed","password_reset","email_change_requested","email_changed","two_factor_on","two_factor_off","recovery_codes_new","google_disconnected","session_revoked","other_sessions_revoked","api_key_created","api_key_revoked"]},"ActivationGuideSettings":{"type":"object","properties":{"heading":{"default":"How to activate your key","type":"string","minLength":1,"maxLength":60},"platforms":{"default":["steam","epic","battlenet","ea","ubisoft","riot","xbox","playstation","switch"],"minItems":1,"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/GuidePlatformSchema"}},"note":{"default":"","type":"string","maxLength":300},"openFirst":{"default":false,"type":"boolean"}},"required":["heading","platforms","note","openFirst"],"additionalProperties":false},"ActiveHours":{"type":"object","properties":{"days":{"minItems":1,"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"from":{"$ref":"#/components/schemas/ClockTime"},"to":{"$ref":"#/components/schemas/ClockTime"},"timezone":{"type":"string","maxLength":64}},"required":["days","from","to","timezone"],"additionalProperties":false},"ActivityEventsAccepted":{"type":"object","properties":{"pageViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stop":{"type":"string","enum":["none","visit","cap"]}},"required":["pageViews","clicks","stop"],"additionalProperties":false},"ActivityItem":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"store"},"id":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"},"store":{"$ref":"#/components/schemas/ActivityStoreRef"},"entry":{"$ref":"#/components/schemas/StoreAuditEntry"}},"required":["kind","id","at","store","entry"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"security"},"id":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"},"event":{"$ref":"#/components/schemas/AccountEvent"}},"required":["kind","id","at","event"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"admin"},"id":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"},"entry":{"$ref":"#/components/schemas/AuditEntry"}},"required":["kind","id","at","entry"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"navigation"},"id":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"},"session":{"$ref":"#/components/schemas/ActivitySession"}},"required":["kind","id","at","session"],"additionalProperties":false}]},"ActivityOverview":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ActivitySettings"},"exclusions":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"}},"required":["id","name","email"],"additionalProperties":false},"reason":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["user","reason","at"],"additionalProperties":false}},"stats":{"type":"object","properties":{"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recordings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recordingBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["sessions","pageViews","clicks","recordings","recordingBytes"],"additionalProperties":false}},"required":["settings","exclusions","stats"],"additionalProperties":false},"ActivitySession":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ActivitySessionId"},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"},"durationMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pages":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"device":{"$ref":"#/components/schemas/DeviceClass"},"browser":{"type":"string"},"os":{"type":"string"},"country":{"type":["string","null"]},"viewport":{"type":"object","properties":{"w":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["w","h"],"additionalProperties":false},"store":{"anyOf":[{"$ref":"#/components/schemas/ActivityStoreRef"},{"type":"null"}]},"entry":{"anyOf":[{"$ref":"#/components/schemas/DashboardRoute"},{"type":"null"}]},"exit":{"anyOf":[{"$ref":"#/components/schemas/DashboardRoute"},{"type":"null"}]},"recording":{"$ref":"#/components/schemas/RecordingState"}},"required":["id","startedAt","lastSeenAt","durationMs","pages","clicks","device","browser","os","country","viewport","store","entry","exit","recording"],"additionalProperties":false},"ActivitySessionId":{"type":"string","pattern":"^asn_[0-9a-hjkmnp-tv-z]{20}$"},"ActivitySessionStarted":{"type":"object","properties":{"sessionId":{"anyOf":[{"$ref":"#/components/schemas/ActivitySessionId"},{"type":"null"}]},"analytics":{"type":"boolean"},"recording":{"anyOf":[{"$ref":"#/components/schemas/RecordingPlan"},{"type":"null"}]}},"required":["sessionId","analytics","recording"],"additionalProperties":false},"ActivitySessionWithSteps":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ActivitySessionId"},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"},"durationMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pages":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"device":{"$ref":"#/components/schemas/DeviceClass"},"browser":{"type":"string"},"os":{"type":"string"},"country":{"type":["string","null"]},"viewport":{"type":"object","properties":{"w":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["w","h"],"additionalProperties":false},"store":{"anyOf":[{"$ref":"#/components/schemas/ActivityStoreRef"},{"type":"null"}]},"entry":{"anyOf":[{"$ref":"#/components/schemas/DashboardRoute"},{"type":"null"}]},"exit":{"anyOf":[{"$ref":"#/components/schemas/DashboardRoute"},{"type":"null"}]},"recording":{"$ref":"#/components/schemas/RecordingState"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ActivityStep"}},"moreSteps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","startedAt","lastSeenAt","durationMs","pages","clicks","device","browser","os","country","viewport","store","entry","exit","recording","steps","moreSteps"],"additionalProperties":false},"ActivitySettings":{"type":"object","properties":{"analyticsEnabled":{"type":"boolean"},"recordingEnabled":{"type":"boolean"},"samplePercent":{"type":"integer","minimum":0,"maximum":100},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["analyticsEnabled","recordingEnabled","samplePercent","updatedAt"],"additionalProperties":false},"ActivityStep":{"type":"object","properties":{"route":{"$ref":"#/components/schemas/DashboardRoute"},"at":{"$ref":"#/components/schemas/Timestamp"},"durationMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"store":{"anyOf":[{"$ref":"#/components/schemas/StoreId"},{"type":"null"}]}},"required":["route","at","durationMs","store"],"additionalProperties":false},"ActivityStoreRef":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"AdCampaignRow":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/AdPlatform"},"campaign":{"type":"string"},"impressions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ctrBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cpmMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cpcMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversions":{"type":"number"},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cpaMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"roasBps":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["platform","campaign","impressions","clicks","spendMinor","ctrBps","cpmMinor","cpcMinor","sessions","conversions","revenueMinor","cpaMinor","roasBps"],"additionalProperties":false},"AdImport":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdImportId"},"filename":{"type":"string"},"rows":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"from":{"anyOf":[{"$ref":"#/components/schemas/IsoDate"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/IsoDate"},{"type":"null"}]}},"required":["id","filename","rows","spendMinor","createdAt","from","to"],"additionalProperties":false},"AdImportId":{"type":"string","pattern":"^adi_[0-9a-hjkmnp-tv-z]{20}$"},"AdImportResult":{"type":"object","properties":{"importId":{"anyOf":[{"$ref":"#/components/schemas/AdImportId"},{"type":"null"}]},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"message":{"type":"string"}},"required":["line","message"],"additionalProperties":false}}},"required":["importId","imported","skipped","errors"],"additionalProperties":false},"AdPlatform":{"type":"string","enum":["google","meta","tiktok","x","reddit","microsoft","linkedin","pinterest","snapchat","youtube","discord","newsletter","other"]},"AdSpendId":{"type":"string","pattern":"^ads_[0-9a-hjkmnp-tv-z]{20}$"},"AdSpendRow":{"type":"object","properties":{"day":{"$ref":"#/components/schemas/IsoDate"},"platform":{"$ref":"#/components/schemas/AdPlatform"},"campaign":{"type":"string","minLength":1,"maxLength":100},"impressions":{"type":"integer","minimum":0,"maximum":1000000000},"clicks":{"type":"integer","minimum":0,"maximum":1000000000},"spendMinor":{"type":"integer","minimum":0,"maximum":100000000000},"id":{"$ref":"#/components/schemas/AdSpendId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"importId":{"anyOf":[{"$ref":"#/components/schemas/AdImportId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["day","platform","campaign","impressions","clicks","spendMinor","id","currency","importId","createdAt"],"additionalProperties":false},"AddBlocklistEntriesResponse":{"type":"object","properties":{"added":{"type":"array","items":{"$ref":"#/components/schemas/BlocklistEntry"}},"skipped":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"reason":{"type":"string"}},"required":["value","reason"],"additionalProperties":false}}},"required":["added","skipped"],"additionalProperties":false},"AddLicenseKeysResponse":{"type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skippedDuplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stock":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["added","skippedDuplicates","stock"],"additionalProperties":false},"AddSuppressionResponse":{"type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["added"],"additionalProperties":false},"AdjustStockResponse":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/InventoryRow"},"adjustment":{"$ref":"#/components/schemas/StockAdjustment"}},"required":["row","adjustment"],"additionalProperties":false},"AdminAbuseReport":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AbuseReportId"},"kind":{"$ref":"#/components/schemas/AbuseReportKind"},"status":{"$ref":"#/components/schemas/AbuseReportStatus"},"store":{"anyOf":[{"$ref":"#/components/schemas/AbuseReportStoreRef"},{"type":"null"}]},"storeGiven":{"type":"string"},"firstUrl":{"type":"string"},"reporter":{"type":"string"},"receivedAt":{"$ref":"#/components/schemas/Timestamp"},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"urls":{"type":"array","items":{"type":"string"}},"explanation":{"type":"string"},"reporterName":{"type":"string"},"reporterEmail":{"type":"string"},"work":{"type":"string"},"rightsHolder":{"type":"string"},"unauthorized":{"type":"boolean"},"sworn":{"type":"boolean"},"signature":{"type":"string"},"storeHistory":{"type":"object","properties":{"actioned":{"type":"integer","minimum":0,"maximum":9007199254740991},"copyrightActioned":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["actioned","copyrightActioned"],"additionalProperties":false},"action":{"anyOf":[{"$ref":"#/components/schemas/AbuseReportAction"},{"type":"null"}]},"reasons":{"type":"string"},"decidedBy":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"products":{"type":"array","items":{"$ref":"#/components/schemas/AbuseReportProductRef"}},"sellerNotified":{"type":"boolean"},"reporterNotified":{"type":"boolean"}},"required":["id","kind","status","store","storeGiven","firstUrl","reporter","receivedAt","decidedAt","urls","explanation","reporterName","reporterEmail","work","rightsHolder","unauthorized","sworn","signature","storeHistory","action","reasons","decidedBy","products","sellerNotified","reporterNotified"],"additionalProperties":false},"AdminAbuseReportList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminAbuseReportRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/AbuseReportCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"AdminAbuseReportRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AbuseReportId"},"kind":{"$ref":"#/components/schemas/AbuseReportKind"},"status":{"$ref":"#/components/schemas/AbuseReportStatus"},"store":{"anyOf":[{"$ref":"#/components/schemas/AbuseReportStoreRef"},{"type":"null"}]},"storeGiven":{"type":"string"},"firstUrl":{"type":"string"},"reporter":{"type":"string"},"receivedAt":{"$ref":"#/components/schemas/Timestamp"},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","kind","status","store","storeGiven","firstUrl","reporter","receivedAt","decidedAt"],"additionalProperties":false},"AdminAcceptInviteResponse":{"type":"object","properties":{"admin":{"$ref":"#/components/schemas/AdminUser"},"mfa":{"default":null,"anyOf":[{"$ref":"#/components/schemas/AdminSecondFactor"},{"type":"null"}]}},"required":["admin","mfa"],"additionalProperties":false},"AdminAddPlatformBlocklistResponse":{"type":"object","properties":{"added":{"type":"array","items":{"$ref":"#/components/schemas/PlatformBlocklistEntry"}},"skipped":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"reason":{"type":"string"}},"required":["value","reason"],"additionalProperties":false}}},"required":["added","skipped"],"additionalProperties":false},"AdminAiArea":{"type":"object","properties":{"area":{"type":"string"},"label":{"type":"string"},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"chargedMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"modelCostMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"freeMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"proposals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"applied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"appliedEdited":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ignored":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbsUp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbsDown":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["area","label","requests","stores","chargedMicroUsd","modelCostMicroUsd","freeMicroUsd","proposals","applied","appliedEdited","rejected","ignored","thumbsUp","thumbsDown"],"additionalProperties":false},"AdminAiConversation":{"type":"object","properties":{"conversation":{"$ref":"#/components/schemas/AdminAiConversationRow"},"context":{"$ref":"#/components/schemas/Shared2"},"turns":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiTurn"}}},"required":["conversation","context","turns"],"additionalProperties":false},"AdminAiConversationRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AiConversationId"},"storeId":{"type":"string"},"storeName":{"type":"string"},"member":{"type":["string","null"]},"surface":{"$ref":"#/components/schemas/AiSurface"},"label":{"type":"string"},"request":{"type":["string","null"]},"turns":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"costMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"proposals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"applied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbsUp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbsDown":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"trainingEligible":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","storeId","storeName","member","surface","label","request","turns","costMicroUsd","proposals","applied","thumbsUp","thumbsDown","trainingEligible","createdAt","updatedAt"],"additionalProperties":false},"AdminAiCredits":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"balanceMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"reservedMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"promoMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"toppedUpMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"transferredMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"grantedMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"spentMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"ledger":{"type":"array","items":{"$ref":"#/components/schemas/AiLedgerRow"}},"topUps":{"type":"array","items":{"$ref":"#/components/schemas/AiTopUpRow"}},"promptMicroUsd":{"default":100000,"$ref":"#/components/schemas/MicroUsd"}},"required":["storeId","balanceMicroUsd","reservedMicroUsd","promoMicroUsd","toppedUpMicroUsd","transferredMicroUsd","grantedMicroUsd","spentMicroUsd","ledger","topUps","promptMicroUsd"],"additionalProperties":false},"AdminAiDay":{"type":"object","properties":{"date":{"type":"string"},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"chargedMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"modelCostMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","requests","chargedMicroUsd","modelCostMicroUsd"],"additionalProperties":false},"AdminAiModel":{"type":"object","properties":{"model":{"type":"string"},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"modelCostMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"inputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"outputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["model","requests","modelCostMicroUsd","inputTokens","outputTokens"],"additionalProperties":false},"AdminAiProposal":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AiProposalId"},"kind":{"$ref":"#/components/schemas/AiProposalKind"},"title":{"type":"string"},"decision":{"$ref":"#/components/schemas/AiProposalDecision"},"outcome":{"anyOf":[{"$ref":"#/components/schemas/AiProposalOutcome"},{"type":"null"}]},"outcomeDetail":{"type":["string","null"]},"proposed":{"$ref":"#/components/schemas/Shared5"},"applied":{"anyOf":[{"$ref":"#/components/schemas/Shared6"},{"type":"null"}]}},"required":["id","kind","title","decision","outcome","outcomeDetail","proposed","applied"],"additionalProperties":false},"AdminAiStore":{"type":"object","properties":{"storeId":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"members":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"chargedMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"freeMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"topArea":{"type":["string","null"]},"lastAt":{"type":["string","null"]},"trainingOptIn":{"type":"boolean"}},"required":["storeId","name","handle","requests","members","chargedMicroUsd","freeMicroUsd","topArea","lastAt","trainingOptIn"],"additionalProperties":false},"AdminAiStorePage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiStore"}},"nextCursor":{"type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["items","nextCursor","total"],"additionalProperties":false},"AdminAiTurn":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AiTurnId"},"seq":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"model":{"type":"string"},"servedModel":{"type":"string"},"request":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/AiTurnStatus"},"stopReason":{"type":["string","null"]},"error":{"type":["string","null"]},"inputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"outputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cacheReadTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"costMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"latencyMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"attachments":{"$ref":"#/components/schemas/Shared3"},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"$ref":"#/components/schemas/Shared4"}},"required":["role","content"],"additionalProperties":false}},"proposals":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiProposal"}},"feedback":{"type":"array","items":{"type":"object","properties":{"rating":{"$ref":"#/components/schemas/AiFeedbackRating"},"comment":{"type":["string","null"]}},"required":["rating","comment"],"additionalProperties":false}},"createdAt":{"type":"string"}},"required":["id","seq","model","servedModel","request","status","stopReason","error","inputTokens","outputTokens","cacheReadTokens","costMicroUsd","latencyMs","attachments","messages","proposals","feedback","createdAt"],"additionalProperties":false},"AdminAiUsageReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AiUsagePeriod"},"totals":{"type":"object","properties":{"chargedMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"modelCostMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"freeMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"members":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversations":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbsUp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"thumbsDown":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"trainingStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["chargedMicroUsd","modelCostMicroUsd","freeMicroUsd","requests","stores","members","conversations","thumbsUp","thumbsDown","trainingStores"],"additionalProperties":false},"byArea":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiArea"}},"byModel":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiModel"}},"stores":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiStore"}},"daily":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiDay"}}},"required":["period","totals","byArea","byModel","stores","daily"],"additionalProperties":false},"AdminAnnouncement":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AnnouncementId"},"title":{"type":"string"},"body":{"type":"string"},"href":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/AnnouncementState"},"publishAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"archivedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"planIds":{"type":"array","items":{"$ref":"#/components/schemas/PlanId"}},"showInDashboard":{"type":"boolean"},"sendEmail":{"type":"boolean"},"requiresAck":{"type":"boolean"},"createdBy":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"targetStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"acknowledged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"email":{"$ref":"#/components/schemas/AnnouncementEmailCounts"},"discord":{"default":{"on":false,"status":"off","url":null},"type":"object","properties":{"on":{"type":"boolean"},"status":{"type":"string","enum":["off","scheduled","posted","failed","withdrawn"]},"url":{"type":["string","null"]}},"required":["on","status","url"],"additionalProperties":false}},"required":["id","title","body","href","state","publishAt","expiresAt","archivedAt","planIds","showInDashboard","sendEmail","requiresAck","createdBy","createdAt","updatedAt","targetStores","acknowledged","email","discord"],"additionalProperties":false},"AdminBlogPost":{"type":"object","properties":{"slug":{"$ref":"#/components/schemas/BlogSlug"},"status":{"default":"draft","$ref":"#/components/schemas/BlogStatus"},"title":{"type":"string","minLength":5,"maxLength":140},"answer":{"type":"string","minLength":20,"maxLength":400},"excerpt":{"type":"string","minLength":20,"maxLength":300},"body":{"default":"","type":"string","maxLength":100000},"cover":{"$ref":"#/components/schemas/BlogCover"},"authorName":{"default":"ShopFast team","type":"string","minLength":2,"maxLength":80},"tags":{"default":[],"maxItems":8,"type":"array","items":{"type":"string","minLength":2,"maxLength":32,"pattern":"^[a-z0-9][a-z0-9 -]*$"}},"seoTitle":{"default":"","type":"string","maxLength":70},"seoDescription":{"default":"","type":"string","maxLength":170},"ogImage":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BlogAssetSrc"},{"type":"null"}]},"canonicalUrl":{"default":null,"anyOf":[{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"},{"type":"null"}]},"noindex":{"default":false,"type":"boolean"},"publishedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"faq":{"default":[],"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/BlogFaqItem"}},"comparison":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BlogComparison"},{"type":"null"}]},"chart":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BlogChart"},{"type":"null"}]},"video":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BlogVideo"},{"type":"null"}]},"howTo":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BlogHowTo"},{"type":"null"}]},"sources":{"default":[],"maxItems":30,"type":"array","items":{"$ref":"#/components/schemas/BlogSource"}},"checkedOn":{"default":null,"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"related":{"default":[],"maxItems":4,"type":"array","items":{"$ref":"#/components/schemas/BlogSlug"}},"id":{"$ref":"#/components/schemas/BlogPostId"},"previousSlugs":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"firstPublishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"updatedBy":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"words":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["slug","status","title","answer","excerpt","body","cover","authorName","tags","seoTitle","seoDescription","ogImage","canonicalUrl","noindex","publishedAt","faq","comparison","chart","video","howTo","sources","checkedOn","related","id","previousSlugs","url","firstPublishedAt","createdAt","updatedAt","updatedBy","words"],"additionalProperties":false},"AdminBlogPostRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/BlogPostId"},"slug":{"type":"string"},"title":{"type":"string"},"status":{"$ref":"#/components/schemas/BlogStatus"},"tags":{"type":"array","items":{"type":"string"}},"cover":{"$ref":"#/components/schemas/BlogCover"},"publishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"url":{"type":"string"},"words":{"type":"integer","minimum":0,"maximum":9007199254740991},"faqCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"competitor":{"type":["string","null"]},"noindex":{"type":"boolean"}},"required":["id","slug","title","status","tags","cover","publishedAt","updatedAt","url","words","faqCount","competitor","noindex"],"additionalProperties":false},"AdminCheckStoreHandleResponse":{"type":"object","properties":{"handle":{"type":"string"},"available":{"type":"boolean"},"reason":{"type":["string","null"]}},"required":["handle","available","reason"],"additionalProperties":false},"AdminGatewayHealthResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GatewayHealthRow"}},"checkedAt":{"type":"string"}},"required":["items","checkedAt"],"additionalProperties":false},"AdminGetAnnouncementResponse":{"type":"object","properties":{"announcement":{"$ref":"#/components/schemas/AdminAnnouncement"},"acks":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementAck"}}},"required":["announcement","acks"],"additionalProperties":false},"AdminGetErrorResponse":{"type":"object","properties":{"report":{"$ref":"#/components/schemas/ErrorReport"},"occurrences":{"type":"array","items":{"$ref":"#/components/schemas/ErrorOccurrence"}}},"required":["report","occurrences"],"additionalProperties":false},"AdminGetPayResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/PaySettings"},"stats":{"$ref":"#/components/schemas/PayStats"}},"required":["settings","stats"],"additionalProperties":false},"AdminInvite":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminInviteId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"role":{"$ref":"#/components/schemas/AdminRole"},"invitedBy":{"type":"string"},"status":{"$ref":"#/components/schemas/InviteStatus"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","name","role","invitedBy","status","createdAt","expiresAt"],"additionalProperties":false},"AdminInviteAdminResponse":{"type":"object","properties":{"invite":{"$ref":"#/components/schemas/AdminInvite"},"acceptUrl":{"type":"string"}},"required":["invite","acceptUrl"],"additionalProperties":false},"AdminInviteId":{"type":"string","pattern":"^ainv_[0-9a-hjkmnp-tv-z]{20}$"},"AdminInvitePreview":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"role":{"$ref":"#/components/schemas/AdminRole"},"invitedBy":{"type":"string"},"status":{"$ref":"#/components/schemas/InviteStatus"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["email","name","role","invitedBy","status","expiresAt"],"additionalProperties":false},"AdminListAdminsResponse":{"type":"object","properties":{"admins":{"type":"array","items":{"$ref":"#/components/schemas/AdminUserRow"}},"invites":{"type":"array","items":{"$ref":"#/components/schemas/AdminInvite"}}},"required":["admins","invites"],"additionalProperties":false},"AdminListAiConversationsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminAiConversationRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"AdminListAnnouncementsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminAnnouncement"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/AnnouncementCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"AdminListAuditResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AuditEntry"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"admins":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"}},"required":["id","name","email"],"additionalProperties":false}}},"required":["items","nextCursor","admins"],"additionalProperties":false},"AdminListBlogMediaResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BlogMedia"}}},"required":["items"],"additionalProperties":false},"AdminListBlogPostsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminBlogPostRow"}},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"published":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"draft":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","published","draft"],"additionalProperties":false}},"required":["items","counts"],"additionalProperties":false},"AdminListErrorsResponse":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/ErrorGroup"}},"releases":{"type":"array","items":{"type":"string"}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["groups","releases","total"],"additionalProperties":false},"AdminListGatewaysResponse":{"type":"object","properties":{"gateways":{"type":"array","items":{"$ref":"#/components/schemas/PlatformGateway"}},"readiness":{"type":"array","items":{"$ref":"#/components/schemas/GatewayReadiness"}}},"required":["gateways","readiness"],"additionalProperties":false},"AdminListPayApplicationsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminPayApplicationRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/PayApplicationCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"AdminListPayoutsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminPayoutRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/PayoutCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"AdminListPlanInvoicesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminPlanInvoiceRow"}}},"required":["items"],"additionalProperties":false},"AdminListPlanVoucherRedemptionsResponse":{"type":"object","properties":{"redemptions":{"type":"array","items":{"$ref":"#/components/schemas/PlanVoucherRedemption"}}},"required":["redemptions"],"additionalProperties":false},"AdminListPlanVouchersResponse":{"type":"object","properties":{"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/PlanVoucher"}}},"required":["vouchers"],"additionalProperties":false},"AdminListPlansResponse":{"type":"object","properties":{"plans":{"type":"array","items":{"$ref":"#/components/schemas/Plan"}}},"required":["plans"],"additionalProperties":false},"AdminListPlatformBlocklistResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PlatformBlocklistEntry"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"storesOptedIn":{"type":"integer","minimum":0,"maximum":9007199254740991},"matches30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["items","nextCursor","total","storesOptedIn","matches30d"],"additionalProperties":false},"AdminListSchedulesResponse":{"type":"object","properties":{"schedules":{"type":"array","items":{"$ref":"#/components/schemas/PlatformSchedule"}}},"required":["schedules"],"additionalProperties":false},"AdminListSellerAccountsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SellerAccountRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/SellerAccountCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"AdminListStoreProductsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminStoreProduct"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"takenDown":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["items","nextCursor","takenDown"],"additionalProperties":false},"AdminListStoresResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminStoreRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"default":null,"anyOf":[{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"suspended":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"override":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"own":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"trial":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","active","suspended","override","mor","own","trial"],"additionalProperties":false},{"type":"null"}]}},"required":["items","nextCursor","counts"],"additionalProperties":false},"AdminListTaxReviewsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AdminTaxReview"}},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["items","pending"],"additionalProperties":false},"AdminListTemplatesResponse":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSummary"}}},"required":["templates"],"additionalProperties":false},"AdminListViewSessionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ViewSession"}}},"required":["items"],"additionalProperties":false},"AdminLoginResponse":{"type":"object","properties":{"admin":{"$ref":"#/components/schemas/AdminUser"},"mfa":{"default":null,"anyOf":[{"$ref":"#/components/schemas/AdminSecondFactor"},{"type":"null"}]}},"required":["admin","mfa"],"additionalProperties":false},"AdminLoginSecondFactorResponse":{"type":"object","properties":{"admin":{"$ref":"#/components/schemas/AdminUser"},"recoveryCodes":{"type":"array","items":{"type":"string"}}},"required":["admin","recoveryCodes"],"additionalProperties":false},"AdminManualPayoutResponse":{"type":"object","properties":{"payoutId":{"$ref":"#/components/schemas/PayoutId"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"feeMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"payout":{"$ref":"#/components/schemas/AdminPayoutRow"}},"required":["payoutId","amountMinor","feeMinor","currency","payout"],"additionalProperties":false},"AdminMeResponse":{"type":"object","properties":{"admin":{"$ref":"#/components/schemas/AdminUser"}},"required":["admin"],"additionalProperties":false},"AdminNoteId":{"type":"string","pattern":"^note_[0-9a-hjkmnp-tv-z]{20}$"},"AdminPayApplicationDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayApplicationId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"ownerEmail":{"$ref":"#/components/schemas/Email"},"status":{"$ref":"#/components/schemas/PayApplicationStatus"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/PaySellCategory"}},"monthlyVolumeMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"entityType":{"anyOf":[{"$ref":"#/components/schemas/PayEntityType"},{"type":"null"}]},"documents":{"type":"array","items":{"$ref":"#/components/schemas/PayDocument"}},"submittedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"risk":{"type":"string","enum":["none","info","warn","high"]},"wallet":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PayoutWallet"},{"type":"null"}]},"answers":{"$ref":"#/components/schemas/PayApplicationDraft"},"kyc":{"$ref":"#/components/schemas/PayKycDraft"},"storeCountry":{"$ref":"#/components/schemas/CountryCode"},"storeCreatedAt":{"$ref":"#/components/schemas/Timestamp"},"infoRequest":{"type":["string","null"]},"decisionReason":{"type":["string","null"]},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"decidedBy":{"type":["string","null"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/PayEvent"}},"signals":{"type":"array","items":{"$ref":"#/components/schemas/PayRiskSignal"}},"suggestedLimits":{"$ref":"#/components/schemas/PayLimits"},"orders90d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"volume90dMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["id","storeId","storeName","storeHandle","ownerEmail","status","categories","monthlyVolumeMinor","currency","entityType","documents","submittedAt","updatedAt","risk","wallet","answers","kyc","storeCountry","storeCreatedAt","infoRequest","decisionReason","decidedAt","decidedBy","events","signals","suggestedLimits","orders90d","volume90dMinor"],"additionalProperties":false},"AdminPayApplicationRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayApplicationId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"ownerEmail":{"$ref":"#/components/schemas/Email"},"status":{"$ref":"#/components/schemas/PayApplicationStatus"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/PaySellCategory"}},"monthlyVolumeMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"entityType":{"anyOf":[{"$ref":"#/components/schemas/PayEntityType"},{"type":"null"}]},"documents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"submittedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"risk":{"type":"string","enum":["none","info","warn","high"]},"wallet":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PayoutWallet"},{"type":"null"}]}},"required":["id","storeId","storeName","storeHandle","ownerEmail","status","categories","monthlyVolumeMinor","currency","entityType","documents","submittedAt","updatedAt","risk","wallet"],"additionalProperties":false},"AdminPayDocumentLinkResponse":{"type":"object","properties":{"url":{"type":"string"},"expiresAt":{"type":"string"}},"required":["url","expiresAt"],"additionalProperties":false},"AdminPayoutRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayoutId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"feeMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/PayoutStatus"},"arrivalDate":{"$ref":"#/components/schemas/IsoDate"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"rail":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PayoutRail"},{"type":"null"}]},"address":{"default":null,"type":["string","null"]},"origin":{"default":"schedule","$ref":"#/components/schemas/PayoutOrigin"},"txHash":{"default":null,"type":["string","null"]},"reason":{"default":null,"type":["string","null"]},"paidAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"storeName":{"type":"string"},"storeHandle":{"$ref":"#/components/schemas/StoreHandle"},"walletSetAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","storeId","amountMinor","feeMinor","currency","status","arrivalDate","createdAt","rail","address","origin","txHash","reason","paidAt","storeName","storeHandle","walletSetAt"],"additionalProperties":false},"AdminPlanInvoiceRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanInvoiceId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/PlanInvoiceStatus"},"periodStart":{"type":"string"},"periodEnd":{"type":"string"},"reason":{"type":"string","enum":["upgrade","renewal"]},"paidVia":{"anyOf":[{"$ref":"#/components/schemas/PlanInvoicePaidVia"},{"type":"null"}]},"paidAt":{"type":["string","null"]},"createdAt":{"type":"string"},"creditMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"creditNote":{"default":null,"type":["string","null"]},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"approvedBy":{"anyOf":[{"$ref":"#/components/schemas/AdminUserId"},{"type":"null"}]}},"required":["id","storeId","planId","planName","amountMinor","currency","status","periodStart","periodEnd","reason","paidVia","paidAt","createdAt","creditMinor","creditNote","storeName","storeHandle","approvedBy"],"additionalProperties":false},"AdminPreviewBlogPostResponse":{"type":"object","properties":{"html":{"type":"string"}},"required":["html"],"additionalProperties":false},"AdminPreviewPayModeResponse":{"type":"object","properties":{"switchedToOwn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unavailable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"restored":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["switchedToOwn","unavailable","restored"],"additionalProperties":false},"AdminRebuildStoreSearchResponse":{"type":"object","properties":{"controls":{"$ref":"#/components/schemas/StoreControls"},"emailed":{"type":"array","items":{"type":"string"}},"finished":{"type":"boolean"}},"required":["controls","emailed","finished"],"additionalProperties":false},"AdminReferredBy":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"$ref":"#/components/schemas/StoreHandle"},"joinedAt":{"$ref":"#/components/schemas/Timestamp"},"endsAt":{"$ref":"#/components/schemas/Timestamp"},"shareBps":{"$ref":"#/components/schemas/Bps"},"status":{"type":"string","enum":["active","removed"]},"removedReason":{"type":["string","null"]}},"required":["storeId","name","handle","joinedAt","endsAt","shareBps","status","removedReason"],"additionalProperties":false},"AdminReorderTemplatesResponse":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSummary"}}},"required":["templates"],"additionalProperties":false},"AdminResetSecondFactorResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true}},"required":["ok"],"additionalProperties":false},"AdminRole":{"type":"string","enum":["owner","finance","support","agent"]},"AdminRunPayoutsResponse":{"type":"object","properties":{"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"awaitingPayoutAccount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blockedNoPayoutMethod":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blockedMinor":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["created","totalMinor","awaitingPayoutAccount","blockedNoPayoutMethod","blockedMinor"],"additionalProperties":false},"AdminSecondFactor":{"type":"object","properties":{"step":{"type":"string","enum":["enroll","verify"]},"challenge":{"type":"string"},"secret":{"type":["string","null"]},"otpauthUri":{"type":["string","null"]}},"required":["step","challenge","secret","otpauthUri"],"additionalProperties":false},"AdminSetDefaultTemplateResponse":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSummary"}}},"required":["templates"],"additionalProperties":false},"AdminSetProductTakedownResponse":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/AdminStoreProduct"},"emailed":{"type":"array","items":{"type":"string"}}},"required":["product","emailed"],"additionalProperties":false},"AdminSetStoreOverrideResponse":{"type":"object","properties":{"override":{"anyOf":[{"$ref":"#/components/schemas/StoreFeeOverride"},{"type":"null"}]},"store":{"$ref":"#/components/schemas/AdminStoreDetail"}},"required":["override","store"],"additionalProperties":false},"AdminStatus":{"type":"string","enum":["active","deactivated"]},"AdminStoreDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":80},"handle":{"$ref":"#/components/schemas/StoreHandle"},"domain":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"features":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/FeatureKey"}},"planState":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorePlanState"},{"type":"null"}]},"category":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StoreCategory"},{"type":"null"}]},"logoUrl":{"default":null,"type":["string","null"]},"timezone":{"default":"UTC","type":"string"},"ownerId":{"$ref":"#/components/schemas/UserId"},"ownerEmail":{"$ref":"#/components/schemas/Email"},"ownerName":{"default":"","type":"string"},"gmv30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"platformRevenue30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"orders30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"products":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"liveProducts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasFeeOverride":{"type":"boolean"},"status":{"type":"string","enum":["active","suspended"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"trial":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorePlanTrial"},{"type":"null"}]},"ownerEmailConfirmed":{"default":true,"type":"boolean"},"ownerLocked":{"default":false,"type":"boolean"},"plan":{"$ref":"#/components/schemas/Plan"},"override":{"anyOf":[{"$ref":"#/components/schemas/StoreFeeOverride"},{"type":"null"}]},"effectiveFees":{"$ref":"#/components/schemas/FeeSchedule"},"balance":{"$ref":"#/components/schemas/Balance"}},"required":["id","name","handle","domain","currency","paymentModel","planId","planName","features","planState","category","logoUrl","timezone","ownerId","ownerEmail","ownerName","gmv30dMinor","platformRevenue30dMinor","orders30d","products","liveProducts","hasFeeOverride","status","createdAt","trial","ownerEmailConfirmed","ownerLocked","plan","override","effectiveFees","balance"],"additionalProperties":false},"AdminStoreDomain":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DomainId"},"hostname":{"type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus"},"sslStatus":{"$ref":"#/components/schemas/SslStatus"},"primary":{"type":"boolean"},"mode":{"$ref":"#/components/schemas/DomainMode"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"verifiedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","hostname","status","sslStatus","primary","mode","createdAt","verifiedAt"],"additionalProperties":false},"AdminStoreMember":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"role":{"$ref":"#/components/schemas/MemberRoleKind"},"roleName":{"type":"string"},"customRoleId":{"anyOf":[{"$ref":"#/components/schemas/RoleId"},{"type":"null"}]},"joinedAt":{"$ref":"#/components/schemas/Timestamp"},"emailConfirmed":{"type":"boolean"},"locked":{"type":"boolean"}},"required":["userId","name","email","role","roleName","customRoleId","joinedAt","emailConfirmed","locked"],"additionalProperties":false},"AdminStorePay":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"status":{"$ref":"#/components/schemas/SellerPayStatus"},"suspended":{"type":"object","properties":{"on":{"type":"boolean"},"reason":{"type":["string","null"]},"since":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["on","reason","since"],"additionalProperties":false},"flags":{"type":"array","items":{"$ref":"#/components/schemas/PayRiskFlag"}},"note":{"type":"string"},"signals":{"type":"array","items":{"$ref":"#/components/schemas/PayRiskSignal"}},"balances":{"type":"object","properties":{"pendingMinor":{"$ref":"#/components/schemas/MinorUnits"},"availableMinor":{"$ref":"#/components/schemas/MinorUnits"},"reserveMinor":{"$ref":"#/components/schemas/MinorUnits"},"disputeHoldMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["pendingMinor","availableMinor","reserveMinor","disputeHoldMinor"],"additionalProperties":false},"payoutFeeMinor":{"$ref":"#/components/schemas/MinorUnits"},"applicationId":{"anyOf":[{"$ref":"#/components/schemas/PayApplicationId"},{"type":"null"}]},"updatedBy":{"type":["string","null"]},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["storeId","paymentModel","status","suspended","flags","note","signals","balances","payoutFeeMinor","applicationId","updatedBy","updatedAt"],"additionalProperties":false},"AdminStorePlanLimits":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/StorePlanState"},"usage":{"$ref":"#/components/schemas/PlanUsage"},"override":{"anyOf":[{"$ref":"#/components/schemas/AdminStorePlanOverride"},{"type":"null"}]},"planLimits":{"$ref":"#/components/schemas/PlanLimits"},"ownerTrialUsedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["state","usage","override","planLimits","ownerTrialUsedAt"],"additionalProperties":false},"AdminStorePlanOverride":{"type":"object","properties":{"limits":{"$ref":"#/components/schemas/PlanLimitsOverride"},"reason":{"type":"string","minLength":1,"maxLength":280},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"updatedBy":{"type":["string","null"]}},"required":["limits","reason","updatedAt","updatedBy"],"additionalProperties":false},"AdminStorePlanState":{"type":"object","properties":{"comp":{"anyOf":[{"$ref":"#/components/schemas/PlanComp"},{"type":"null"}]},"pendingInvoice":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanInvoiceId"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"billedByAdmin":{"type":"boolean"},"lastError":{"type":["string","null"]}},"required":["id","planId","planName","amountMinor","currency","createdAt","billedByAdmin","lastError"],"additionalProperties":false},{"type":"null"}]},"hasCard":{"type":"boolean"},"cardLabel":{"type":["string","null"]},"pricesOn":{"default":true,"type":"boolean"},"review":{"type":"boolean"}},"required":["comp","pendingInvoice","hasCard","cardLabel","pricesOn","review"],"additionalProperties":false},"AdminStoreProduct":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"slug":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"status":{"$ref":"#/components/schemas/ProductStatus"},"visibility":{"$ref":"#/components/schemas/ProductVisibility"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"type":"string"},"takenDownAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","slug","type","status","visibility","priceMinor","currency","takenDownAt","createdAt"],"additionalProperties":false},"AdminStoreReferral":{"type":"object","properties":{"referredBy":{"anyOf":[{"$ref":"#/components/schemas/AdminReferredBy"},{"type":"null"}]},"brought":{"type":"object","properties":{"stores":{"type":"integer","minimum":0,"maximum":9007199254740991},"earning":{"type":"integer","minimum":0,"maximum":9007199254740991},"earnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["stores","earning","earnedMinor","currency"],"additionalProperties":false}},"required":["referredBy","brought"],"additionalProperties":false},"AdminStoreRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":80},"handle":{"$ref":"#/components/schemas/StoreHandle"},"domain":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"features":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/FeatureKey"}},"planState":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorePlanState"},{"type":"null"}]},"category":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StoreCategory"},{"type":"null"}]},"logoUrl":{"default":null,"type":["string","null"]},"timezone":{"default":"UTC","type":"string"},"ownerId":{"$ref":"#/components/schemas/UserId"},"ownerEmail":{"$ref":"#/components/schemas/Email"},"ownerName":{"default":"","type":"string"},"gmv30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"platformRevenue30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"orders30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"products":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"liveProducts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasFeeOverride":{"type":"boolean"},"status":{"type":"string","enum":["active","suspended"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"trial":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorePlanTrial"},{"type":"null"}]}},"required":["id","name","handle","domain","currency","paymentModel","planId","planName","features","planState","category","logoUrl","timezone","ownerId","ownerEmail","ownerName","gmv30dMinor","platformRevenue30dMinor","orders30d","products","liveProducts","hasFeeOverride","status","createdAt","trial"],"additionalProperties":false},"AdminTaxReview":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"$ref":"#/components/schemas/StoreHandle"},"productName":{"type":"string"},"productType":{"$ref":"#/components/schemas/ProductType"},"status":{"$ref":"#/components/schemas/ProductStatus"},"category":{"$ref":"#/components/schemas/TaxCategory"},"review":{"$ref":"#/components/schemas/TaxCategoryReview"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"shortDescription":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["productId","storeId","storeName","storeHandle","productName","productType","status","category","review","priceMinor","currency","shortDescription","updatedAt"],"additionalProperties":false},"AdminTemplateReleaseReviewResponse":{"type":"object","properties":{"release":{"$ref":"#/components/schemas/TemplateReleaseSummary"},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/TemplatePerson"}},"blockedBy":{"type":["string","null"]},"canDiscard":{"type":"boolean"}},"required":["release","issues","contributors","blockedBy","canDiscard"],"additionalProperties":false},"AdminUser":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"role":{"$ref":"#/components/schemas/AdminRole"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","name","role","createdAt"],"additionalProperties":false},"AdminUserId":{"type":"string","pattern":"^adm_[0-9a-hjkmnp-tv-z]{20}$"},"AdminUserRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"role":{"$ref":"#/components/schemas/AdminRole"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"status":{"$ref":"#/components/schemas/AdminStatus"},"lastActiveAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"isYou":{"type":"boolean"}},"required":["id","email","name","role","createdAt","status","lastActiveAt","isYou"],"additionalProperties":false},"AdsReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"model":{"$ref":"#/components/schemas/AttributionModel"},"totals":{"type":"object","properties":{"impressions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spendMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousSpendMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversions":{"type":"number"},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousRevenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ctrBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cpmMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cpcMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cpaMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"roasBps":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["impressions","clicks","spendMinor","previousSpendMinor","sessions","conversions","revenueMinor","previousRevenueMinor","ctrBps","cpmMinor","cpcMinor","cpaMinor","roasBps"],"additionalProperties":false},"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/AdCampaignRow"}},"platforms":{"type":"array","items":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/AdPlatform"},"spendMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"roasBps":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["platform","spendMinor","revenueMinor","roasBps"],"additionalProperties":false}},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"hour":{"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"spendMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"impressions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","hour","spendMinor","revenueMinor","impressions","clicks"],"additionalProperties":false}},"imports":{"type":"array","items":{"$ref":"#/components/schemas/AdImport"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/AdSpendRow"}}},"required":["period","currency","model","totals","campaigns","platforms","daily","imports","rows"],"additionalProperties":false},"AffiliateCommission":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommissionId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"baseMinor":{"$ref":"#/components/schemas/MinorUnits"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"rateBps":{"$ref":"#/components/schemas/Bps"},"status":{"$ref":"#/components/schemas/CommissionStatus"},"reward":{"$ref":"#/components/schemas/AffiliateReward"},"payableAt":{"$ref":"#/components/schemas/Timestamp"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","orderId","orderNumber","baseMinor","amountMinor","rateBps","status","reward","payableAt","createdAt"],"additionalProperties":false},"AffiliateCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paused":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","active","pending","paused"],"additionalProperties":false},"AffiliateDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AffiliateId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"code":{"type":"string"},"status":{"$ref":"#/components/schemas/AffiliateStatus"},"commissionBps":{"anyOf":[{"$ref":"#/components/schemas/Bps"},{"type":"null"}]},"effectiveBps":{"$ref":"#/components/schemas/Bps"},"newCustomersOnly":{"type":["boolean","null"]},"effectiveNewCustomersOnly":{"type":"boolean"},"reward":{"anyOf":[{"$ref":"#/components/schemas/AffiliateReward"},{"type":"null"}]},"effectiveReward":{"$ref":"#/components/schemas/AffiliateReward"},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversions":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversionBps":{"$ref":"#/components/schemas/Bps"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"pendingMinor":{"$ref":"#/components/schemas/MinorUnits"},"owedMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"storeCreditMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"link":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"payoutEmail":{"type":["string","null"]},"note":{"type":"string"},"commissions":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateCommission"}},"payouts":{"type":"array","items":{"$ref":"#/components/schemas/AffiliatePayout"}},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","clicks","conversions"],"additionalProperties":false}}},"required":["id","name","email","code","status","commissionBps","effectiveBps","newCustomersOnly","effectiveNewCustomersOnly","reward","effectiveReward","clicks","conversions","conversionBps","revenueMinor","pendingMinor","owedMinor","paidMinor","storeCreditMinor","currency","link","createdAt","payoutEmail","note","commissions","payouts","daily"],"additionalProperties":false},"AffiliateId":{"type":"string","pattern":"^aff_[0-9a-hjkmnp-tv-z]{20}$"},"AffiliateInviteSettings":{"type":"object","properties":{"heading":{"default":"Earn by sharing","type":"string","minLength":1,"maxLength":60},"body":{"default":"Get {rate} of every sale you send our way.","type":"string","minLength":1,"maxLength":160},"linkLabel":{"default":"Join the affiliate program","type":"string","minLength":1,"maxLength":40},"placement":{"default":"footer","type":"string","enum":["footer","product_and_footer"]}},"required":["heading","body","linkLabel","placement"],"additionalProperties":false},"AffiliatePayout":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AffiliatePayoutId"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"method":{"$ref":"#/components/schemas/AffiliatePayoutMethod"},"reference":{"type":"string"},"commissions":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","amountMinor","currency","method","reference","commissions","createdAt"],"additionalProperties":false},"AffiliatePayoutId":{"type":"string","pattern":"^apo_[0-9a-hjkmnp-tv-z]{20}$"},"AffiliatePayoutMethod":{"type":"string","enum":["balance","external","store_credit"]},"AffiliatePortalResponse":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"status":{"$ref":"#/components/schemas/AffiliateStatus"},"effectiveBps":{"$ref":"#/components/schemas/Bps"},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversions":{"type":"integer","minimum":0,"maximum":9007199254740991},"pendingMinor":{"$ref":"#/components/schemas/MinorUnits"},"owedMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"link":{"type":"string"},"storeName":{"type":"string"},"terms":{"type":"string"},"cookieDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","code","status","effectiveBps","clicks","conversions","pendingMinor","owedMinor","paidMinor","currency","link","storeName","terms","cookieDays"],"additionalProperties":false},"AffiliateProgram":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/AffiliateSettings"},"totals":{"type":"object","properties":{"clicks30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversions30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenue30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"owedMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"pendingMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["clicks30d","conversions30d","revenue30dMinor","owedMinor","paidMinor","pendingMinor"],"additionalProperties":false},"signupUrl":{"type":"string"},"ledgerBacked":{"type":"boolean"}},"required":["settings","totals","signupUrl","ledgerBacked"],"additionalProperties":false},"AffiliateProgramPublicResponse":{"type":"object","properties":{"storeName":{"type":"string"},"enabled":{"type":"boolean"},"commissionBps":{"$ref":"#/components/schemas/Bps"},"cookieDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approval":{"type":"string","enum":["auto","manual"]},"terms":{"type":"string"}},"required":["storeName","enabled","commissionBps","cookieDays","approval","terms"],"additionalProperties":false},"AffiliateReward":{"type":"string","enum":["cash","store_credit"]},"AffiliateRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AffiliateId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"code":{"type":"string"},"status":{"$ref":"#/components/schemas/AffiliateStatus"},"commissionBps":{"anyOf":[{"$ref":"#/components/schemas/Bps"},{"type":"null"}]},"effectiveBps":{"$ref":"#/components/schemas/Bps"},"newCustomersOnly":{"type":["boolean","null"]},"effectiveNewCustomersOnly":{"type":"boolean"},"reward":{"anyOf":[{"$ref":"#/components/schemas/AffiliateReward"},{"type":"null"}]},"effectiveReward":{"$ref":"#/components/schemas/AffiliateReward"},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversions":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversionBps":{"$ref":"#/components/schemas/Bps"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"pendingMinor":{"$ref":"#/components/schemas/MinorUnits"},"owedMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"storeCreditMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"link":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","email","code","status","commissionBps","effectiveBps","newCustomersOnly","effectiveNewCustomersOnly","reward","effectiveReward","clicks","conversions","conversionBps","revenueMinor","pendingMinor","owedMinor","paidMinor","storeCreditMinor","currency","link","createdAt"],"additionalProperties":false},"AffiliateSettings":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"commissionBps":{"default":1000,"$ref":"#/components/schemas/Bps"},"cookieDays":{"default":30,"type":"integer","minimum":1,"maximum":365},"approval":{"default":"manual","type":"string","enum":["auto","manual"]},"holdDays":{"default":14,"type":"integer","minimum":0,"maximum":120},"minPayoutMinor":{"default":2500,"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"terms":{"default":"Earn a commission on every paid order you refer. Self-referrals and refunded orders do not count.","type":"string","maxLength":4000},"newCustomersOnly":{"default":false,"type":"boolean"},"reward":{"default":"cash","$ref":"#/components/schemas/AffiliateReward"}},"required":["enabled","commissionBps","cookieDays","approval","holdDays","minPayoutMinor","terms","newCustomersOnly","reward"],"additionalProperties":false},"AffiliateSignupResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/AffiliateStatus"},"code":{"type":"string"},"link":{"type":"string"}},"required":["status","code","link"],"additionalProperties":false},"AffiliateStatus":{"type":"string","enum":["pending","active","paused","rejected"]},"AgeGateSettings":{"type":"object","properties":{"minimumAge":{"default":18,"type":"integer","minimum":13,"maximum":25},"heading":{"default":"Are you old enough to visit?","type":"string","minLength":1,"maxLength":80},"body":{"default":"This store sells products for adults only.","type":"string","maxLength":240},"exitUrl":{"default":"https://www.google.com","type":"string","maxLength":500},"rememberDays":{"default":30,"type":"integer","minimum":0,"maximum":365}},"required":["minimumAge","heading","body","exitUrl","rememberDays"],"additionalProperties":false},"AiConversationId":{"type":"string","pattern":"^aicv_[0-9a-hjkmnp-tv-z]{20}$"},"AiCreditTransferAvailability":{"type":"object","properties":{"availableMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"minMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"maxMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"leftToday":{"type":"integer","minimum":0,"maximum":9007199254740991},"reason":{"type":["string","null"]}},"required":["availableMinor","minMinor","maxMinor","leftToday","reason"],"additionalProperties":false},"AiCreditTransferId":{"type":"string","pattern":"^aitr_[0-9a-hjkmnp-tv-z]{20}$"},"AiCreditTransferResult":{"type":"object","properties":{"transfer":{"$ref":"#/components/schemas/AiCreditTransferRow"},"balanceMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"replayed":{"type":"boolean"}},"required":["transfer","balanceMicroUsd","replayed"],"additionalProperties":false},"AiCreditTransferRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AiCreditTransferId"},"amountMinor":{"type":"integer","minimum":1,"maximum":9007199254740991},"amountMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"by":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","amountMinor","amountMicroUsd","by","createdAt"],"additionalProperties":false},"AiCreditsView":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"balanceMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"promoMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"freePrompts":{"$ref":"#/components/schemas/AiFreePrompts"},"reservedMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"metered":{"type":"boolean"},"markupPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"estimates":{"type":"array","items":{"type":"object","properties":{"feature":{"$ref":"#/components/schemas/AiFeature"},"label":{"type":"string"},"reserveMicroUsd":{"$ref":"#/components/schemas/MicroUsd"}},"required":["feature","label","reserveMicroUsd"],"additionalProperties":false}},"topUp":{"$ref":"#/components/schemas/AiTopUpAvailability"},"usage":{"type":"array","items":{"$ref":"#/components/schemas/AiUsageRow"}},"topUps":{"type":"array","items":{"$ref":"#/components/schemas/AiTopUpRow"}},"transfer":{"$ref":"#/components/schemas/AiCreditTransferAvailability"},"transfers":{"type":"array","items":{"$ref":"#/components/schemas/AiCreditTransferRow"}}},"required":["storeId","balanceMicroUsd","promoMicroUsd","freePrompts","reservedMicroUsd","metered","markupPct","estimates","topUp","usage","topUps","transfer","transfers"],"additionalProperties":false},"AiDataSettings":{"type":"object","properties":{"trainingOptIn":{"type":"boolean"},"changedAt":{"type":["string","null"]},"retentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"canChange":{"type":"boolean"}},"required":["trainingOptIn","changedAt","retentionDays","canChange"],"additionalProperties":false},"AiFeature":{"type":"string","enum":["store_builder","section_copy","theme_edit","assistant"]},"AiFeedbackRating":{"type":"string","enum":["up","down"]},"AiFreePrompts":{"type":"object","properties":{"granted":{"type":"boolean"},"prompts":{"type":"integer","minimum":0,"maximum":9007199254740991},"promptMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"left":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["granted","prompts","promptMicroUsd","left"],"additionalProperties":false},"AiLedgerEntryId":{"type":"string","pattern":"^aile_[0-9a-hjkmnp-tv-z]{20}$"},"AiLedgerKind":{"type":"string","enum":["top_up","usage","refund","adjustment","promo","transfer"]},"AiLedgerRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AiLedgerEntryId"},"kind":{"$ref":"#/components/schemas/AiLedgerKind"},"amountMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"balanceAfterMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"feature":{"anyOf":[{"$ref":"#/components/schemas/AiFeature"},{"type":"null"}]},"usageId":{"anyOf":[{"$ref":"#/components/schemas/AiUsageId"},{"type":"null"}]},"topUpId":{"anyOf":[{"$ref":"#/components/schemas/AiTopUpId"},{"type":"null"}]},"promoMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"note":{"type":"string"},"actor":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","kind","amountMicroUsd","balanceAfterMicroUsd","feature","usageId","topUpId","promoMicroUsd","note","actor","createdAt"],"additionalProperties":false},"AiProposalDecision":{"type":"string","enum":["pending","applied","applied_edited","rejected","ignored"]},"AiProposalId":{"type":"string","pattern":"^aipr_[0-9a-hjkmnp-tv-z]{20}$"},"AiProposalKind":{"type":"string","enum":["action","builder_patches","theme_ops"]},"AiProposalOutcome":{"type":"string","enum":["success","error","undone"]},"AiSurface":{"type":"string","enum":["ask_ai","builder_change","builder_store","builder_copy","theme_edit"]},"AiTopUpAvailability":{"type":"object","properties":{"mode":{"anyOf":[{"type":"string","enum":["stripe","sandbox"]},{"type":"null"}]},"reason":{"type":["string","null"]},"presetsCents":{"type":"array","items":{"type":"integer","minimum":1,"maximum":9007199254740991}},"minCents":{"type":"integer","minimum":1,"maximum":9007199254740991},"maxCents":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["mode","reason","presetsCents","minCents","maxCents"],"additionalProperties":false},"AiTopUpId":{"type":"string","pattern":"^aitu_[0-9a-hjkmnp-tv-z]{20}$"},"AiTopUpPayment":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"stripe"},"publishableKey":{"type":"string","pattern":"^pk_(?:live|test)_[A-Za-z0-9]+$"},"clientSecret":{"type":"string","pattern":"^pi_[A-Za-z0-9]+_secret_[A-Za-z0-9]+$"},"livemode":{"type":"boolean"}},"required":["kind","publishableKey","clientSecret","livemode"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"sandbox"}},"required":["kind"],"additionalProperties":false}]},"AiTopUpResult":{"type":"object","properties":{"topUp":{"$ref":"#/components/schemas/AiTopUpRow"},"balanceMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"message":{"type":["string","null"]}},"required":["topUp","balanceMicroUsd","message"],"additionalProperties":false},"AiTopUpRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AiTopUpId"},"amountCents":{"type":"integer","minimum":1,"maximum":9007199254740991},"status":{"$ref":"#/components/schemas/AiTopUpStatus"},"method":{"type":["string","null"]},"receiptUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"test":{"type":"boolean"},"by":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"paidAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]}},"required":["id","amountCents","status","method","receiptUrl","test","by","createdAt","paidAt"],"additionalProperties":false},"AiTopUpStart":{"type":"object","properties":{"topUp":{"$ref":"#/components/schemas/AiTopUpRow"},"payment":{"$ref":"#/components/schemas/AiTopUpPayment"}},"required":["topUp","payment"],"additionalProperties":false},"AiTopUpStatus":{"type":"string","enum":["pending","succeeded","failed","canceled"]},"AiTurnFeedback":{"type":"object","properties":{"turnId":{"$ref":"#/components/schemas/AiTurnId"},"rating":{"anyOf":[{"$ref":"#/components/schemas/AiFeedbackRating"},{"type":"null"}]},"comment":{"type":["string","null"]}},"required":["turnId","rating","comment"],"additionalProperties":false},"AiTurnId":{"type":"string","pattern":"^aitn_[0-9a-hjkmnp-tv-z]{20}$"},"AiTurnStatus":{"type":"string","enum":["answered","refused","failed"]},"AiUsageArea":{"type":"object","properties":{"area":{"type":"string"},"label":{"type":"string"},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"costMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["area","label","requests","costMicroUsd"],"additionalProperties":false},"AiUsageDay":{"type":"object","properties":{"date":{"type":"string"},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"costMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","requests","costMicroUsd"],"additionalProperties":false},"AiUsageId":{"type":"string","pattern":"^aius_[0-9a-hjkmnp-tv-z]{20}$"},"AiUsageItem":{"type":"object","properties":{"id":{"type":"string"},"area":{"type":"string"},"label":{"type":"string"},"request":{"type":["string","null"]},"by":{"type":["string","null"]},"model":{"type":"string"},"status":{"type":"string","enum":["reserved","settled","refunded"]},"costMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"freeMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"inputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"outputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"proposals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"applied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rating":{"anyOf":[{"$ref":"#/components/schemas/AiFeedbackRating"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","area","label","request","by","model","status","costMicroUsd","freeMicroUsd","inputTokens","outputTokens","proposals","applied","rating","createdAt"],"additionalProperties":false},"AiUsageMember":{"type":"object","properties":{"userId":{"type":["string","null"]},"name":{"type":"string"},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"costMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["userId","name","requests","costMicroUsd"],"additionalProperties":false},"AiUsagePeriod":{"type":"string","enum":["7d","30d","90d","365d"]},"AiUsageReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AiUsagePeriod"},"totals":{"$ref":"#/components/schemas/AiUsageTotals"},"byArea":{"type":"array","items":{"$ref":"#/components/schemas/AiUsageArea"}},"byMember":{"type":"array","items":{"$ref":"#/components/schemas/AiUsageMember"}},"daily":{"type":"array","items":{"$ref":"#/components/schemas/AiUsageDay"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/AiUsageItem"}},"nextCursor":{"type":["string","null"]}},"required":["period","totals","byArea","byMember","daily","items","nextCursor"],"additionalProperties":false},"AiUsageRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AiUsageId"},"feature":{"$ref":"#/components/schemas/AiFeature"},"label":{"type":"string"},"model":{"type":"string"},"status":{"$ref":"#/components/schemas/AiUsageStatus"},"reservedMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"costMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"inputTokens":{"type":"integer","minimum":0,"maximum":9007199254740991},"outputTokens":{"type":"integer","minimum":0,"maximum":9007199254740991},"by":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"settledAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]}},"required":["id","feature","label","model","status","reservedMicroUsd","costMicroUsd","inputTokens","outputTokens","by","createdAt","settledAt"],"additionalProperties":false},"AiUsageStatus":{"type":"string","enum":["reserved","settled","refunded"]},"AiUsageTotals":{"type":"object","properties":{"costMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"freeMicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"inputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"outputTokens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["costMicroUsd","freeMicroUsd","requests","inputTokens","outputTokens"],"additionalProperties":false},"Alert":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"metric":{"$ref":"#/components/schemas/AlertMetric"},"rule":{"$ref":"#/components/schemas/AlertRule"},"threshold":{"type":"number","minimum":0,"maximum":1000000000000},"cadence":{"$ref":"#/components/schemas/AlertCadence"},"filters":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/SessionFilter"}},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Email"}},"enabled":{"default":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/AlertId"},"lastCheckedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastFiredAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastValue":{"type":["number","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","metric","rule","threshold","cadence","filters","recipients","enabled","id","lastCheckedAt","lastFiredAt","lastValue","createdAt"],"additionalProperties":false},"AlertCadence":{"type":"string","enum":["hourly","daily"]},"AlertEvent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AlertEventId"},"alertId":{"$ref":"#/components/schemas/AlertId"},"alertName":{"type":"string"},"metric":{"$ref":"#/components/schemas/AlertMetric"},"firedAt":{"$ref":"#/components/schemas/Timestamp"},"value":{"type":"number"},"expected":{"type":"number"},"message":{"type":"string"},"windowFrom":{"$ref":"#/components/schemas/Timestamp"},"windowTo":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","alertId","alertName","metric","firedAt","value","expected","message","windowFrom","windowTo"],"additionalProperties":false},"AlertEventId":{"type":"string","pattern":"^ale_[0-9a-hjkmnp-tv-z]{20}$"},"AlertId":{"type":"string","pattern":"^alr_[0-9a-hjkmnp-tv-z]{20}$"},"AlertMetric":{"type":"string","enum":["visitors","sessions","pageviews","conversions","conversion_rate","orders","revenue","bounce_rate","bot_share"]},"AlertRule":{"type":"string","enum":["anomaly","drops_below","rises_above","change_pct"]},"AllowBuyerResult":{"type":"object","properties":{"added":{"type":"array","items":{"$ref":"#/components/schemas/FraudListEntry"}},"already":{"type":"array","items":{"type":"string"}}},"required":["added","already"],"additionalProperties":false},"AllowCandidate":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/BlocklistKind"},"value":{"type":"string"},"label":{"type":"string"},"allowedEntryId":{"type":["string","null"]}},"required":["kind","value","label","allowedEntryId"],"additionalProperties":false},"AnalyticsBucket":{"type":"string","enum":["hour","day","week","month"]},"AnalyticsEventName":{"type":"string","enum":["page_view","page_leave","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom","crawl"]},"AnalyticsExport":{"type":"object","properties":{"filename":{"type":"string"},"mime":{"type":"string","enum":["text/csv","application/json"]},"content":{"type":"string"},"rows":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["filename","mime","content","rows"],"additionalProperties":false},"AnalyticsHealth":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/AnalyticsSettings"},"last24h":{"type":"array","items":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AnalyticsEventName"},"events":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","events"],"additionalProperties":false}},"lastEventAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"rollups":{"type":"object","properties":{"days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastRolledAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"oldest":{"anyOf":[{"$ref":"#/components/schemas/IsoDate"},{"type":"null"}]}},"required":["days","lastRolledAt","oldest"],"additionalProperties":false},"storage":{"type":"object","properties":{"events":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"partitions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["events","sessions","partitions"],"additionalProperties":false},"consent":{"type":"array","items":{"type":"object","properties":{"consent":{"$ref":"#/components/schemas/ConsentState"},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["consent","sessions"],"additionalProperties":false}}},"required":["settings","last24h","lastEventAt","rollups","storage","consent"],"additionalProperties":false},"AnalyticsOverview":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/AnalyticsRange"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"kpis":{"type":"object","properties":{"revenueMinor":{"$ref":"#/components/schemas/Kpi"},"orders":{"$ref":"#/components/schemas/Kpi"},"visitors":{"$ref":"#/components/schemas/Kpi"},"conversionBps":{"$ref":"#/components/schemas/Kpi"},"averageOrderMinor":{"$ref":"#/components/schemas/Kpi"},"newCustomers":{"$ref":"#/components/schemas/Kpi"},"refundsMinor":{"$ref":"#/components/schemas/Kpi"},"medianDeliveryMs":{"$ref":"#/components/schemas/Kpi"}},"required":["revenueMinor","orders","visitors","conversionBps","averageOrderMinor","newCustomers","refundsMinor","medianDeliveryMs"],"additionalProperties":false},"series":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","revenueMinor","orders","visitors"],"additionalProperties":false}},"topProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"unitsSold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["productId","name","unitsSold","revenueMinor"],"additionalProperties":false}},"paymentMethods":{"type":"array","items":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/PaymentMethod"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["method","orders","revenueMinor"],"additionalProperties":false}},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/CountryCode"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["country","orders","revenueMinor"],"additionalProperties":false}},"funnel":{"type":"object","properties":{"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"productViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"addedToCart":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"checkouts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["visitors","productViews","addedToCart","checkouts","paid"],"additionalProperties":false},"timezone":{"default":"UTC","type":"string"},"traffic":{"default":{"sessions":0,"convertedSessions":0,"source":"visits"},"type":"object","properties":{"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"convertedSessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"source":{"type":"string","enum":["pipeline","visits"]}},"required":["sessions","convertedSessions","source"],"additionalProperties":false}},"required":["range","currency","from","to","kpis","series","topProducts","paymentMethods","countries","funnel","timezone","traffic"],"additionalProperties":false},"AnalyticsPeriod":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"previousFrom":{"$ref":"#/components/schemas/IsoDate"},"previousTo":{"$ref":"#/components/schemas/IsoDate"},"timezone":{"type":"string"},"bucket":{"$ref":"#/components/schemas/AnalyticsBucket"},"days":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["range","from","to","previousFrom","previousTo","timezone","bucket","days"],"additionalProperties":false},"AnalyticsQueryResult":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ReportResult"}},"annotations":{"type":"array","items":{"$ref":"#/components/schemas/Annotation"}},"ms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["period","currency","results","annotations","ms"],"additionalProperties":false},"AnalyticsRange":{"type":"string","enum":["7d","30d","90d"]},"AnalyticsSettings":{"type":"object","properties":{"consentMode":{"$ref":"#/components/schemas/ConsentMode"},"respectGpc":{"type":"boolean"},"sessionTimeoutMin":{"type":"integer","minimum":5,"maximum":120},"botFilter":{"type":"string","enum":["standard","strict"]},"excludedPaths":{"maxItems":20,"type":"array","items":{"type":"string","pattern":"^\\/[A-Za-z0-9/_.-]{0,99}$"}},"defaultModel":{"$ref":"#/components/schemas/AttributionModel"},"lookbackDays":{"type":"integer","minimum":1,"maximum":90}},"required":["consentMode","respectGpc","sessionTimeoutMin","botFilter","excludedPaths","defaultModel","lookbackDays"],"additionalProperties":false},"Annotation":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AnnotationId"},"date":{"$ref":"#/components/schemas/IsoDate"},"title":{"type":"string","minLength":1,"maxLength":80},"body":{"type":"string","maxLength":500},"tone":{"$ref":"#/components/schemas/AnnotationTone"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"createdBy":{"type":"string"}},"required":["id","date","title","body","tone","createdAt","createdBy"],"additionalProperties":false},"AnnotationId":{"type":"string","pattern":"^ano_[0-9a-hjkmnp-tv-z]{20}$"},"AnnotationTone":{"type":"string","enum":["neutral","accent","good","warn","danger"]},"AnnouncementAck":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"$ref":"#/components/schemas/StoreHandle"},"userName":{"type":"string"},"ackedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["storeId","storeName","storeHandle","userName","ackedAt"],"additionalProperties":false},"AnnouncementCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ended":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","scheduled","live","ended"],"additionalProperties":false},"AnnouncementEmailCounts":{"type":"object","properties":{"recipients":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"queued":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["recipients","queued","sent","failed"],"additionalProperties":false},"AnnouncementId":{"type":"string","pattern":"^ann_[0-9a-hjkmnp-tv-z]{20}$"},"AnnouncementState":{"type":"string","enum":["scheduled","live","expired","archived"]},"AnswerUnrequestedThemeVersionResponse":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/ThemeSummary"},"restored":{"anyOf":[{"$ref":"#/components/schemas/ThemeVersionSummary"},{"type":"null"}]},"draftRestored":{"type":"boolean"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["theme","restored","draftRestored","at"],"additionalProperties":false},"ApiKey":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ApiKeyId"},"name":{"type":"string","minLength":1,"maxLength":80},"hint":{"type":"string"},"scopes":{"$ref":"#/components/schemas/ApiKeyScopes"},"createdBy":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"}},"required":["name","email"],"additionalProperties":false},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastUsedIp":{"type":["string","null"]},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"revokedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"allowedIps":{"default":[],"type":"array","items":{"type":"string"}}},"required":["id","name","hint","scopes","createdBy","createdAt","lastUsedAt","lastUsedIp","expiresAt","revokedAt","allowedIps"],"additionalProperties":false},"ApiKeyId":{"type":"string","pattern":"^ak_[0-9a-hjkmnp-tv-z]{20}$"},"ApiKeyScopes":{"type":"object","propertyNames":{"$ref":"#/components/schemas/ApiScopeArea"},"additionalProperties":{"$ref":"#/components/schemas/ApiScopeLevel"},"required":["store","catalog","orders","customers","marketing","storefront","analytics","balance","webhooks","security","team","audit","support","settings","payments"]},"ApiKeyUsage":{"type":"object","properties":{"keyId":{"anyOf":[{"$ref":"#/components/schemas/ApiKeyId"},{"type":"null"}]},"range":{"type":"string","enum":["24h","7d","30d"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"p50Ms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"p95Ms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"series":{"type":"array","items":{"$ref":"#/components/schemas/ApiUsagePoint"}},"topRoutes":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string"},"route":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["method","route","count","failed"],"additionalProperties":false}},"perKey":{"type":"array","items":{"type":"object","properties":{"keyId":{"$ref":"#/components/schemas/ApiKeyId"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spark":{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}},"required":["keyId","total","failed","spark"],"additionalProperties":false}}},"required":["keyId","range","total","failed","p50Ms","p95Ms","series","topRoutes","perKey"],"additionalProperties":false},"ApiRequestId":{"type":"string","pattern":"^akr_[0-9a-hjkmnp-tv-z]{20}$"},"ApiRequestLog":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ApiRequestId"},"keyId":{"anyOf":[{"$ref":"#/components/schemas/ApiKeyId"},{"type":"null"}]},"keyName":{"type":["string","null"]},"appName":{"type":["string","null"]},"method":{"type":"string"},"path":{"type":"string"},"route":{"type":["string","null"]},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"durationMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ip":{"type":"string"},"userAgent":{"type":"string"},"errorType":{"type":["string","null"]},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","keyId","keyName","appName","method","path","route","status","durationMs","ip","userAgent","errorType","at"],"additionalProperties":false},"ApiScopeArea":{"type":"string","enum":["store","catalog","orders","customers","marketing","storefront","analytics","balance","webhooks","security","team","audit","support","settings","payments"]},"ApiScopeLevel":{"type":"string","enum":["none","read","write"]},"ApiUsagePoint":{"type":"object","properties":{"at":{"$ref":"#/components/schemas/Timestamp"},"ok":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["at","ok","failed"],"additionalProperties":false},"AppDirectory":{"type":"object","properties":{"installed":{"type":"array","items":{"$ref":"#/components/schemas/InstalledApp"}},"consent":{"type":"object","properties":{"bannerFrom":{"type":"string","enum":["cookie_consent_app","integrations","none"]},"categories":{"type":"array","items":{"$ref":"#/components/schemas/ConsentCategory"}}},"required":["bannerFrom","categories"],"additionalProperties":false},"plugins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"},"status":{"type":"string"},"version":{"type":["string","null"]}},"required":["id","name","kind","status","version"],"additionalProperties":false}}},"required":["installed","consent","plugins"],"additionalProperties":false},"AppId":{"type":"string","enum":["purchase_alerts","coupon_popup","exit_intent","upsell_popup","countdown_banner","trust_badges","status_board","live_chat","discord_widget","telegram_notify","google_analytics","meta_pixel","tiktok_pixel","cookie_consent","age_gate","currency_display","reviews_carousel","faq_bot","content_protection","maintenance_page","back_in_stock","recently_viewed","wishlist","bought_together","email_popup","tab_reminder","promo_bar","payment_icons","delivery_notice","store_stats","activation_guide","trustpilot","scam_notice","discord_posts","chat_buttons","share_buttons","affiliate_invite","x_pixel","reddit_pixel","google_ads","cookieless_analytics","region_notice","privacy_requests","away_notice"]},"AppPair":{"type":"object","properties":{"a":{"type":"string","maxLength":600},"b":{"type":"string","maxLength":600}},"required":["a","b"],"additionalProperties":false},"AppPreviewLinkResponse":{"type":"object","properties":{"url":{"type":"string"},"app":{"$ref":"#/components/schemas/InstalledApp"}},"required":["url","app"],"additionalProperties":false},"AppTimeZone":{"type":"string","enum":["UTC","Europe/London","Europe/Berlin","Europe/Istanbul","Europe/Moscow","Asia/Dubai","Asia/Kolkata","Asia/Singapore","Asia/Shanghai","Asia/Tokyo","Australia/Sydney","America/New_York","America/Chicago","America/Denver","America/Los_Angeles","America/Sao_Paulo"]},"AppTrustBadge":{"type":"string","enum":["instant_delivery","secure_checkout","encrypted","support","verified_reviews","refund_policy","undetected","discord_community"]},"AppValue":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}},{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/AppPair"}}]},"AppValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9]{0,39}$"},"additionalProperties":{"$ref":"#/components/schemas/AppValue"}},"AppliedDiscount":{"type":"object","properties":{"discountId":{"$ref":"#/components/schemas/DiscountId"},"code":{"type":["string","null"]},"title":{"type":"string"},"kind":{"$ref":"#/components/schemas/DiscountKind"},"amountMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["discountId","code","title","kind","amountMinor"],"additionalProperties":false},"AppliedGiftCard":{"type":"object","properties":{"giftCardId":{"$ref":"#/components/schemas/GiftCardId"},"last4":{"type":"string"},"appliedMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"remainingMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["giftCardId","last4","appliedMinor","remainingMinor"],"additionalProperties":false},"ApplyThemeImportResponse":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/ThemeSummary"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["theme","revision"],"additionalProperties":false},"ApplyThemeUpdateResponse":{"type":"object","properties":{"draft":{"$ref":"#/components/schemas/ThemeDraft"},"update":{"$ref":"#/components/schemas/ThemeUpdatePreview"},"theme":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ThemeSummary"},{"type":"null"}]},"version":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ThemeVersionSummary"},{"type":"null"}]},"rollback":{"default":null,"anyOf":[{"type":"object","properties":{"versionId":{"$ref":"#/components/schemas/ThemeVersionId"},"number":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["versionId","number"],"additionalProperties":false},{"type":"null"}]}},"required":["draft","update","theme","version","rollback"],"additionalProperties":false},"AssignableRole":{"type":"string","enum":["admin","staff","support","finance","custom"]},"AssistantAction":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AssistantActionId"},"title":{"type":"string"},"summary":{"type":"string"},"area":{"type":"string"},"risk":{"$ref":"#/components/schemas/AssistantActionRisk"},"confirmText":{"type":["string","null"]},"applyLabel":{"type":"string"},"changes":{"type":"array","items":{"$ref":"#/components/schemas/AssistantChange"}},"image":{"anyOf":[{"type":"object","properties":{"url":{"type":"string"},"source":{"type":"string","enum":["attachment","link"]}},"required":["url","source"],"additionalProperties":false},{"type":"null"}]},"status":{"$ref":"#/components/schemas/AssistantActionStatus"},"result":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"href":{"type":["string","null"]}},"required":["message","href"],"additionalProperties":false},{"type":"null"}]},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","title","summary","area","risk","confirmText","applyLabel","changes","image","status","result","error","createdAt","expiresAt"],"additionalProperties":false},"AssistantActionId":{"type":"string","pattern":"^aiac_[0-9a-hjkmnp-tv-z]{20}$"},"AssistantActionRisk":{"type":"string","enum":["apply","confirm"]},"AssistantActionStatus":{"type":"string","enum":["proposed","applied","discarded","failed"]},"AssistantAnswer":{"type":"object","properties":{"text":{"type":"string"},"costMicroUsd":{"$ref":"#/components/schemas/MicroUsd"}},"required":["text","costMicroUsd"],"additionalProperties":false},"AssistantChange":{"type":"object","properties":{"label":{"type":"string"},"before":{"type":["string","null"]},"after":{"type":["string","null"]}},"required":["label","before","after"],"additionalProperties":false},"AttachmentContentType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf","text/plain","application/zip"]},"AttributeKey":{"type":"string","enum":["actor.department","actor.tags","actor.two_factor","actor.via_api_key","actor.role","actor.member_days","context.hour","context.weekday","context.ip","context.country","resource.type","product.type","product.tags","product.collections","product.price","product.status","order.total","order.country","order.status","order.product_types","order.collections","order.test","customer.country","store.country","store.region"]},"AttributeSnapshot":{"type":"object","propertyNames":{"$ref":"#/components/schemas/AttributeKey"},"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"maxItems":200,"type":"array","items":{"type":"string"}},{"type":"null"}]}},"AttributionDimension":{"type":"string","enum":["channel","source","campaign","source_medium","affiliate","landing"]},"AttributionModel":{"type":"string","enum":["first_touch","last_touch","last_non_direct","linear","position_based","time_decay"]},"AttributionReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"dimension":{"$ref":"#/components/schemas/AttributionDimension"},"lookbackDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"models":{"type":"array","items":{"$ref":"#/components/schemas/AttributionModel"}},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"untracked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rows":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"conversions":{"type":"array","items":{"type":"number"}},"revenueMinor":{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}},"required":["key","conversions","revenueMinor"],"additionalProperties":false}},"paths":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"conversions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","conversions","revenueMinor"],"additionalProperties":false}},"avgTouches":{"type":"number"},"avgHoursToConvert":{"type":"number"}},"required":["period","currency","dimension","lookbackDays","models","orders","untracked","revenueMinor","rows","paths","avgTouches","avgHoursToConvert"],"additionalProperties":false},"AudienceCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subscribed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unsubscribed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"not_subscribed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"suppressed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","subscribed","pending","unsubscribed","not_subscribed","suppressed"],"additionalProperties":false},"AudienceSegment":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AudienceSegmentId"},"name":{"type":"string"},"description":{"type":"string"},"rules":{"$ref":"#/components/schemas/SegmentRules"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","description","rules","count","countedAt","updatedAt"],"additionalProperties":false},"AudienceSegmentId":{"type":"string","pattern":"^seg_[0-9a-hjkmnp-tv-z]{20}$"},"AuditAction":{"type":"string","enum":["plan.create","plan.update","store.plan","store.fee_override","store.status","gateway.update","settings.update","payouts.run","payout.mark","admin.invite","admin.invite_revoke","admin.role","admin.deactivate","admin.reactivate","admin.join","announcement.create","announcement.update","announcement.archive","support.view_start","support.view_end","plan_invoice.mark_paid","admin.mfa_enroll","admin.mfa_reset","platform_blocklist.add","platform_blocklist.remove","pay.mode","pay.defaults","pay_application.approve","pay_application.reject","pay_application.request_info","pay_application.document_view","pay.limits","pay.access","pay.payout_hold","pay.manual_payout","pay.flags","feature.global","feature.grant","feature.revoke","pay.method_caps","ai_credits.adjust","template.developer_invite","template.invite_revoke","template.developer_update","template.visibility","template.release_withdraw","template.release_review","template.release_discard","template.reorder","template.default","desk.open","desk.settings","community.connect","community.disconnect","community.setup","community.settings","community.moderate","community.post","community.incident","community.verification","community.restore","abuse_report.decide","user.password_reset","user.email_change","user.confirmation_resend","user.email_confirm","user.two_factor_reset","user.google_unlink","user.sign_out","user.lock","user.unlock","user.rename","user.note","user.export","store.member_role","store.member_remove","store.owner_transfer","store.handle","store.test_mode","store.domain_remove","store.product_takedown","store.product_restore","store.cache_purge","store.search_rebuild","store.note","store.tax_category","store.referral_remove","user.replay_view","user.activity_exclude","activity.settings","user.impersonate","user.impersonate_end","blog.create","blog.update","blog.publish","blog.unpublish","blog.delete","blog.media","store.plan_limits","store.trial","plan_invoice.void","plan_voucher.create","plan_voucher.update"]},"AuditAlertKind":{"type":"string","enum":["payout_destination","api_key_created","role_change","member_removed","ownership_transfer","access_policy","fraud_rules","webhook_endpoint","audit_settings"]},"AuditEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AuditEntryId"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"admin":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"}},"required":["id","name","email"],"additionalProperties":false},{"type":"null"}]},"action":{"$ref":"#/components/schemas/AuditAction"},"targetType":{"$ref":"#/components/schemas/AuditTarget"},"targetId":{"type":["string","null"]},"targetLabel":{"type":"string"},"summary":{"type":"string"},"before":{"anyOf":[{"$ref":"#/components/schemas/Shared0"},{"type":"null"}]},"after":{"anyOf":[{"$ref":"#/components/schemas/Shared1"},{"type":"null"}]},"reason":{"type":["string","null"]},"ip":{"type":"string"}},"required":["id","createdAt","admin","action","targetType","targetId","targetLabel","summary","before","after","reason","ip"],"additionalProperties":false},"AuditEntryId":{"type":"string","pattern":"^aud_[0-9a-hjkmnp-tv-z]{20}$"},"AuditFieldChange":{"type":"object","properties":{"field":{"type":"string"},"before":{"type":["string","number","boolean","null"]},"after":{"type":["string","number","boolean","null"]}},"required":["field","before","after"],"additionalProperties":false},"AuditScalar":{"type":["string","number","boolean","null"]},"AuditSettingsView":{"type":"object","properties":{"retentionDays":{"type":"integer","minimum":30,"maximum":2555},"alerts":{"type":"array","items":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/AuditAlertKind"},"enabled":{"type":"boolean"}},"required":["kind","enabled"],"additionalProperties":false}},"oldestEntryAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"entries":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastPrunedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"alerts30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["retentionDays","alerts","oldestEntryAt","entries","lastPrunedAt","alerts30d"],"additionalProperties":false},"AuditTarget":{"type":"string","enum":["plan","store","gateway","settings","payout","admin_user","announcement","platform_blocklist","pay_application","feature_flag","template","template_developer","desk","community","abuse_report","user","blog_post","plan_voucher"]},"AuditTimeline":{"type":"object","properties":{"target":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"label":{"type":["string","null"]}},"required":["type","id","label"],"additionalProperties":false},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreAuditEntryId"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"actor":{"$ref":"#/components/schemas/StoreAuditActor"},"action":{"type":"string"},"area":{"type":"string"},"summary":{"type":"string"},"method":{"type":"string","enum":["POST","PUT","PATCH","DELETE"]},"path":{"type":"string"},"target":{"anyOf":[{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"label":{"type":["string","null"]}},"required":["type","id","label"],"additionalProperties":false},{"type":"null"}]},"details":{"$ref":"#/components/schemas/StoreAuditDetails"},"ip":{"type":"string"},"userAgent":{"type":["string","null"]},"before":{"default":null,"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/AuditScalar"}},{"type":"null"}]},"after":{"default":null,"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/AuditScalar"}},{"type":"null"}]},"alert":{"default":null,"type":["string","null"]},"via":{"default":null,"anyOf":[{"type":"string","enum":["ai","mcp"]},{"type":"null"}]},"changes":{"type":"array","items":{"$ref":"#/components/schemas/AuditFieldChange"}}},"required":["id","createdAt","actor","action","area","summary","method","path","target","details","ip","userAgent","before","after","alert","via","changes"],"additionalProperties":false}}},"required":["target","entries"],"additionalProperties":false},"AuthProviders":{"type":"object","properties":{"google":{"type":"boolean"}},"required":["google"],"additionalProperties":false},"AutoRenewGateway":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"label":{"type":"string"},"capable":{"type":"boolean"},"enabled":{"type":"boolean"},"how":{"type":"string"}},"required":["provider","label","capable","enabled","how"],"additionalProperties":false},"AutoRenewGatewaysView":{"type":"object","properties":{"gateways":{"type":"array","items":{"$ref":"#/components/schemas/AutoRenewGateway"}},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["gateways","updatedAt"],"additionalProperties":false},"AutoRenewMetrics":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"mrrMinor":{"$ref":"#/components/schemas/MinorUnits"},"activeAutoRenew":{"type":"integer","minimum":0,"maximum":9007199254740991},"autoRenewShareBps":{"type":"integer","minimum":0,"maximum":10000},"retrying":{"type":"integer","minimum":0,"maximum":9007199254740991},"charged30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"recovered30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"failed30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"upcoming7dMinor":{"$ref":"#/components/schemas/MinorUnits"},"upcoming7d":{"type":"integer","minimum":0,"maximum":9007199254740991},"allowedProducts":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["currency","mrrMinor","activeAutoRenew","autoRenewShareBps","retrying","charged30dMinor","recovered30dMinor","failed30d","upcoming7dMinor","upcoming7d","allowedProducts"],"additionalProperties":false},"AutoRenewOffer":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"title":{"type":"string"},"every":{"type":"string"},"amountMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"consentText":{"type":"string"},"methods":{"type":"array","items":{"type":"string"}}},"required":["productId","variantId","title","every","amountMinor","currency","consentText","methods"],"additionalProperties":false},"AutoRenewOffers":{"type":"object","properties":{"offers":{"type":"array","items":{"$ref":"#/components/schemas/AutoRenewOffer"}}},"required":["offers"],"additionalProperties":false},"AutoRenewProductSettings":{"type":"object","properties":{"allowed":{"type":"boolean"},"retryDays":{"$ref":"#/components/schemas/RetryDays"},"graceDays":{"type":"integer","minimum":0,"maximum":30}},"required":["allowed","retryDays","graceDays"],"additionalProperties":false},"AutoRenewState":{"type":"string","enum":["on","retrying","action_required","off"]},"AwayNoticeSettings":{"type":"object","properties":{"message":{"default":"We are away until {date}. Orders still deliver right away; replies to messages may take a little longer.","type":"string","minLength":1,"maxLength":200},"startsAt":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"endsAt":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"position":{"default":"top","type":"string","enum":["top","bottom"]},"tone":{"default":"dark","type":"string","enum":["accent","dark","warn"]},"dismissible":{"default":true,"type":"boolean"}},"required":["message","startsAt","endsAt","position","tone","dismissible"],"additionalProperties":false},"BackInStockSettings":{"type":"object","properties":{"heading":{"default":"Get an email when it is back","type":"string","minLength":1,"maxLength":80},"body":{"default":"Leave your email and we send one message the moment you can buy it again. Nothing else.","type":"string","maxLength":220},"buttonLabel":{"default":"Notify me","type":"string","minLength":1,"maxLength":30},"successText":{"default":"Done. We will email you once, when it is back.","type":"string","minLength":1,"maxLength":160},"options":{"default":true,"type":"boolean"}},"required":["heading","body","buttonLabel","successText","options"],"additionalProperties":false},"BacktestResult":{"type":"object","properties":{"source":{"type":"string","enum":["checks","orders"]},"evaluated":{"type":"integer","minimum":0,"maximum":9007199254740991},"changed":{"type":"integer","minimum":0,"maximum":9007199254740991},"before":{"type":"object","properties":{"allow":{"type":"integer","minimum":0,"maximum":9007199254740991},"review":{"type":"integer","minimum":0,"maximum":9007199254740991},"block":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["allow","review","block"],"additionalProperties":false},"after":{"type":"object","properties":{"allow":{"type":"integer","minimum":0,"maximum":9007199254740991},"review":{"type":"integer","minimum":0,"maximum":9007199254740991},"block":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["allow","review","block"],"additionalProperties":false},"affectedMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"rules":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"name":{"type":"string"},"hits":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["ruleId","name","hits"],"additionalProperties":false}},"samples":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"before":{"$ref":"#/components/schemas/FraudAction"},"after":{"$ref":"#/components/schemas/FraudAction"},"scoreBefore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scoreAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"rulesHit":{"type":"array","items":{"type":"string"}}},"required":["id","email","createdAt","before","after","scoreBefore","scoreAfter","totalMinor","rulesHit"],"additionalProperties":false}}},"required":["source","evaluated","changed","before","after","affectedMinor","currency","rules","samples"],"additionalProperties":false},"Balance":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"availableMinor":{"$ref":"#/components/schemas/MinorUnits"},"pendingMinor":{"$ref":"#/components/schemas/MinorUnits"},"reserveMinor":{"$ref":"#/components/schemas/MinorUnits"},"nextPayout":{"anyOf":[{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["date","amountMinor"],"additionalProperties":false},{"type":"null"}]},"schedule":{"type":"object","properties":{"payoutSchedule":{"type":"string","enum":["daily","weekly","monthly"]},"payoutWeekday":{"type":"integer","minimum":0,"maximum":6},"holdDays":{"type":"integer","minimum":0,"maximum":90}},"required":["payoutSchedule","payoutWeekday","holdDays"],"additionalProperties":false},"payouts":{"type":"array","items":{"$ref":"#/components/schemas/Payout"}},"payoutRuns":{"default":null,"anyOf":[{"type":"object","properties":{"automatic":{"type":"boolean"},"onSchedule":{"type":"boolean"},"nextRunAt":{"$ref":"#/components/schemas/Timestamp"},"lastRunAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["automatic","onSchedule","nextRunAt","lastRunAt"],"additionalProperties":false},{"type":"null"}]},"leftover":{"default":null,"anyOf":[{"type":"object","properties":{"heldMinor":{"$ref":"#/components/schemas/MinorUnits"},"blocked":{"type":"boolean"}},"required":["heldMinor","blocked"],"additionalProperties":false},{"type":"null"}]},"wallet":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PayoutWallet"},{"type":"null"}]},"payoutFeeMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"payoutMinimumMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["currency","paymentModel","availableMinor","pendingMinor","reserveMinor","nextPayout","schedule","payouts","payoutRuns","leftover","wallet","payoutFeeMinor","payoutMinimumMinor"],"additionalProperties":false},"BalanceSet":{"type":"object","properties":{"pendingMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"availableMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reserveMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputeHoldMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pendingMinor","availableMinor","reserveMinor","disputeHoldMinor","totalMinor"],"additionalProperties":false},"BalanceSummary":{"type":"object","properties":{"shown":{"type":"boolean"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"withdrawableMinor":{"$ref":"#/components/schemas/MinorUnits"},"clearingMinor":{"$ref":"#/components/schemas/MinorUnits"},"highRiskHoldMinor":{"$ref":"#/components/schemas/MinorUnits"},"reserveMinor":{"$ref":"#/components/schemas/MinorUnits"},"disputeHoldMinor":{"$ref":"#/components/schemas/MinorUnits"},"inPayoutMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"nextRelease":{"anyOf":[{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"highRisk":{"type":"boolean"}},"required":["date","amountMinor","highRisk"],"additionalProperties":false},{"type":"null"}]},"holdDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"highRiskHoldDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["shown","currency","withdrawableMinor","clearingMinor","highRiskHoldMinor","reserveMinor","disputeHoldMinor","inPayoutMinor","totalMinor","nextRelease","holdDays","highRiskHoldDays"],"additionalProperties":false},"BannerTone":{"type":"string","enum":["accent","ink","canvas"]},"BillingCard":{"type":"object","properties":{"provider":{"type":"string","enum":["stripe","sandbox"]},"brand":{"type":"string"},"last4":{"type":"string","pattern":"^[0-9]{4}$"},"expMonth":{"type":"integer","minimum":1,"maximum":12},"expYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"addedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["provider","brand","last4","expMonth","expYear","addedAt"],"additionalProperties":false},"BillingCardStart":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"stripe"},"publishableKey":{"type":"string"},"clientSecret":{"type":"string"},"setupIntentId":{"type":"string","format":"starts_with","pattern":"^seti_.*"}},"required":["kind","publishableKey","clientSecret","setupIntentId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"sandbox"}},"required":["kind"],"additionalProperties":false}]},"BillingCardView":{"type":"object","properties":{"card":{"anyOf":[{"$ref":"#/components/schemas/BillingCard"},{"type":"null"}]}},"required":["card"],"additionalProperties":false},"BillingCheckoutLink":{"type":"object","properties":{"url":{"type":["string","null"]}},"required":["url"],"additionalProperties":false},"BillingOverview":{"type":"object","properties":{"fees":{"$ref":"#/components/schemas/StoreFees"},"plans":{"type":"array","items":{"$ref":"#/components/schemas/BillingPlanOption"}},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"statement":{"type":"array","items":{"$ref":"#/components/schemas/StatementMonth"}},"planChangedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"pendingInvoice":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PlanInvoice"},{"type":"null"}]},"invoices":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/PlanInvoice"}},"comp":{"default":null,"anyOf":[{"$ref":"#/components/schemas/SellerPlanComp"},{"type":"null"}]},"cardOnFile":{"default":null,"type":["string","null"]},"planOverview":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PlanOverview"},{"type":"null"}]},"voucher":{"default":null,"anyOf":[{"$ref":"#/components/schemas/SellerPlanVoucher"},{"type":"null"}]},"trialNext":{"default":null,"anyOf":[{"$ref":"#/components/schemas/TrialNext"},{"type":"null"}]},"scheduled":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ScheduledPlanChange"},{"type":"null"}]},"paidPeriod":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PaidPeriod"},{"type":"null"}]},"hostedCheckout":{"default":false,"type":"boolean"},"billingDetails":{"default":null,"anyOf":[{"$ref":"#/components/schemas/LegalDetails"},{"type":"null"}]},"cards":{"default":null,"anyOf":[{"type":"object","properties":{"main":{"anyOf":[{"$ref":"#/components/schemas/BillingCard"},{"type":"null"}]},"backup":{"anyOf":[{"$ref":"#/components/schemas/BillingCard"},{"type":"null"}]}},"required":["main","backup"],"additionalProperties":false},{"type":"null"}]},"cardRemoval":{"default":null,"anyOf":[{"type":"object","properties":{"main":{"type":"object","properties":{"allowed":{"type":"boolean"},"reason":{"type":["string","null"]}},"required":["allowed","reason"],"additionalProperties":false},"backup":{"type":"object","properties":{"allowed":{"type":"boolean"},"reason":{"type":["string","null"]}},"required":["allowed","reason"],"additionalProperties":false}},"required":["main","backup"],"additionalProperties":false},{"type":"null"}]}},"required":["fees","plans","currency","statement","planChangedAt","pendingInvoice","invoices","comp","cardOnFile","planOverview","voucher","trialNext","scheduled","paidPeriod","hostedCheckout","billingDetails","cards","cardRemoval"],"additionalProperties":false},"BillingPlanOption":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanId"},"name":{"type":"string"},"monthlyPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"fees":{"$ref":"#/components/schemas/FeeSchedule"},"allowedModels":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PaymentModel"}},"current":{"type":"boolean"},"unavailableReason":{"type":["string","null"]},"limits":{"$ref":"#/components/schemas/PlanLimits"},"trialDays":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","monthlyPriceMinor","currency","fees","allowedModels","current","unavailableReason"],"additionalProperties":false},"BlocklistEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/BlocklistEntryId"},"kind":{"$ref":"#/components/schemas/BlocklistKind"},"value":{"type":"string"},"reason":{"type":"string"},"matches30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"addedBy":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","value","reason","matches30d","addedBy","createdAt"],"additionalProperties":false},"BlocklistEntryId":{"type":"string","pattern":"^blk_[0-9a-hjkmnp-tv-z]{20}$"},"BlocklistKind":{"type":"string","enum":["email","email_domain","ip","ip_range","country","asn","device","discord_id","card_fingerprint"]},"BlogArt":{"type":"string","enum":["versus","stack","ribbon","grid"]},"BlogAssetSrc":{"type":"string","minLength":1,"maxLength":1000,"pattern":"^(\\/(?!\\/)[^\\s<>\"'\\\\]*|https:\\/\\/[^\\s<>\"'\\\\]+)$"},"BlogChart":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":140},"caption":{"default":"","type":"string","maxLength":400},"bars":{"minItems":1,"maxItems":12,"type":"array","items":{"$ref":"#/components/schemas/BlogChartBar"}}},"required":["title","caption","bars"],"additionalProperties":false},"BlogChartBar":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":80},"value":{"type":"number","minimum":0,"maximum":1000000000},"display":{"default":"","type":"string","maxLength":40},"highlight":{"default":false,"type":"boolean"}},"required":["label","value","display","highlight"],"additionalProperties":false},"BlogComparison":{"type":"object","properties":{"competitor":{"type":"string","minLength":1,"maxLength":60},"caption":{"default":"","type":"string","maxLength":300},"rows":{"minItems":1,"maxItems":40,"type":"array","items":{"$ref":"#/components/schemas/BlogComparisonRow"}}},"required":["competitor","caption","rows"],"additionalProperties":false},"BlogComparisonRow":{"type":"object","properties":{"feature":{"type":"string","minLength":1,"maxLength":200},"shopfast":{"type":"string","maxLength":500},"competitor":{"type":"string","maxLength":500}},"required":["feature","shopfast","competitor"],"additionalProperties":false},"BlogCover":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"art"},"art":{"$ref":"#/components/schemas/BlogArt"},"hue":{"type":"integer","minimum":0,"maximum":360}},"required":["kind","art","hue"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"image"},"src":{"$ref":"#/components/schemas/BlogAssetSrc"},"alt":{"type":"string","minLength":1,"maxLength":300},"width":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]},"height":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":12000},{"type":"null"}]}},"required":["kind","src","alt","width","height"],"additionalProperties":false}]},"BlogFaqItem":{"type":"object","properties":{"question":{"type":"string","minLength":3,"maxLength":300},"answer":{"type":"string","minLength":3,"maxLength":2000}},"required":["question","answer"],"additionalProperties":false},"BlogHowTo":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":200},"steps":{"minItems":2,"maxItems":20,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"text":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","text"],"additionalProperties":false}}},"required":["name","steps"],"additionalProperties":false},"BlogMedia":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/BlogMediaId"},"filename":{"type":"string"},"contentType":{"$ref":"#/components/schemas/BlogMediaType"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"src":{"type":"string"},"url":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","filename","contentType","bytes","width","height","src","url","createdAt"],"additionalProperties":false},"BlogMediaId":{"type":"string","pattern":"^bmd_[0-9a-hjkmnp-tv-z]{20}$"},"BlogMediaType":{"type":"string","enum":["image/png","image/jpeg","image/webp","image/gif","video/mp4","video/webm"]},"BlogPostId":{"type":"string","pattern":"^blg_[0-9a-hjkmnp-tv-z]{20}$"},"BlogSlug":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"BlogSource":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":200},"url":{"type":"string","maxLength":1000,"pattern":"^https:\\/\\/[^\\s<>\"'\\\\]+$"}},"required":["label","url"],"additionalProperties":false},"BlogStatus":{"type":"string","enum":["draft","published"]},"BlogVideo":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"embed"},"url":{"type":"string","maxLength":500},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","url","title"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"file"},"src":{"$ref":"#/components/schemas/BlogAssetSrc"},"poster":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BlogAssetSrc"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","src","poster","title"],"additionalProperties":false}]},"BogoRule":{"type":"object","properties":{"type":{"type":"string","const":"bogo"},"buy":{"type":"integer","minimum":1,"maximum":20},"get":{"type":"integer","minimum":1,"maximum":20},"percentBps":{"type":"integer","minimum":1,"maximum":10000},"maxUses":{"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]}},"required":["type","buy","get","percentBps","maxUses"],"additionalProperties":false},"BotCategory":{"type":"string","enum":["search","ai_answers","ai_training","seo","social_preview","monitoring","feed","automation","other"]},"BotsReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"totals":{"type":"object","properties":{"hits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"humanHits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"botHits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"botShareBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousBotHits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"declared":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spoofed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"suspicious":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["hits","humanHits","botHits","botShareBps","previousBotHits","verified","declared","spoofed","suspicious"],"additionalProperties":false},"byClass":{"type":"array","items":{"type":"object","properties":{"traffic":{"$ref":"#/components/schemas/TrafficClass"},"hits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["traffic","hits"],"additionalProperties":false}},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/BotCategory"},"hits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bots":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["category","hits","bots"],"additionalProperties":false}},"bots":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"owner":{"type":"string"},"category":{"$ref":"#/components/schemas/BotCategory"},"hits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verifiedHits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spoofedHits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"declaredHits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"},"previousHits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","owner","category","hits","verifiedHits","spoofedHits","declaredHits","paths","lastSeenAt","previousHits"],"additionalProperties":false}},"series":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"hour":{"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"human":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"verified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"declared":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spoofed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"suspicious":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","hour","human","verified","declared","spoofed","suspicious"],"additionalProperties":false}},"paths":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"hits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bots":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","hits","bots"],"additionalProperties":false}},"suspicious":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"device":{"type":"string"},"browser":{"type":"string"},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avgScore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["country","device","browser","sessions","pageviews","avgScore"],"additionalProperties":false}}},"required":["period","totals","byClass","categories","bots","series","paths","suspicious"],"additionalProperties":false},"BoughtTogetherSettings":{"type":"object","properties":{"heading":{"default":"Often bought together","type":"string","minLength":1,"maxLength":60},"maxItems":{"default":2,"type":"integer","minimum":1,"maximum":3},"source":{"default":"orders_then_cross_sells","type":"string","enum":["orders_then_cross_sells","orders","cross_sells"]},"showAddAll":{"default":true,"type":"boolean"}},"required":["heading","maxItems","source","showAddAll"],"additionalProperties":false},"Bps":{"type":"integer","minimum":0,"maximum":10000},"BreakerPhase":{"type":"string","enum":["closed","open","half_open"]},"BroadcastAudience":{"type":"object","properties":{"owners":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"email":{"type":"object","properties":{"eligible":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"array","items":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/BroadcastSkipReason"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["reason","count"],"additionalProperties":false}}},"required":["eligible","skipped"],"additionalProperties":false},"discord":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"telegram":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sample":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"option":{"type":["string","null"]},"purchasedAt":{"$ref":"#/components/schemas/Timestamp"},"active":{"type":"boolean"}},"required":["email","option","purchasedAt","active"],"additionalProperties":false}}},"required":["owners","email","discord","telegram","sample"],"additionalProperties":false},"BroadcastChannels":{"type":"object","properties":{"email":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["email","discord","telegram"],"additionalProperties":false},"BroadcastCounts":{"type":"object","properties":{"recipients":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"emailSent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"emailSkipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"emailFailed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discordQueued":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"telegramSent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["recipients","emailSent","emailSkipped","emailFailed","discordQueued","telegramSent"],"additionalProperties":false},"BroadcastFilters":{"type":"object","properties":{"activeOnly":{"default":true,"type":"boolean"},"variantIds":{"default":[],"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/VariantId"}},"purchasedAfter":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"purchasedBefore":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"marketingOnly":{"default":false,"type":"boolean"}},"required":["activeOnly","variantIds","purchasedAfter","purchasedBefore","marketingOnly"],"additionalProperties":false},"BroadcastList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductBroadcast"}}},"required":["items"],"additionalProperties":false},"BroadcastRecipient":{"type":"object","properties":{"email":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"emailStatus":{"$ref":"#/components/schemas/BroadcastRecipientStatus"},"discord":{"$ref":"#/components/schemas/BroadcastRecipientStatus"},"telegram":{"$ref":"#/components/schemas/BroadcastRecipientStatus"},"skipReason":{"type":["string","null"]}},"required":["email","customerId","orderId","orderNumber","emailStatus","discord","telegram","skipReason"],"additionalProperties":false},"BroadcastRecipientStatus":{"type":"string","enum":["queued","sent","skipped","failed","none"]},"BroadcastSkipReason":{"type":"string","enum":["unsubscribed","product_updates_off","suppressed","no_marketing_consent","refunded","expired"]},"BroadcastStatus":{"type":"string","enum":["sending","sent","failed"]},"BucketKey":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"hour":{"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]}},"required":["date","hour"],"additionalProperties":false},"BuilderApplied":{"type":"object","properties":{"patchIds":{"type":"array","items":{"type":"string"}},"themeId":{"anyOf":[{"$ref":"#/components/schemas/ThemeId"},{"type":"null"}]},"installedTheme":{"type":"boolean"},"revisionBefore":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"revisionAfter":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"productIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"pageHandles":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"previous":{"type":"object","properties":{"store":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"tagline":{"type":"string"}},"required":["name","tagline"],"additionalProperties":false},{"type":"null"}]},"pages":{"type":"array","items":{"type":"object","properties":{"handle":{"type":"string"},"existed":{"type":"boolean"},"title":{"type":"string"},"bodyHtml":{"type":"string"},"published":{"type":"boolean"}},"required":["handle","existed","title","bodyHtml","published"],"additionalProperties":false}}},"required":["store","pages"],"additionalProperties":false}},"required":["patchIds","themeId","installedTheme","revisionBefore","revisionAfter","productIds","pageHandles","notes","previous"],"additionalProperties":false},"BuilderLimits":{"type":"object","properties":{"runsLeftThisHour":{"type":"integer","minimum":0,"maximum":9007199254740991},"runsPerHour":{"type":"integer","minimum":0,"maximum":9007199254740991},"spentTodayMicroUsd":{"type":"integer","minimum":0,"maximum":9007199254740991},"dailyBudgetMicroUsd":{"type":"integer","minimum":0,"maximum":9007199254740991},"model":{"type":"string"},"live":{"type":"boolean"}},"required":["runsLeftThisHour","runsPerHour","spentTodayMicroUsd","dailyBudgetMicroUsd","model","live"],"additionalProperties":false},"BuilderLink":{"type":"string","maxLength":120,"pattern":"^\\/(?!\\/)[a-z0-9/_?=&.-]*$"},"BuilderPatch":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^p[0-9]{1,3}$"},"title":{"type":"string","maxLength":120},"summary":{"type":"string","maxLength":300},"kind":{"type":"string","const":"theme"},"stockId":{"$ref":"#/components/schemas/BuilderStockTheme"},"preset":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"settings":{"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeSettingId"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}}},"required":["id","title","summary","kind","stockId","preset","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","pattern":"^p[0-9]{1,3}$"},"title":{"type":"string","maxLength":120},"summary":{"type":"string","maxLength":300},"kind":{"type":"string","const":"section"},"template":{"$ref":"#/components/schemas/BuilderTemplate"},"section":{"$ref":"#/components/schemas/BuilderSectionPlan"}},"required":["id","title","summary","kind","template","section"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","pattern":"^p[0-9]{1,3}$"},"title":{"type":"string","maxLength":120},"summary":{"type":"string","maxLength":300},"kind":{"type":"string","const":"navigation"},"links":{"maxItems":6,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","maxLength":30},"link":{"$ref":"#/components/schemas/BuilderLink"}},"required":["label","link"],"additionalProperties":false}}},"required":["id","title","summary","kind","links"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","pattern":"^p[0-9]{1,3}$"},"title":{"type":"string","maxLength":120},"summary":{"type":"string","maxLength":300},"kind":{"type":"string","const":"store"},"name":{"type":"string","maxLength":60},"tagline":{"type":"string","maxLength":120}},"required":["id","title","summary","kind","name","tagline"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","pattern":"^p[0-9]{1,3}$"},"title":{"type":"string","maxLength":120},"summary":{"type":"string","maxLength":300},"kind":{"type":"string","const":"product"},"product":{"$ref":"#/components/schemas/BuilderProductDraft"}},"required":["id","title","summary","kind","product"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","pattern":"^p[0-9]{1,3}$"},"title":{"type":"string","maxLength":120},"summary":{"type":"string","maxLength":300},"kind":{"type":"string","const":"policy"},"handle":{"$ref":"#/components/schemas/BuilderPolicyHandle"},"pageTitle":{"type":"string","maxLength":120},"body":{"type":"string","maxLength":4000}},"required":["id","title","summary","kind","handle","pageTitle","body"],"additionalProperties":false}]},"BuilderPolicyHandle":{"type":"string","enum":["refund-policy","terms-of-service","privacy-policy"]},"BuilderProductDraft":{"type":"object","properties":{"presetKey":{"$ref":"#/components/schemas/BuiltinPresetKey"},"game":{"anyOf":[{"type":"string","minLength":0,"maxLength":80},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":120},"shortDescription":{"type":"string","minLength":0,"maxLength":300},"description":{"type":"string","minLength":0,"maxLength":3000},"options":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"priceMinor":{"type":"integer","minimum":0,"maximum":10000000,"$ref":"#/components/schemas/MinorUnits"}},"required":["name","priceMinor"],"additionalProperties":false}}},"required":["presetKey","game","name","shortDescription","description","options"],"additionalProperties":false},"BuilderRun":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/BuilderRunId"},"status":{"$ref":"#/components/schemas/BuilderRunStatus"},"brief":{"type":"string"},"model":{"type":"string"},"patches":{"type":"array","items":{"$ref":"#/components/schemas/BuilderPatch"}},"notes":{"type":"array","items":{"type":"string"}},"costMicroUsd":{"type":"integer","minimum":0,"maximum":9007199254740991},"applied":{"anyOf":[{"$ref":"#/components/schemas/BuilderApplied"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"appliedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","status","brief","model","patches","notes","costMicroUsd","applied","createdAt","appliedAt"],"additionalProperties":false},"BuilderRunId":{"type":"string","pattern":"^aib_[0-9a-hjkmnp-tv-z]{20}$"},"BuilderRunStatus":{"type":"string","enum":["ready","applied","undone","failed"]},"BuilderSectionPlan":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ThemeTypeName"},"settings":{"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeSettingId"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}},"blocks":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ThemeTypeName"},"settings":{"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeSettingId"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}}},"required":["type","settings"],"additionalProperties":false}}},"required":["type","settings","blocks"],"additionalProperties":false},"BuilderStockTheme":{"type":"string","enum":["halo","specter","keyline","circuit","nebula","vanta"]},"BuilderTemplate":{"type":"string","enum":["index","product","collection"]},"BuiltinPresetKey":{"type":"string","enum":["game_key","software_license","discord_role","file_download","service"]},"BulkDeleteDiscountsResponse":{"type":"object","properties":{"deleted":{"type":"integer","minimum":0,"maximum":9007199254740991},"disabled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["deleted","disabled"],"additionalProperties":false},"BulkInviteResult":{"type":"object","properties":{"invited":{"type":"array","items":{"$ref":"#/components/schemas/TeamInvite"}},"skipped":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"reason":{"type":"string"}},"required":["email","reason"],"additionalProperties":false}}},"required":["invited","skipped"],"additionalProperties":false},"BulkPresetResult":{"type":"object","properties":{"created":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"options":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","slug","options"],"additionalProperties":false}}},"required":["created"],"additionalProperties":false},"BulkProductsResponse":{"type":"object","properties":{"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"created":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"skipped":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"reason":{"type":"string"}},"required":["productId","reason"],"additionalProperties":false}}},"required":["updated","created","skipped"],"additionalProperties":false},"BulkUpdateTicketsResponse":{"type":"object","properties":{"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["updated"],"additionalProperties":false},"BundlePart":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]}},"required":["productId","variantId"],"additionalProperties":false},"BundlePricing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fixed"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"discountBps":{"type":"integer","minimum":0,"maximum":9500}},"required":["kind","discountBps"],"additionalProperties":false}]},"BundleRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"description":{"type":"string"},"slug":{"type":"string"},"status":{"$ref":"#/components/schemas/ProductStatus"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"valueMinor":{"$ref":"#/components/schemas/MinorUnits"},"savingsMinor":{"$ref":"#/components/schemas/MinorUnits"},"savingsBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"items":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"variantId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"variantName":{"default":null,"type":["string","null"]}},"required":["productId","name","type","priceMinor","variantId","variantName"],"additionalProperties":false}},"pricing":{"default":{"kind":"fixed"},"$ref":"#/components/schemas/BundlePricing"},"unitsSold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"coverUrl":{"type":["string","null"]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","description","slug","status","priceMinor","currency","valueMinor","savingsMinor","savingsBps","items","pricing","unitsSold","revenueMinor","coverUrl","updatedAt"],"additionalProperties":false},"ButtonBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"button"},"label":{"type":"string","maxLength":120},"url":{"type":"string","maxLength":800},"align":{"default":"left","type":"string","enum":["left","center","right"]},"style":{"default":"solid","type":"string","enum":["solid","outline"]},"fullWidth":{"default":false,"type":"boolean"}},"required":["id","type","label","url","align","style","fullWidth"],"additionalProperties":false},"BuyerAccount":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/BuyerAccountId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"phone":{"type":["string","null"]},"country":{"anyOf":[{"$ref":"#/components/schemas/CountryCode"},{"type":"null"}]},"hasPassword":{"type":"boolean"},"marketingOptIn":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"storeCredit":{"default":null,"anyOf":[{"type":"object","properties":{"balanceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["balanceMinor","currency"],"additionalProperties":false},{"type":"null"}]}},"required":["id","email","name","phone","country","hasPassword","marketingOptIn","createdAt","storeCredit"],"additionalProperties":false},"BuyerAccountId":{"type":"string","pattern":"^bya_[0-9a-hjkmnp-tv-z]{20}$"},"BuyerAutoRenewList":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/BuyerAutoRenewSubscription"}}},"required":["subscriptions"],"additionalProperties":false},"BuyerAutoRenewSubscription":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SubscriptionId"},"productName":{"type":"string"},"orderNumber":{"type":"string"},"every":{"type":"string"},"status":{"type":"string","enum":["active","past_due","cancelling","ended"]},"currentPeriodEnd":{"$ref":"#/components/schemas/Timestamp"},"autoRenew":{"$ref":"#/components/schemas/AutoRenewState"},"nextChargeAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"amountMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}]},"card":{"anyOf":[{"$ref":"#/components/schemas/SavedPaymentMethod"},{"type":"null"}]},"consentAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"turnOnText":{"type":["string","null"]},"payUrl":{"type":["string","null"]},"note":{"type":["string","null"]}},"required":["id","productName","orderNumber","every","status","currentPeriodEnd","autoRenew","nextChargeAt","amountMinor","currency","card","consentAt","turnOnText","payUrl","note"],"additionalProperties":false},"BuyerCheckoutStart":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"accessToken":{"type":"string"},"payUrl":{"type":"string"},"sandbox":{"type":"boolean"}},"required":["sessionId","accessToken","payUrl","sandbox"],"additionalProperties":false},"BuyerClaim":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DisputeId"},"reason":{"$ref":"#/components/schemas/ClaimReason"},"status":{"type":"string","enum":["open","resolved"]},"resolution":{"anyOf":[{"$ref":"#/components/schemas/ClaimResolution"},{"type":"null"}]},"message":{"type":"string"},"replies":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","enum":["buyer","seller"]},"body":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["from","body","at"],"additionalProperties":false}},"openedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","reason","status","resolution","message","replies","openedAt"],"additionalProperties":false},"BuyerCommunityAccess":{"type":"object","properties":{"botUsername":{"type":["string","null"]},"items":{"type":"array","items":{"type":"object","properties":{"productName":{"type":"string"},"chatTitle":{"type":"string"},"chatType":{"anyOf":[{"type":"string","enum":["group","supergroup","channel"]},{"type":"null"}]},"status":{"$ref":"#/components/schemas/CommunityGrantStatus"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"joinUrl":{"type":["string","null"]},"removeReason":{"anyOf":[{"$ref":"#/components/schemas/CommunityRemoveReason"},{"type":"null"}]}},"required":["productName","chatTitle","chatType","status","expiresAt","joinUrl","removeReason"],"additionalProperties":false}}},"required":["botUsername","items"],"additionalProperties":false},"BuyerCompleteAttachmentResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketAttachmentId"},"filename":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"contentType":{"type":"string"}},"required":["id","filename","bytes","contentType"],"additionalProperties":false},"BuyerCompleteCardUpdateResponse":{"type":"object","properties":{"subscriptionId":{"$ref":"#/components/schemas/SubscriptionId"},"method":{"anyOf":[{"$ref":"#/components/schemas/SavedPaymentMethod"},{"type":"null"}]},"status":{"type":"string","enum":["completed","cancelled","failed"]}},"required":["subscriptionId","method","status"],"additionalProperties":false},"BuyerCompleteProofUploadResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketAttachmentId"},"filename":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","filename","bytes"],"additionalProperties":false},"BuyerDiscordLinked":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/BuyerDiscordStatus"},"returnTo":{"$ref":"#/components/schemas/BuyerDiscordReturn"},"sessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"joined":{"type":"string","enum":["added","already","skipped","failed"]},"joinDetail":{"default":null,"type":["string","null"]}},"required":["status","returnTo","sessionId","joined","joinDetail"],"additionalProperties":false},"BuyerDiscordReturn":{"type":"string","enum":["order","verify","account"]},"BuyerDiscordStatus":{"type":"object","properties":{"mode":{"type":"string","enum":["live","simulated"]},"eligible":{"type":"boolean"},"guildName":{"type":["string","null"]},"orderNumber":{"type":["string","null"]},"linked":{"anyOf":[{"type":"object","properties":{"username":{"type":["string","null"]},"discordUserId":{"type":"string"},"linkedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/DiscordLinkSource"}},"required":["username","discordUserId","linkedAt","source"],"additionalProperties":false},{"type":"null"}]},"roles":{"type":"array","items":{"$ref":"#/components/schemas/DiscordMemberRole"}},"claim":{"default":null,"anyOf":[{"$ref":"#/components/schemas/DiscordClaim"},{"type":"null"}]},"supportEmail":{"default":null,"type":["string","null"]},"guildId":{"default":null,"type":["string","null"]},"server":{"default":null,"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["joined","failed","unknown"]},"detail":{"type":["string","null"]}},"required":["state","detail"],"additionalProperties":false},{"type":"null"}]}},"required":["mode","eligible","guildName","orderNumber","linked","roles","claim","supportEmail","guildId","server"],"additionalProperties":false},"BuyerGate":{"type":"string","enum":["maintenance","closed"]},"BuyerLibrary":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"value":{"type":"string"},"orderNumber":{"type":"string"},"orderId":{"$ref":"#/components/schemas/OrderId"},"deliveredAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["productId","productName","value","orderNumber","orderId","deliveredAt"],"additionalProperties":false}},"downloads":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"url":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"orderNumber":{"type":"string"},"orderId":{"$ref":"#/components/schemas/OrderId"},"timesBought":{"default":1,"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["productId","name","url","expiresAt","orderNumber","orderId","timesBought"],"additionalProperties":false}},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/BuyerSubscription"}},"notes":{"default":[],"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"kind":{"type":"string","enum":["message","option","keys","service","dynamic","warranty"]},"title":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"bookingUrl":{"type":["string","null"]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"orderNumber":{"type":"string"}},"required":["productId","productName","kind","title","html","text","bookingUrl","turnaroundDays","orderNumber"],"additionalProperties":false}}},"required":["keys","downloads","subscriptions","notes"],"additionalProperties":false},"BuyerLicense":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/LicenseKeyId"},"productName":{"type":"string"},"productSlug":{"type":"string"},"plan":{"$ref":"#/components/schemas/LicensePlanOut"},"keyMasked":{"type":"string"},"sessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"state":{"$ref":"#/components/schemas/BuyerLicenseState"},"clock":{"$ref":"#/components/schemas/LicenseClock"},"startedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"remaining":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"devices":{"anyOf":[{"type":"object","properties":{"max":{"type":"integer","minimum":1,"maximum":9007199254740991},"bound":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/LicenseActivationId"},"label":{"type":"string"},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","label","lastSeenAt"],"additionalProperties":false}},"reset":{"type":"object","properties":{"allowed":{"type":"boolean"},"remaining":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"reason":{"type":["string","null"]}},"required":["allowed","remaining","nextAt","reason"],"additionalProperties":false}},"required":["max","bound","reset"],"additionalProperties":false},{"type":"null"}]},"pause":{"anyOf":[{"type":"object","properties":{"label":{"type":"string"},"color":{"type":"string"},"since":{"$ref":"#/components/schemas/Timestamp"}},"required":["label","color","since"],"additionalProperties":false},{"type":"null"}]},"extend":{"anyOf":[{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"options":{"type":"array","items":{"type":"object","properties":{"variantId":{"$ref":"#/components/schemas/VariantId"},"name":{"type":"string"},"duration":{"anyOf":[{"$ref":"#/components/schemas/DurationKey"},{"type":"null"}]},"label":{"type":"string"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["variantId","name","duration","label","priceMinor"],"additionalProperties":false}},"pwywMinimumPct":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"withdrawalWaiver":{"default":false,"type":"boolean"}},"required":["currency","options","pwywMinimumPct","withdrawalWaiver"],"additionalProperties":false},{"type":"null"}]},"creditedSeconds":{"type":"integer","minimum":0,"maximum":9007199254740991},"replacement":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BuyerReplacement"},{"type":"null"}]},"revokedBy":{"default":null,"anyOf":[{"type":"string","enum":["refunded","chargeback","replaced","seller"]},{"type":"null"}]},"events":{"default":[],"maxItems":30,"type":"array","items":{"$ref":"#/components/schemas/BuyerLicenseEvent"}}},"required":["id","productName","productSlug","plan","keyMasked","sessionId","state","clock","startedAt","expiresAt","remaining","devices","pause","extend","creditedSeconds","replacement","revokedBy","events"],"additionalProperties":false},"BuyerLicenseEvent":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/BuyerLicenseEventKind"},"at":{"$ref":"#/components/schemas/Timestamp"},"text":{"type":"string","maxLength":160}},"required":["kind","at","text"],"additionalProperties":false},"BuyerLicenseEventKind":{"type":"string","enum":["bound","reset","released","extended","credited","time_added","time_removed","started","revoked","replaced","restored","paused","resumed","expired","limit_changed","end_changed"]},"BuyerLicenseState":{"type":"string","enum":["active","not_started","expired","revoked","paused"]},"BuyerLicenses":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/BuyerLicense"}},"now":{"$ref":"#/components/schemas/Timestamp"}},"required":["licenses","now"],"additionalProperties":false},"BuyerMeResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/BuyerAccount"}},"required":["account"],"additionalProperties":false},"BuyerOpenTicketResponse":{"type":"object","properties":{"ticketId":{"$ref":"#/components/schemas/TicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"access":{"type":["string","null"]}},"required":["ticketId","number","access"],"additionalProperties":false},"BuyerOrderSummary":{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"sessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"number":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","type","quantity"],"additionalProperties":false}},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["orderId","sessionId","number","status","currency","totalMinor","items","paidAt","createdAt"],"additionalProperties":false},"BuyerOrdersResponse":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOrderSummary"}}},"required":["orders"],"additionalProperties":false},"BuyerProductUpdate":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductBroadcastId"},"title":{"type":"string"},"version":{"type":"string"},"changelogHtml":{"type":"string"},"publishedAt":{"$ref":"#/components/schemas/Timestamp"},"file":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false},{"type":"null"}]}},"required":["id","title","version","changelogHtml","publishedAt","file"],"additionalProperties":false},"BuyerProductUpdates":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"updates":{"type":"array","items":{"$ref":"#/components/schemas/BuyerProductUpdate"}}},"required":["productId","productName","updates"],"additionalProperties":false}}},"required":["products"],"additionalProperties":false},"BuyerRefundOffer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RefundOfferId"},"storeName":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amountMinor":{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},"bonusMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"status":{"$ref":"#/components/schemas/RefundOfferStatus"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"balanceMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["id","storeName","currency","amountMinor","bonusMinor","status","expiresAt","balanceMinor"],"additionalProperties":false},"BuyerRefundOfferResponse":{"type":"object","properties":{"offer":{"anyOf":[{"$ref":"#/components/schemas/BuyerRefundOffer"},{"type":"null"}]}},"required":["offer"],"additionalProperties":false},"BuyerReplaceResult":{"type":"object","properties":{"outcome":{"type":"string","enum":["replaced","pending"]},"requestId":{"$ref":"#/components/schemas/ReplacementRequestId"},"licenseId":{"$ref":"#/components/schemas/LicenseKeyId"},"message":{"type":"string"}},"required":["outcome","requestId","licenseId","message"],"additionalProperties":false},"BuyerReplacement":{"type":"object","properties":{"allowed":{"type":"boolean"},"blocked":{"type":["string","null"]},"code":{"anyOf":[{"$ref":"#/components/schemas/ReplacementBlock"},{"type":"null"}]},"approval":{"$ref":"#/components/schemas/ReplacementApproval"},"requireReason":{"type":"boolean"},"requireProofText":{"type":"boolean"},"requireProofUpload":{"type":"boolean"},"remaining":{"type":"integer","minimum":0,"maximum":9007199254740991},"max":{"type":"integer","minimum":1,"maximum":9007199254740991},"windowEndsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"isReplacement":{"type":"boolean"},"last":{"anyOf":[{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ReplacementStatus"},"at":{"$ref":"#/components/schemas/Timestamp"},"note":{"type":"string"}},"required":["status","at","note"],"additionalProperties":false},{"type":"null"}]}},"required":["allowed","blocked","code","approval","requireReason","requireProofText","requireProofUpload","remaining","max","windowEndsAt","isReplacement","last"],"additionalProperties":false},"BuyerRiskExplanation":{"type":"object","properties":{"subject":{"type":"object","properties":{"kind":{"type":"string","enum":["order","customer"]},"email":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"held":{"type":"boolean"},"holdReason":{"type":["string","null"]}},"required":["kind","email","orderId","orderNumber","held","holdReason"],"additionalProperties":false},"check":{"anyOf":[{"$ref":"#/components/schemas/FraudCheckDetail"},{"type":"null"}]},"history":{"type":"array","items":{"$ref":"#/components/schemas/FraudCheckRow"}},"thresholds":{"type":"object","properties":{"review":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"block":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["review","block"],"additionalProperties":false},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SignalSourceInfo"}},"candidates":{"type":"array","items":{"$ref":"#/components/schemas/AllowCandidate"}},"reviewId":{"anyOf":[{"$ref":"#/components/schemas/FraudReviewId"},{"type":"null"}]},"headline":{"type":"string"}},"required":["subject","check","history","thresholds","sources","candidates","reviewId","headline"],"additionalProperties":false},"BuyerSessionResult":{"type":"object","properties":{"token":{"type":"string"},"account":{"$ref":"#/components/schemas/BuyerAccount"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["token","account","expiresAt"],"additionalProperties":false},"BuyerSetPasswordResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/BuyerAccount"}},"required":["account"],"additionalProperties":false},"BuyerStartCardUpdateResponse":{"type":"object","properties":{"setupId":{"$ref":"#/components/schemas/PaymentSetupId"},"url":{"type":"string"}},"required":["setupId","url"],"additionalProperties":false},"BuyerSubscription":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SubscriptionId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"status":{"type":"string","enum":["active","cancelled"]},"currentPeriodEnd":{"$ref":"#/components/schemas/Timestamp"},"cancelAtPeriodEnd":{"type":"boolean"},"orderNumber":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"pastDue":{"default":false,"type":"boolean"},"renewUrl":{"default":null,"type":["string","null"]},"ended":{"default":false,"type":"boolean"}},"required":["id","productId","productName","status","currentPeriodEnd","cancelAtPeriodEnd","orderNumber","createdAt","pastDue","renewUrl","ended"],"additionalProperties":false},"BuyerSupportFormResponse":{"type":"object","properties":{"enabled":{"type":"boolean"},"storeName":{"type":"string"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/TicketCategory"}},"widget":{"$ref":"#/components/schemas/SupportWidget"},"attachmentMaxMb":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"buyer":{"anyOf":[{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}},"required":["email","name"],"additionalProperties":false},{"type":"null"}]},"orders":{"type":"array","items":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"number":{"type":"string"},"date":{"$ref":"#/components/schemas/Timestamp"},"items":{"type":"string"}},"required":["sessionId","number","date","items"],"additionalProperties":false}},"order":{"anyOf":[{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"number":{"type":"string"},"email":{"type":"string"}},"required":["sessionId","number","email"],"additionalProperties":false},{"type":"null"}]}},"required":["enabled","storeName","categories","widget","attachmentMaxMb","buyer","orders","order"],"additionalProperties":false},"BuyerTicket":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"category":{"type":["string","null"]},"orderNumber":{"type":["string","null"]},"orderSessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastMessageAt":{"$ref":"#/components/schemas/Timestamp"},"awaitingBuyer":{"type":"boolean"},"satisfaction":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"canRate":{"type":"boolean"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketMessageId"},"from":{"type":"string","enum":["buyer","store"]},"authorName":{"type":"string"},"body":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/TicketAttachment"}},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","from","authorName","body","attachments","createdAt"],"additionalProperties":false}}},"required":["id","number","subject","status","category","orderNumber","orderSessionId","createdAt","lastMessageAt","awaitingBuyer","satisfaction","canRate","messages"],"additionalProperties":false},"BuyerTicketRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"category":{"type":["string","null"]},"orderNumber":{"type":["string","null"]},"orderSessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastMessageAt":{"$ref":"#/components/schemas/Timestamp"},"awaitingBuyer":{"type":"boolean"},"satisfaction":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"canRate":{"type":"boolean"}},"required":["id","number","subject","status","category","orderNumber","orderSessionId","createdAt","lastMessageAt","awaitingBuyer","satisfaction","canRate"],"additionalProperties":false},"BuyerTicketsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/BuyerTicketRow"}}},"required":["items"],"additionalProperties":false},"BuyerUpdateProfileResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/BuyerAccount"}},"required":["account"],"additionalProperties":false},"BuyerUpdateSupportOffersResponse":{"type":"object","properties":{"offers":{"type":"array","items":{"$ref":"#/components/schemas/UpdateSupportOffer"}}},"required":["offers"],"additionalProperties":false},"BuyerWallet":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"storeCreditMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"giftCards":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"last4":{"type":"string","maxLength":8},"balanceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["last4","balanceMinor","expiresAt"],"additionalProperties":false}},"coupons":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"code":{"type":"string","maxLength":40},"title":{"type":"string","maxLength":80},"label":{"type":"string","maxLength":80},"endsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["code","title","label","endsAt"],"additionalProperties":false}}},"required":["currency","storeCreditMinor","giftCards","coupons"],"additionalProperties":false},"Campaign":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CampaignId"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/CampaignStatus"},"category":{"$ref":"#/components/schemas/EmailCategory"},"segmentId":{"anyOf":[{"$ref":"#/components/schemas/AudienceSegmentId"},{"type":"null"}]},"segmentName":{"type":["string","null"]},"doc":{"$ref":"#/components/schemas/EmailDocument"},"ab":{"$ref":"#/components/schemas/AbTest"},"window":{"$ref":"#/components/schemas/SendWindow"},"throttlePerMinute":{"type":"integer","minimum":10,"maximum":10000},"scheduledAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"startedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"winner":{"anyOf":[{"type":"string","enum":["a","b"]},{"type":"null"}]},"stats":{"$ref":"#/components/schemas/CampaignStats"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","status","category","segmentId","segmentName","doc","ab","window","throttlePerMinute","scheduledAt","startedAt","finishedAt","winner","stats","updatedAt","createdAt"],"additionalProperties":false},"CampaignAnalytics":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"utm":{"type":"array","items":{"type":"object","properties":{"campaign":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"},"visits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"conversionBps":{"$ref":"#/components/schemas/Bps"}},"required":["campaign","source","medium","visits","orders","revenueMinor","conversionBps"],"additionalProperties":false}},"utmDetails":{"type":"array","items":{"type":"object","properties":{"campaign":{"type":"string"},"term":{"type":"string"},"content":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["campaign","term","content","visitors","orders","revenueMinor"],"additionalProperties":false}},"promotions":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PromotionId"},"name":{"type":"string"},"state":{"$ref":"#/components/schemas/PromotionState"},"percentOffBps":{"$ref":"#/components/schemas/Bps"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"savingsMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["id","name","state","percentOffBps","orders","revenueMinor","savingsMinor"],"additionalProperties":false}},"affiliates":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AffiliateId"},"name":{"type":"string"},"code":{"type":"string"},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"commissionMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["id","name","code","clicks","orders","revenueMinor","commissionMinor"],"additionalProperties":false}},"totals":{"type":"object","properties":{"attributedOrders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"attributedRevenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"attributedShareBps":{"$ref":"#/components/schemas/Bps"}},"required":["attributedOrders","attributedRevenueMinor","attributedShareBps"],"additionalProperties":false}},"required":["range","from","to","period","currency","utm","utmDetails","promotions","affiliates","totals"],"additionalProperties":false},"CampaignId":{"type":"string","pattern":"^cmp_[0-9a-hjkmnp-tv-z]{20}$"},"CampaignRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CampaignId"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/CampaignStatus"},"category":{"$ref":"#/components/schemas/EmailCategory"},"segmentId":{"anyOf":[{"$ref":"#/components/schemas/AudienceSegmentId"},{"type":"null"}]},"segmentName":{"type":["string","null"]},"ab":{"$ref":"#/components/schemas/AbTest"},"window":{"$ref":"#/components/schemas/SendWindow"},"throttlePerMinute":{"type":"integer","minimum":10,"maximum":10000},"scheduledAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"startedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"winner":{"anyOf":[{"type":"string","enum":["a","b"]},{"type":"null"}]},"stats":{"$ref":"#/components/schemas/CampaignStats"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"subject":{"type":"string"}},"required":["id","name","status","category","segmentId","segmentName","ab","window","throttlePerMinute","scheduledAt","startedAt","finishedAt","winner","stats","updatedAt","createdAt","subject"],"additionalProperties":false},"CampaignStats":{"type":"object","properties":{"recipients":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"queued":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bounced":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"complained":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unsubscribed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"opens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"variants":{"type":"array","items":{"type":"object","properties":{"variant":{"type":"string","enum":["a","b"]},"subject":{"type":"string"},"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["variant","subject","sent","opened","clicked"],"additionalProperties":false}},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"people":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["url","clicks","people"],"additionalProperties":false}},"timeline":{"type":"array","items":{"type":"object","properties":{"hour":{"$ref":"#/components/schemas/Timestamp"},"opens":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["hour","opens","clicks"],"additionalProperties":false}}},"required":["recipients","queued","sent","failed","skipped","bounced","complained","unsubscribed","opened","clicked","opens","clicks","orders","revenueMinor","variants","links","timeline"],"additionalProperties":false},"CampaignStatus":{"type":"string","enum":["draft","scheduled","sending","testing","sent","paused","cancelled"]},"CancelBehavior":{"type":"string","enum":["end_of_period","immediately"]},"CannedReply":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CannedReplyId"},"name":{"type":"string"},"shortcut":{"type":"string"},"body":{"type":"string"},"category":{"type":["string","null"]},"uses":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","shortcut","body","category","uses","updatedAt"],"additionalProperties":false},"CannedReplyId":{"type":"string","pattern":"^crep_[0-9a-hjkmnp-tv-z]{20}$"},"CardCheckoutState":{"type":"string","enum":["open","processing","paid","expired"]},"CardCheckoutView":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"storeName":{"type":"string"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"state":{"$ref":"#/components/schemas/CardCheckoutState"},"orderPath":{"type":"string"},"otherWaysPath":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["name","quantity","totalMinor"],"additionalProperties":false}},"buyerEmail":{"type":"string"},"buyerEmailMasked":{"type":"string"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"payment":{"anyOf":[{"$ref":"#/components/schemas/CardPaymentClient"},{"type":"null"}]},"lastError":{"type":["string","null"]}},"required":["sessionId","storeName","totalMinor","currency","state","orderPath","otherWaysPath","lines","buyerEmail","buyerEmailMasked","expiresAt","payment","lastError"],"additionalProperties":false},"CardFinalizeResult":{"type":"object","properties":{"state":{"type":"string","enum":["paid","processing","failed","open","expired"]},"orderPath":{"type":"string"},"message":{"type":["string","null"]}},"required":["state","orderPath","message"],"additionalProperties":false},"CardPaymentClient":{"type":"object","properties":{"provider":{"type":"string","const":"stripe"},"publishableKey":{"type":"string","pattern":"^pk_(?:live|test)_[A-Za-z0-9]+$"},"clientSecret":{"type":"string","pattern":"^pi_[A-Za-z0-9]+_secret_[A-Za-z0-9]+$"},"accountId":{"anyOf":[{"type":"string","format":"starts_with","pattern":"^acct_.*"},{"type":"null"}]},"livemode":{"type":"boolean"}},"required":["provider","publishableKey","clientSecret","accountId","livemode"],"additionalProperties":false},"CardSetupView":{"type":"object","properties":{"setupId":{"$ref":"#/components/schemas/PaymentSetupId"},"storeName":{"type":"string"},"state":{"type":"string","enum":["open","completed","expired"]},"buyerEmail":{"type":"string"},"returnPath":{"type":"string"},"payment":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","const":"stripe"},"publishableKey":{"type":"string","pattern":"^pk_(?:live|test)_[A-Za-z0-9]+$"},"clientSecret":{"type":"string","pattern":"^seti_[A-Za-z0-9]+_secret_[A-Za-z0-9]+$"},"accountId":{"anyOf":[{"type":"string","format":"starts_with","pattern":"^acct_.*"},{"type":"null"}]},"livemode":{"type":"boolean"}},"required":["provider","publishableKey","clientSecret","accountId","livemode"],"additionalProperties":false},{"type":"null"}]}},"required":["setupId","storeName","state","buyerEmail","returnPath","payment"],"additionalProperties":false},"Cart":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CartId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/CartLine"}},"itemCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscount"}},"discountCode":{"type":["string","null"]},"giftCard":{"anyOf":[{"$ref":"#/components/schemas/AppliedGiftCard"},{"type":"null"}]},"totals":{"$ref":"#/components/schemas/CartTotals"},"note":{"type":"string"},"email":{"type":["string","null"]},"name":{"type":["string","null"]},"country":{"anyOf":[{"$ref":"#/components/schemas/CountryCode"},{"type":"null"}]},"bumps":{"type":"array","items":{"$ref":"#/components/schemas/CartBump"}},"upsells":{"type":"array","items":{"$ref":"#/components/schemas/CartUpsell"}},"progress":{"anyOf":[{"$ref":"#/components/schemas/CartProgress"},{"type":"null"}]},"messages":{"type":"array","items":{"$ref":"#/components/schemas/CartMessage"}},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"payment":{"default":{"disabledMethods":[],"adjustments":[]},"type":"object","properties":{"disabledMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"adjustments":{"type":"array","items":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/PaymentMethod"},"deltaMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["method","deltaMinor"],"additionalProperties":false}}},"required":["disabledMethods","adjustments"],"additionalProperties":false},"returnUrl":{"default":null,"type":["string","null"]},"cancelUrl":{"default":null,"type":["string","null"]}},"required":["id","currency","paymentModel","lines","itemCount","discounts","discountCode","giftCard","totals","note","email","name","country","bumps","upsells","progress","messages","updatedAt","payment","returnUrl","cancelUrl"],"additionalProperties":false},"CartBump":{"type":"object","properties":{"offeredBy":{"$ref":"#/components/schemas/ProductId"},"productId":{"$ref":"#/components/schemas/ProductId"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"handle":{"type":"string"},"title":{"type":"string"},"headline":{"type":"string"},"body":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"imageUrl":{"default":null,"type":["string","null"]},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"regularPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"lineId":{"anyOf":[{"$ref":"#/components/schemas/CartLineId"},{"type":"null"}]}},"required":["offeredBy","productId","variantId","handle","title","headline","body","type","imageUrl","priceMinor","regularPriceMinor","lineId"],"additionalProperties":false},"CartId":{"type":"string","pattern":"^crt_[0-9a-hjkmnp-tv-z]{20}$"},"CartLine":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CartLineId"},"productId":{"$ref":"#/components/schemas/ProductId"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"handle":{"type":"string"},"title":{"type":"string"},"variantTitle":{"type":["string","null"]},"options":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"type":{"$ref":"#/components/schemas/ProductType"},"imageUrl":{"default":null,"type":["string","null"]},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"minQuantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"maxQuantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"unitPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"lineMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"discountMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"gift":{"type":"boolean"},"addOnOf":{"anyOf":[{"$ref":"#/components/schemas/ProductId"},{"type":"null"}]},"available":{"type":"boolean"},"notice":{"type":["string","null"]},"discordRole":{"default":false,"type":"boolean"},"trialDays":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","productId","variantId","handle","title","variantTitle","options","type","imageUrl","quantity","minQuantity","maxQuantity","unitPriceMinor","compareAtMinor","lineMinor","discountMinor","gift","addOnOf","available","notice","discordRole","trialDays"],"additionalProperties":false},"CartLineId":{"type":"string","pattern":"^ln_[0-9a-hjkmnp-tv-z]{10}$"},"CartMessage":{"type":"object","properties":{"level":{"type":"string","enum":["info","warn","error"]},"field":{"type":"string","enum":["discount","gift_card","cart"]},"text":{"type":"string"}},"required":["level","field","text"],"additionalProperties":false},"CartProgress":{"type":"object","properties":{"thresholdMinor":{"$ref":"#/components/schemas/MinorUnits"},"remainingMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"reward":{"type":"string"},"reached":{"type":"boolean"},"ratio":{"type":"number","minimum":0,"maximum":1},"rewardProductIds":{"default":[],"type":"array","items":{"type":"string"}}},"required":["thresholdMinor","remainingMinor","reward","reached","ratio","rewardProductIds"],"additionalProperties":false},"CartSettings":{"type":"object","properties":{"mode":{"default":"drawer","type":"string","enum":["drawer","page"]},"side":{"default":"right","type":"string","enum":["right","left"]},"width":{"default":420,"type":"integer","minimum":340,"maximum":560},"showUpsells":{"default":true,"type":"boolean"},"upsellHeading":{"default":"Pairs well with","type":"string","maxLength":60},"showDiscountField":{"default":true,"type":"boolean"},"showGiftCardField":{"default":true,"type":"boolean"},"showNotes":{"default":false,"type":"boolean"},"notesLabel":{"default":"Note for the seller","type":"string","maxLength":60},"showTrustLine":{"default":true,"type":"boolean"},"trustLine":{"default":"Instant delivery to your inbox. Secure checkout.","type":"string","maxLength":120},"showProgress":{"default":true,"type":"boolean"},"progressMessage":{"default":"Add {remaining} more to get {reward}","type":"string","maxLength":120},"progressReachedMessage":{"default":"You unlocked {reward}","type":"string","maxLength":120},"labels":{"default":{"title":"Your cart","checkout":"Check out","viewCart":"View cart","continueShopping":"Keep shopping","emptyTitle":"Your cart is empty","emptyBody":"Browse the catalog and add something you like.","emptyCta":"Browse products"},"type":"object","properties":{"title":{"default":"Your cart","type":"string","maxLength":40},"checkout":{"default":"Check out","type":"string","maxLength":40},"viewCart":{"default":"View cart","type":"string","maxLength":40},"continueShopping":{"default":"Keep shopping","type":"string","maxLength":40},"emptyTitle":{"default":"Your cart is empty","type":"string","maxLength":60},"emptyBody":{"default":"Browse the catalog and add something you like.","type":"string","maxLength":160},"emptyCta":{"default":"Browse products","type":"string","maxLength":40}},"required":["title","checkout","viewCart","continueShopping","emptyTitle","emptyBody","emptyCta"],"additionalProperties":false},"colors":{"default":{"mode":"theme","background":"#0f0f17","surface":"#17171f","text":"#f2f2f7","muted":"#9a9aa8","accent":"#7c5cff","onAccent":"#ffffff"},"$ref":"#/components/schemas/SurfaceColors"}},"required":["mode","side","width","showUpsells","upsellHeading","showDiscountField","showGiftCardField","showNotes","notesLabel","showTrustLine","trustLine","showProgress","progressMessage","progressReachedMessage","labels","colors"],"additionalProperties":false},"CartTotals":{"type":"object","properties":{"subtotalMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountMinor":{"$ref":"#/components/schemas/MinorUnits"},"giftCardMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxRateBps":{"$ref":"#/components/schemas/Bps"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxKnown":{"type":"boolean"},"taxIncluded":{"default":false,"type":"boolean"}},"required":["subtotalMinor","discountMinor","giftCardMinor","netMinor","taxRateBps","taxMinor","totalMinor","taxKnown","taxIncluded"],"additionalProperties":false},"CartUpsell":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"handle":{"type":"string"},"title":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"imageUrl":{"default":null,"type":["string","null"]},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"headline":{"default":null,"type":["string","null"]},"offeredBy":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ProductId"},{"type":"null"}]},"variantId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"regularPriceMinor":{"default":null,"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["productId","handle","title","type","imageUrl","priceMinor","compareAtMinor","headline","offeredBy","variantId","regularPriceMinor"],"additionalProperties":false},"Category":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CategoryId"},"parentId":{"anyOf":[{"$ref":"#/components/schemas/CategoryId"},{"type":"null"}]},"handle":{"$ref":"#/components/schemas/CategoryHandle"},"title":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":2000},"imageUrl":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"published":{"type":"boolean"},"sort":{"$ref":"#/components/schemas/CategorySort"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"previousHandles":{"maxItems":20,"type":"array","items":{"type":"string"}},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","parentId","handle","title","description","imageUrl","published","sort","position","seoTitle","seoDescription","previousHandles","productCount","totalCount","updatedAt"],"additionalProperties":false},"CategoryDeleteResult":{"type":"object","properties":{"deleted":{"type":"integer","minimum":0,"maximum":9007199254740991},"lifted":{"type":"integer","minimum":0,"maximum":9007199254740991},"reassigned":{"type":"integer","minimum":0,"maximum":9007199254740991},"unassigned":{"type":"integer","minimum":0,"maximum":9007199254740991},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}},"required":["deleted","lifted","reassigned","unassigned","categories"],"additionalProperties":false},"CategoryHandle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"CategoryId":{"type":"string","pattern":"^pcat_[0-9a-hjkmnp-tv-z]{20}$"},"CategoryList":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}},"required":["categories"],"additionalProperties":false},"CategoryPrefs":{"type":"object","properties":{"newsletter":{"type":"boolean"},"promotions":{"type":"boolean"},"product_updates":{"type":"boolean"},"reminders":{"type":"boolean"}},"required":["newsletter","promotions","product_updates","reminders"],"additionalProperties":false},"CategoryProducts":{"type":"object","properties":{"productIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}}},"required":["productIds"],"additionalProperties":false},"CategoryProductsResult":{"type":"object","properties":{"added":{"type":"integer","minimum":0,"maximum":9007199254740991},"removed":{"type":"integer","minimum":0,"maximum":9007199254740991},"full":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}},"required":["added","removed","full","categories"],"additionalProperties":false},"CategorySort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"Channel":{"type":"string","enum":["direct","organic_search","paid_search","organic_social","paid_social","email","affiliate","referral","display","video","community","ai_assistant","sms","paid_other"]},"ChargebackShieldSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"riskScoreAtLeast":{"default":60,"type":"integer","minimum":1,"maximum":100},"onReview":{"default":true,"type":"boolean"},"newBuyerCardCapMinor":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"cryptoDiscountBps":{"default":0,"type":"integer","minimum":0,"maximum":3000},"autoEvidence":{"default":true,"type":"boolean"},"message":{"default":"For this order, pay with crypto or store credit.","type":"string","minLength":1,"maxLength":200}},"required":["enabled","riskScoreAtLeast","onReview","newBuyerCardCapMinor","cryptoDiscountBps","autoEvidence","message"],"additionalProperties":false},"ChatButtonsSettings":{"type":"object","properties":{"telegram":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":64,"pattern":"^@?[A-Za-z][A-Za-z0-9_]{4,31}$"}]},"whatsapp":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":20,"pattern":"^\\+?[1-9]\\d{6,14}$"}]},"whatsappText":{"default":"Hi! I have a question about your store.","type":"string","maxLength":140},"email":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":200,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}]},"label":{"default":"Message us","type":"string","minLength":1,"maxLength":30},"position":{"default":"bottom-right","type":"string","enum":["bottom-left","bottom-right"]}},"required":["telegram","whatsapp","whatsappText","email","label","position"],"additionalProperties":false},"CheckAlertResponse":{"type":"object","properties":{"fired":{"type":"boolean"},"value":{"type":"number"},"expected":{"type":"number"},"message":{"type":"string"}},"required":["fired","value","expected","message"],"additionalProperties":false},"CheckNewStoreHandleResponse":{"type":"object","properties":{"handle":{"type":"string"},"available":{"type":"boolean"},"reason":{"type":["string","null"]}},"required":["handle","available","reason"],"additionalProperties":false},"CheckPasswordResetResponse":{"type":"object","properties":{"email":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["email","expiresAt"],"additionalProperties":false},"CheckProductSlugResponse":{"type":"object","properties":{"slug":{"type":"string"},"available":{"type":"boolean"},"suggestion":{"type":"string"}},"required":["slug","available","suggestion"],"additionalProperties":false},"CheckSignupEmailResponse":{"type":"object","properties":{"available":{"type":"boolean"},"account":{"type":["string","null"]}},"required":["available","account"],"additionalProperties":false},"CheckStoreHandleResponse":{"type":"object","properties":{"handle":{"type":"string"},"available":{"type":"boolean"},"reason":{"type":["string","null"]}},"required":["handle","available","reason"],"additionalProperties":false},"CheckoutBoostConfig":{"type":"object","properties":{"open":{"$ref":"#/components/schemas/CheckoutOpenMode"},"tips":{"$ref":"#/components/schemas/TipSettings"},"failover":{"type":"object","properties":{"enabled":{"type":"boolean"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/PaymentFailureKind"}},"methods":{"type":"array","items":{"$ref":"#/components/schemas/MethodKey"}}},"required":["enabled","triggers","methods"],"additionalProperties":false},"degraded":{"type":"array","items":{"$ref":"#/components/schemas/GatewayProvider"}}},"required":["open","tips","failover","degraded"],"additionalProperties":false},"CheckoutBoostSettings":{"type":"object","properties":{"open":{"default":"page","$ref":"#/components/schemas/CheckoutOpenMode"},"tips":{"$ref":"#/components/schemas/TipSettings"},"failover":{"$ref":"#/components/schemas/FailoverSettings"}},"required":["open","tips","failover"],"additionalProperties":false},"CheckoutBoostStats":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"days":{"type":"integer","minimum":1,"maximum":9007199254740991},"attempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"failedByKind":{"type":"object","propertyNames":{"$ref":"#/components/schemas/PaymentFailureKind"},"additionalProperties":{"type":"integer","minimum":0,"maximum":9007199254740991},"required":["declined","provider_error","outage","risk_declined"]},"recoveredOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"recoveredMinor":{"$ref":"#/components/schemas/MinorUnits"},"recoveryRate":{"type":"number","minimum":0,"maximum":1},"voided":{"type":"integer","minimum":0,"maximum":9007199254740991},"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderHealth"}},"recent":{"type":"array","items":{"$ref":"#/components/schemas/PaymentAttemptRow"}},"tips":{"type":"object","properties":{"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"averageMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["orders","totalMinor","averageMinor"],"additionalProperties":false},"pwyw":{"type":"object","properties":{"supportOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"supportMinor":{"$ref":"#/components/schemas/MinorUnits"},"renewalOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"renewalMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["supportOrders","supportMinor","renewalOrders","renewalMinor"],"additionalProperties":false}},"required":["currency","days","attempts","failed","failedByKind","recoveredOrders","recoveredMinor","recoveryRate","voided","providers","recent","tips","pwyw"],"additionalProperties":false},"CheckoutConfig":{"type":"object","properties":{"cart":{"$ref":"#/components/schemas/CartSettings"},"checkout":{"$ref":"#/components/schemas/CheckoutSettings"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"methods":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutMethodOption"}},"testMode":{"type":"boolean"},"verifyProductIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"methodRules":{"default":{"order":[],"rules":{}},"$ref":"#/components/schemas/PaymentMethodRules"},"storeTestMode":{"default":false,"type":"boolean"},"boost":{"default":{"open":"page","tips":{"enabled":false,"presets":[5,10,20],"allowCustom":true,"heading":"Add a tip","note":"Tips go to the creator in full.","maxMinor":50000},"failover":{"enabled":true,"triggers":["declined","provider_error","outage","risk_declined"],"methods":[]},"degraded":[]},"$ref":"#/components/schemas/CheckoutBoostConfig"},"methodLimits":{"default":{"methods":{},"newBuyerCardMaxMinor":null,"currency":"USD"},"$ref":"#/components/schemas/EffectiveMethodLimits"},"seller":{"default":null,"anyOf":[{"$ref":"#/components/schemas/CheckoutSeller"},{"type":"null"}]}},"required":["cart","checkout","paymentModel","methods","testMode","verifyProductIds","updatedAt","methodRules","storeTestMode","boost","methodLimits","seller"],"additionalProperties":false},"CheckoutCounts":{"type":"object","properties":{"awaitingPayment":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"abandoned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"inProgress":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"toReview":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["awaitingPayment","abandoned","inProgress","toReview"],"additionalProperties":false},"CheckoutCustomField":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,31}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"$ref":"#/components/schemas/CustomFieldType"},"required":{"type":"boolean"},"placeholder":{"default":"","type":"string","maxLength":80},"help":{"default":"","type":"string","maxLength":160},"options":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}},"productIds":{"default":[],"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/ProductId"}}},"required":["id","label","type","required","placeholder","help","options","productIds"],"additionalProperties":false},"CheckoutField":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"$ref":"#/components/schemas/CheckoutFieldType"},"required":{"type":"boolean"},"placeholder":{"type":"string","maxLength":120},"helpText":{"type":"string","maxLength":200},"options":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":80}},"defaultValue":{"default":"","type":"string","maxLength":500}},"required":["id","label","type","required","placeholder","helpText","options","defaultValue"],"additionalProperties":false},"CheckoutFieldType":{"type":"string","enum":["text","textarea","email","number","select","checkbox","url","password","hidden","discord_id"]},"CheckoutMethodOption":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"method":{"$ref":"#/components/schemas/PaymentMethod"},"label":{"type":"string"},"manualMethodId":{"default":null,"type":["string","null"]},"description":{"default":"","type":"string"},"option":{"anyOf":[{"$ref":"#/components/schemas/PayOptionId"},{"type":"null"}]},"folded":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PayOptionId"}}},"required":["provider","method","label","manualMethodId","description"],"additionalProperties":false},"CheckoutOpenMode":{"type":"string","enum":["sheet","page"]},"CheckoutRow":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"state":{"$ref":"#/components/schemas/CheckoutState"},"buyerEmail":{"$ref":"#/components/schemas/Email"},"buyerName":{"type":"string"},"buyerCountry":{"$ref":"#/components/schemas/CountryCode"},"items":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["productId","name","type","quantity"],"additionalProperties":false}},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"null"}]},"manual":{"anyOf":[{"type":"object","properties":{"methodName":{"type":"string"},"reference":{"type":"string"}},"required":["methodName","reference"],"additionalProperties":false},{"type":"null"}]},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"submittedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"markable":{"default":false,"type":"boolean"},"orderId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"reference":{"default":null,"type":["string","null"]}},"required":["sessionId","state","buyerEmail","buyerName","buyerCountry","items","currency","totalMinor","provider","method","manual","customerId","createdAt","expiresAt","submittedAt","markable","orderId","reference"],"additionalProperties":false},"CheckoutSeller":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"registrationNumber":{"type":"string"},"vatNumber":{"type":"string"},"email":{"type":"string"}},"required":["name","address","registrationNumber","vatNumber","email"],"additionalProperties":false},"CheckoutSession":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CheckoutSessionId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"status":{"type":"string","enum":["open","paid","expired"]},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"buyerEmail":{"$ref":"#/components/schemas/Email"},"buyerCountry":{"$ref":"#/components/schemas/CountryCode"},"fees":{"$ref":"#/components/schemas/FeeBreakdown"},"payUrl":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","storeId","status","provider","paymentModel","items","buyerEmail","buyerCountry","fees","payUrl","orderId","expiresAt"],"additionalProperties":false},"CheckoutSessionId":{"type":"string","pattern":"^cs_[0-9a-hjkmnp-tv-z]{20}$"},"CheckoutSettings":{"type":"object","properties":{"layout":{"default":"two_column","type":"string","enum":["two_column","one_column"]},"logo":{"default":{"kind":"name","imageUrl":null},"type":"object","properties":{"kind":{"default":"name","type":"string","enum":["name","image"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500,"pattern":"^https:\\/\\/\\S+$"},{"type":"null"}]}},"required":["kind","imageUrl"],"additionalProperties":false},"colors":{"default":{"mode":"theme","background":"#0f0f17","surface":"#17171f","text":"#f2f2f7","muted":"#9a9aa8","accent":"#7c5cff","onAccent":"#ffffff"},"$ref":"#/components/schemas/SurfaceColors"},"fields":{"default":{"name":"required","country":"required","phone":"hidden","address":"hidden"},"type":"object","properties":{"name":{"default":"required","$ref":"#/components/schemas/FieldRequirement"},"country":{"default":"required","$ref":"#/components/schemas/FieldRequirement"},"phone":{"default":"hidden","$ref":"#/components/schemas/FieldRequirement"},"address":{"default":"hidden","$ref":"#/components/schemas/FieldRequirement"}},"required":["name","country","phone","address"],"additionalProperties":false},"customFields":{"default":[],"maxItems":12,"type":"array","items":{"$ref":"#/components/schemas/CheckoutCustomField"}},"showDiscountField":{"default":true,"type":"boolean"},"showGiftCardField":{"default":true,"type":"boolean"},"consent":{"default":{"enabled":true,"text":"I agree to the {link} and understand digital products are delivered instantly.","linkLabel":"Terms of Service","linkUrl":"/policies/terms-of-service"},"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"I agree to the {link} and understand digital products are delivered instantly.","type":"string","maxLength":200},"linkLabel":{"default":"Terms of Service","type":"string","maxLength":60},"linkUrl":{"default":"/policies/terms-of-service","$ref":"#/components/schemas/SellerLink"}},"required":["enabled","text","linkLabel","linkUrl"],"additionalProperties":false},"marketingOptIn":{"default":{"enabled":false,"label":"Email me about new releases and offers"},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"label":{"default":"Email me about new releases and offers","type":"string","maxLength":120}},"required":["enabled","label"],"additionalProperties":false},"trustBadges":{"default":["secure","instant","refund"],"maxItems":4,"type":"array","items":{"$ref":"#/components/schemas/TrustBadge"}},"showOrderBumps":{"default":true,"type":"boolean"},"emailVerification":{"default":"products","type":"string","enum":["never","products","always"]},"verifyProductIds":{"default":[],"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"offerAccounts":{"default":true,"type":"boolean"},"thankYou":{"default":{"heading":"Thanks for your order","message":"Your files and keys are below. We also sent them to your inbox.","redirectUrl":null,"redirectDelaySec":8},"type":"object","properties":{"heading":{"default":"Thanks for your order","type":"string","maxLength":60},"message":{"default":"Your files and keys are below. We also sent them to your inbox.","type":"string","maxLength":400},"redirectUrl":{"default":null,"anyOf":[{"$ref":"#/components/schemas/SellerLink"},{"type":"null"}]},"redirectDelaySec":{"default":8,"type":"integer","minimum":3,"maximum":60}},"required":["heading","message","redirectUrl","redirectDelaySec"],"additionalProperties":false},"strings":{"default":{"contactHeading":"Contact","detailsHeading":"Your details","paymentHeading":"Payment","summaryHeading":"Order summary","payButton":"Pay {amount}","freeButton":"Get it free","emailHelp":"Your receipt, keys and download links go here.","discountPlaceholder":"Discount code","giftCardPlaceholder":"Gift card code","apply":"Apply","secureNote":"Payments are encrypted and processed securely."},"$ref":"#/components/schemas/CheckoutStrings"},"minOrderMinor":{"default":null,"anyOf":[{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"maxOrderMinor":{"default":null,"anyOf":[{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"cartMode":{"default":"separate","type":"string","enum":["separate","one_page"]},"methodDiscounts":{"default":[],"maxItems":12,"type":"array","items":{"$ref":"#/components/schemas/MethodDiscount"}}},"required":["layout","logo","colors","fields","customFields","showDiscountField","showGiftCardField","consent","marketingOptIn","trustBadges","showOrderBumps","emailVerification","verifyProductIds","offerAccounts","thankYou","strings","minOrderMinor","maxOrderMinor","cartMode","methodDiscounts"],"additionalProperties":false},"CheckoutState":{"type":"string","enum":["awaiting_payment","abandoned","in_progress"]},"CheckoutStrings":{"type":"object","properties":{"contactHeading":{"default":"Contact","type":"string","maxLength":40},"detailsHeading":{"default":"Your details","type":"string","maxLength":40},"paymentHeading":{"default":"Payment","type":"string","maxLength":40},"summaryHeading":{"default":"Order summary","type":"string","maxLength":40},"payButton":{"default":"Pay {amount}","type":"string","maxLength":40},"freeButton":{"default":"Get it free","type":"string","maxLength":40},"emailHelp":{"default":"Your receipt, keys and download links go here.","type":"string","maxLength":120},"discountPlaceholder":{"default":"Discount code","type":"string","maxLength":40},"giftCardPlaceholder":{"default":"Gift card code","type":"string","maxLength":40},"apply":{"default":"Apply","type":"string","maxLength":20},"secureNote":{"default":"Payments are encrypted and processed securely.","type":"string","maxLength":120}},"required":["contactHeading","detailsHeading","paymentHeading","summaryHeading","payButton","freeButton","emailHelp","discountPlaceholder","giftCardPlaceholder","apply","secureNote"],"additionalProperties":false},"ChooseRefundOfferResponse":{"type":"object","properties":{"offer":{"anyOf":[{"$ref":"#/components/schemas/BuyerRefundOffer"},{"type":"null"}]}},"required":["offer"],"additionalProperties":false},"ClaimReason":{"type":"string","enum":["not_received","not_working","not_as_described","wrong_item","other"]},"ClaimResolution":{"type":"string","enum":["refunded","replaced","rejected","withdrawn"]},"ClarityId":{"type":"string","pattern":"^[a-z0-9]{8,12}$"},"ClientErrorAccepted":{"type":"object","properties":{"accepted":{"type":"integer","minimum":0,"maximum":9007199254740991},"dropped":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["accepted","dropped"],"additionalProperties":false},"ClockTime":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$"},"CodeBatchId":{"type":"string","pattern":"^dcb_[0-9a-hjkmnp-tv-z]{20}$"},"CohortGranularity":{"type":"string","enum":["week","month"]},"CohortMetric":{"type":"string","enum":["customers","orders","revenue"]},"CohortReport":{"type":"object","properties":{"granularity":{"$ref":"#/components/schemas/CohortGranularity"},"metric":{"$ref":"#/components/schemas/CohortMetric"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"timezone":{"type":"string"},"cohorts":{"type":"array","items":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/IsoDate"},"size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"values":{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}},"required":["start","size","values"],"additionalProperties":false}},"ltv":{"type":"array","items":{"type":"object","properties":{"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avgRevenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["offset","avgRevenueMinor","customers"],"additionalProperties":false}},"byChannel":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ltvMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ordersPerCustomer":{"type":"number"},"repeatRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["key","customers","ltvMinor","ordersPerCustomer","repeatRateBps"],"additionalProperties":false}},"byProduct":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"productId":{"anyOf":[{"$ref":"#/components/schemas/ProductId"},{"type":"null"}]},"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ltvMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ordersPerCustomer":{"type":"number"},"repeatRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["key","productId","customers","ltvMinor","ordersPerCustomer","repeatRateBps"],"additionalProperties":false}},"totals":{"type":"object","properties":{"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"repeatRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ltvMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"medianDaysToSecondOrder":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["customers","repeatRateBps","ltvMinor","medianDaysToSecondOrder"],"additionalProperties":false}},"required":["granularity","metric","currency","timezone","cohorts","ltv","byChannel","byProduct","totals"],"additionalProperties":false},"CollectResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true},"ref":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"cookieDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["code","cookieDays"],"additionalProperties":false},{"type":"null"}]}},"required":["ok","ref"],"additionalProperties":false},"CollectionId":{"type":"string","pattern":"^col_[0-9a-hjkmnp-tv-z]{20}$"},"CollectionRule":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/CollectionRuleField"},"op":{"$ref":"#/components/schemas/CollectionRuleOp"},"value":{"type":"string","minLength":1,"maxLength":80}},"required":["field","op","value"],"additionalProperties":false},"CollectionRuleField":{"type":"string","enum":["type","tag","price","name","pricing_mode","created_days","category"]},"CollectionRuleOp":{"type":"string","enum":["equals","not_equals","contains","greater_than","less_than"]},"CollectionSlice":{"type":"object","properties":{"handle":{"type":"string"},"source":{"default":"collection","$ref":"#/components/schemas/SliceSource"},"sort":{"$ref":"#/components/schemas/StorefrontSort"},"offset":{"type":"integer","minimum":0,"maximum":9007199254740991},"after":{"type":["string","null"]},"limit":{"type":"integer","minimum":1,"maximum":9007199254740991},"start":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"handles":{"type":"array","items":{"type":"string"}},"nextCursor":{"type":["string","null"]}},"required":["handle","source","sort","offset","after","limit","start","total","handles","nextCursor"],"additionalProperties":false},"CollectionSort":{"type":"string","enum":["manual","best_selling","newest","price_asc","price_desc","title"]},"ColumnsBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"columns"},"columns":{"minItems":2,"maxItems":3,"type":"array","items":{"type":"object","properties":{"blocks":{"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/LeafBlock"}}},"required":["blocks"],"additionalProperties":false}},"widths":{"default":[],"maxItems":3,"type":"array","items":{"type":"integer","minimum":10,"maximum":90}},"stackOnMobile":{"default":true,"type":"boolean"},"gap":{"default":16,"type":"integer","minimum":0,"maximum":40}},"required":["id","type","columns","widths","stackOnMobile","gap"],"additionalProperties":false},"CommandCenter":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/AnalyticsRange"},"generatedAt":{"$ref":"#/components/schemas/Timestamp"},"stores":{"type":"array","items":{"$ref":"#/components/schemas/CommandCenterStore"}},"totals":{"type":"array","items":{"$ref":"#/components/schemas/CommandCenterCurrencyTotal"}},"ordersTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visitorsTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"array","items":{"$ref":"#/components/schemas/CommandCenterOrder"}},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/CommandCenterTicket"}},"disputes":{"type":"array","items":{"$ref":"#/components/schemas/CommandCenterDispute"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/CommandCenterAlert"}}},"required":["range","generatedAt","stores","totals","ordersTotal","visitorsTotal","orders","tickets","disputes","alerts"],"additionalProperties":false},"CommandCenterAccess":{"type":"object","properties":{"sales":{"type":"boolean"},"orders":{"type":"boolean"},"support":{"type":"boolean"},"disputes":{"type":"boolean"},"catalog":{"type":"boolean"}},"required":["sales","orders","support","disputes","catalog"],"additionalProperties":false},"CommandCenterAlert":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"kind":{"$ref":"#/components/schemas/CommandCenterAlertKind"},"tone":{"type":"string","enum":["warn","bad"]},"title":{"type":"string"},"detail":{"type":"string"},"href":{"type":"string"},"at":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["storeId","storeName","kind","tone","title","detail","href","at"],"additionalProperties":false},"CommandCenterAlertKind":{"type":"string","enum":["out_of_stock","low_stock","product_status","sales_paused","held_order","dispute_due","store_status"]},"CommandCenterCurrencyTotal":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"previousRevenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousOrders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"series":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["date","revenueMinor"],"additionalProperties":false}}},"required":["currency","revenueMinor","previousRevenueMinor","orders","previousOrders","stores","series"],"additionalProperties":false},"CommandCenterDispute":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"id":{"$ref":"#/components/schemas/DisputeId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"kind":{"$ref":"#/components/schemas/DisputeKind"},"status":{"$ref":"#/components/schemas/DisputeStatus"},"reason":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"dueAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"openedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["storeId","storeName","id","orderId","kind","status","reason","amountMinor","currency","dueAt","openedAt"],"additionalProperties":false},"CommandCenterOrder":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"held":{"type":"boolean"},"buyerEmail":{"type":"string"},"items":{"type":"string"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"isTest":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["storeId","storeName","id","number","status","held","buyerEmail","items","totalMinor","currency","isTest","createdAt"],"additionalProperties":false},"CommandCenterStore":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"$ref":"#/components/schemas/StoreHandle"},"domain":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"roleName":{"type":"string"},"planName":{"type":"string"},"status":{"type":"string"},"locked":{"type":["string","null"]},"access":{"$ref":"#/components/schemas/CommandCenterAccess"},"kpis":{"anyOf":[{"type":"object","properties":{"revenueMinor":{"$ref":"#/components/schemas/Kpi"},"orders":{"$ref":"#/components/schemas/Kpi"},"visitors":{"$ref":"#/components/schemas/Kpi"},"conversionBps":{"$ref":"#/components/schemas/Kpi"}},"required":["revenueMinor","orders","visitors","conversionBps"],"additionalProperties":false},{"type":"null"}]},"series":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","revenueMinor","orders"],"additionalProperties":false}},"counts":{"type":"object","properties":{"toFulfill":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"openTickets":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"openDisputes":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"lowStock":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"outOfStock":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["toFulfill","openTickets","openDisputes","lowStock","outOfStock"],"additionalProperties":false}},"required":["id","name","handle","domain","currency","roleName","planName","status","locked","access","kpis","series","counts"],"additionalProperties":false},"CommandCenterTicket":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"id":{"$ref":"#/components/schemas/TicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"priority":{"$ref":"#/components/schemas/TicketPriority"},"requester":{"type":"string"},"waiting":{"type":"boolean"},"overdue":{"type":"boolean"},"lastMessageAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["storeId","storeName","id","number","subject","status","priority","requester","waiting","overdue","lastMessageAt"],"additionalProperties":false},"CommissionId":{"type":"string","pattern":"^com_[0-9a-hjkmnp-tv-z]{20}$"},"CommissionStatus":{"type":"string","enum":["pending","approved","paid","void"]},"CommunityAccessSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"chatId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/TelegramChatRef"},{"type":"null"}]},"chatTitle":{"default":"","type":"string","maxLength":128},"chatType":{"default":null,"anyOf":[{"type":"string","enum":["group","supergroup","channel"]},{"type":"null"}]},"duration":{"default":"auto","$ref":"#/components/schemas/CommunityDuration"},"fixedDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"removeOnRefund":{"default":true,"type":"boolean"},"removeOnChargeback":{"default":true,"type":"boolean"},"removeOnExpiry":{"default":true,"type":"boolean"},"inviteHours":{"default":24,"type":"integer","minimum":1,"maximum":168}},"required":["enabled","chatId","chatTitle","chatType","duration","fixedDays","removeOnRefund","removeOnChargeback","removeOnExpiry","inviteHours"],"additionalProperties":false},"CommunityAutomations":{"type":"object","properties":{"announcements":{"default":true,"type":"boolean"},"incidents":{"default":true,"type":"boolean"},"sellerRoles":{"default":true,"type":"boolean"},"planRoles":{"default":true,"type":"boolean"},"slaAlerts":{"default":true,"type":"boolean"},"driftCheck":{"default":true,"type":"boolean"},"alertsDigest":{"default":true,"type":"boolean"},"ticketLog":{"default":true,"type":"boolean"}},"required":["announcements","incidents","sellerRoles","planRoles","slaAlerts","driftCheck","alertsDigest","ticketLog"],"additionalProperties":false},"CommunityBackup":{"type":"object","properties":{"verified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sellers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"working":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"dead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"left":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastCheckedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"minAccountAgeDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"retentionDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"consentVersion":{"type":"string"},"restore":{"anyOf":[{"$ref":"#/components/schemas/CommunityRestore"},{"type":"null"}]}},"required":["verified","sellers","working","dead","left","lastCheckedAt","minAccountAgeDays","retentionDays","consentVersion","restore"],"additionalProperties":false},"CommunityBanner":{"type":"string","enum":["none","launch","update","changelog","maintenance","incident","resolved","tips","welcome","rules","tickets"]},"CommunityChannelKey":{"type":"string","enum":["welcome","rules","announcements","status","changelog","general","openTicket","ticketLog","modLog","alerts"]},"CommunityDuration":{"type":"string","enum":["auto","fixed","lifetime"]},"CommunityGrant":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommunityGrantId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"buyerEmail":{"type":"string"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"variantName":{"type":["string","null"]},"chatTitle":{"type":"string"},"status":{"$ref":"#/components/schemas/CommunityGrantStatus"},"telegramUser":{"type":["string","null"]},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"removedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"removeReason":{"anyOf":[{"$ref":"#/components/schemas/CommunityRemoveReason"},{"type":"null"}]},"detail":{"type":"string"},"simulated":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","orderId","orderNumber","customerId","buyerEmail","productId","productName","variantName","chatTitle","status","telegramUser","expiresAt","removedAt","removeReason","detail","simulated","createdAt"],"additionalProperties":false},"CommunityGrantId":{"type":"string","pattern":"^cgr_[0-9a-hjkmnp-tv-z]{20}$"},"CommunityGrantState":{"type":"string","enum":["working","dead"]},"CommunityGrantStatus":{"type":"string","enum":["waiting","inviting","invited","removed","failed"]},"CommunityIncident":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommunityIncidentId"},"title":{"type":"string"},"impact":{"$ref":"#/components/schemas/IncidentImpact"},"status":{"$ref":"#/components/schemas/IncidentStatus"},"components":{"type":"array","items":{"type":"string"}},"updates":{"type":"array","items":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IncidentStatus"},"body":{"type":"string"},"by":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["status","body","by","at"],"additionalProperties":false}},"messageUrl":{"type":["string","null"]},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"resolvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","title","impact","status","components","updates","messageUrl","startedAt","resolvedAt"],"additionalProperties":false},"CommunityIncidentId":{"type":"string","pattern":"^cinc_[0-9a-hjkmnp-tv-z]{20}$"},"CommunityModEvent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommunityModEventId"},"action":{"$ref":"#/components/schemas/ModAction"},"discordUserId":{"$ref":"#/components/schemas/DiscordObjectId"},"username":{"type":"string"},"channelName":{"type":["string","null"]},"rule":{"type":["string","null"]},"content":{"type":["string","null"]},"reason":{"type":["string","null"]},"actor":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","action","discordUserId","username","channelName","rule","content","reason","actor","createdAt"],"additionalProperties":false},"CommunityModEventId":{"type":"string","pattern":"^cmod_[0-9a-hjkmnp-tv-z]{20}$"},"CommunityOverview":{"type":"object","properties":{"mode":{"type":"string","enum":["live","simulated"]},"bot":{"type":"object","properties":{"connected":{"type":"boolean"},"username":{"type":["string","null"]}},"required":["connected","username"],"additionalProperties":false},"products":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"chatTitle":{"type":"string"},"enabled":{"type":"boolean"},"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["productId","name","chatTitle","enabled","active"],"additionalProperties":false}},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"waiting":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"removed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","active","waiting","removed","failed"],"additionalProperties":false},"items":{"type":"array","items":{"$ref":"#/components/schemas/CommunityGrant"}}},"required":["mode","bot","products","counts","items"],"additionalProperties":false},"CommunityPlan":{"type":"object","properties":{"checkedAt":{"$ref":"#/components/schemas/Timestamp"},"matches":{"type":"boolean"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/CommunityPlanStep"}},"leftAlone":{"type":"array","items":{"type":"string"}},"needsYou":{"type":"array","items":{"type":"string"}}},"required":["checkedAt","matches","steps","leftAlone","needsYou"],"additionalProperties":false},"CommunityPlanStep":{"type":"object","properties":{"group":{"type":"string","enum":["branding","roles","channels","server","automod","onboarding","welcome","posts","panel","emoji"]},"label":{"type":"string"},"detail":{"type":"string"}},"required":["group","label","detail"],"additionalProperties":false},"CommunityPost":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommunityPostId"},"source":{"type":"string","enum":["composer","announcement","incident","digest","drift","sla","seed"]},"channel":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"},"banner":{"$ref":"#/components/schemas/CommunityBanner"},"status":{"type":"string","enum":["scheduled","posted","failed","withdrawn"]},"scheduledFor":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"postedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"url":{"type":["string","null"]},"crossposted":{"type":"boolean"},"error":{"type":["string","null"]},"createdBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","source","channel","title","body","banner","status","scheduledFor","postedAt","url","crossposted","error","createdBy","createdAt"],"additionalProperties":false},"CommunityPostId":{"type":"string","pattern":"^cpst_[0-9a-hjkmnp-tv-z]{20}$"},"CommunityPostPage":{"type":"object","properties":{"posts":{"type":"array","items":{"$ref":"#/components/schemas/CommunityPost"}},"nextCursor":{"type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"counts":{"type":"object","propertyNames":{"$ref":"#/components/schemas/CommunityPostStatusFilter"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"required":["all","scheduled","posted","failed","withdrawn"]}},"required":["posts","nextCursor","total","counts"],"additionalProperties":false},"CommunityPostStatusFilter":{"type":"string","enum":["all","scheduled","posted","failed","withdrawn"]},"CommunityProductView":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/CommunityAccessSettings"},"bot":{"type":"object","properties":{"connected":{"type":"boolean"},"username":{"type":["string","null"]}},"required":["connected","username"],"additionalProperties":false},"mode":{"type":"string","enum":["live","simulated"]},"grants":{"type":"object","properties":{"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"waiting":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"removed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["active","waiting","removed"],"additionalProperties":false}},"required":["settings","bot","mode","grants"],"additionalProperties":false},"CommunityRemoveReason":{"type":"string","enum":["expired","refund","chargeback","seller","subscription_ended"]},"CommunityRestore":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommunityRestoreId"},"status":{"$ref":"#/components/schemas/CommunityRestoreStatus"},"guildId":{"$ref":"#/components/schemas/DiscordObjectId"},"guildName":{"type":"string"},"switchServer":{"type":"boolean"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"already":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refused":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"detail":{"type":"string"},"error":{"type":["string","null"]},"resumeAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"startedBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","status","guildId","guildName","switchServer","total","processed","added","already","expired","refused","skipped","detail","error","resumeAt","startedBy","createdAt","finishedAt"],"additionalProperties":false},"CommunityRestoreId":{"type":"string","pattern":"^crst_[0-9a-hjkmnp-tv-z]{20}$"},"CommunityRestoreStatus":{"type":"string","enum":["waiting","running","done","failed","cancelled"]},"CommunityRestoreTarget":{"type":"object","properties":{"guildId":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"memberCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"botReady":{"type":"boolean"},"missing":{"type":"array","items":{"type":"string"}},"addBotUrl":{"type":"string"},"memberRole":{"type":"boolean"},"current":{"type":"boolean"},"movable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["guildId","name","memberCount","botReady","missing","addBotUrl","memberRole","current","movable"],"additionalProperties":false},"CommunityRoleKey":{"type":"string","enum":["founder","admin","staff","support","moderator","partner","developer","seller","verifiedSeller","member"]},"CommunityRun":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommunityRunId"},"kind":{"$ref":"#/components/schemas/CommunityRunKind"},"status":{"$ref":"#/components/schemas/CommunityRunStatus"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"done":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lines":{"type":"array","items":{"type":"string"}},"error":{"type":["string","null"]},"startedBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","kind","status","total","done","lines","error","startedBy","createdAt","finishedAt"],"additionalProperties":false},"CommunityRunId":{"type":"string","pattern":"^crun_[0-9a-hjkmnp-tv-z]{20}$"},"CommunityRunKind":{"type":"string","enum":["setup","drift","roles","panel","branding","cleanup"]},"CommunityRunStatus":{"type":"string","enum":["queued","running","done","failed"]},"CommunityServerOverview":{"type":"object","properties":{"simulated":{"type":"boolean"},"connected":{"type":"boolean"},"guild":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"iconUrl":{"type":["string","null"]},"memberCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"onlineCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"boostTier":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"boosts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"connectedAt":{"$ref":"#/components/schemas/Timestamp"},"connectedBy":{"type":"string"}},"required":["id","name","iconUrl","memberCount","onlineCount","boostTier","boosts","connectedAt","connectedBy"],"additionalProperties":false},{"type":"null"}]},"bot":{"type":"object","properties":{"isAdmin":{"type":["boolean","null"]},"readsMessages":{"$ref":"#/components/schemas/DiscordReadsMessages"},"gateway":{"$ref":"#/components/schemas/GatewayState"},"gatewaySeenAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["isAdmin","readsMessages","gateway","gatewaySeenAt"],"additionalProperties":false},"setup":{"type":"object","properties":{"lastCheckedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"matches":{"type":["boolean","null"]},"pendingSteps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"needsYou":{"type":"array","items":{"type":"string"}},"lastAppliedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["lastCheckedAt","matches","pendingSteps","needsYou","lastAppliedAt"],"additionalProperties":false},"panel":{"anyOf":[{"type":"object","properties":{"channelId":{"$ref":"#/components/schemas/DiscordObjectId"},"messageId":{"$ref":"#/components/schemas/DiscordObjectId"},"postedAt":{"$ref":"#/components/schemas/Timestamp"},"outdated":{"type":"boolean"}},"required":["channelId","messageId","postedAt","outdated"],"additionalProperties":false},{"type":"null"}]},"settings":{"$ref":"#/components/schemas/CommunitySettings"},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"category":{"type":["string","null"]},"kind":{"type":"string","enum":["text","announcement","forum","voice","stage"]}},"required":["id","name","category","kind"],"additionalProperties":false}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"color":{"type":["string","null"]},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"members":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","name","color","position","members"],"additionalProperties":false}},"counts":{"type":"object","properties":{"openTickets":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"linkedSellers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"modEvents7d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"postsScheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"openIncidents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["openTickets","linkedSellers","modEvents7d","postsScheduled","openIncidents"],"additionalProperties":false},"runs":{"type":"array","items":{"$ref":"#/components/schemas/CommunityRun"}},"inviteUrl":{"type":["string","null"]},"me":{"anyOf":[{"type":"object","properties":{"discordUserId":{"$ref":"#/components/schemas/DiscordObjectId"},"username":{"type":"string"}},"required":["discordUserId","username"],"additionalProperties":false},{"type":"null"}]},"team":{"type":"array","items":{"type":"object","properties":{"adminId":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"},"role":{"type":"string"},"discordUsername":{"type":["string","null"]}},"required":["adminId","name","role","discordUsername"],"additionalProperties":false}}},"required":["simulated","connected","guild","bot","setup","panel","settings","channels","roles","counts","runs","inviteUrl","me","team"],"additionalProperties":false},"CommunitySettings":{"type":"object","properties":{"automations":{"default":{"announcements":true,"incidents":true,"sellerRoles":true,"planRoles":true,"slaAlerts":true,"driftCheck":true,"alertsDigest":true,"ticketLog":true},"$ref":"#/components/schemas/CommunityAutomations"},"verification":{"default":{"minAccountAgeDays":7},"$ref":"#/components/schemas/CommunityVerificationSettings"},"channels":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/CommunityChannelKey"},"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]}},"roles":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/CommunityRoleKey"},"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]}},"planRoles":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/PlanId"},"additionalProperties":{"$ref":"#/components/schemas/DiscordObjectId"}},"ticketStaffRoleIds":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DiscordObjectId"}}},"required":["automations","verification","channels","roles","planRoles","ticketStaffRoleIds"],"additionalProperties":false},"CommunityVerificationSettings":{"type":"object","properties":{"minAccountAgeDays":{"default":7,"type":"integer","minimum":0,"maximum":365}},"required":["minAccountAgeDays"],"additionalProperties":false},"ComponentState":{"type":"string","enum":["operational","maintenance","degraded","partial","major"]},"ConditionGroup":{"type":"object","properties":{"op":{"$ref":"#/components/schemas/GroupOp"},"conditions":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/RuleCondition"}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ConditionSubgroup"}}},"required":["op","conditions","groups"],"additionalProperties":false},"ConditionOperator":{"type":"string","enum":["eq","neq","gt","gte","lt","lte","between","in","not_in","contains","starts_with","ends_with","in_cidr","not_in_cidr","is_true","is_false","contains_any","contains_none","is_known","is_unknown"]},"ConditionSubgroup":{"type":"object","properties":{"op":{"$ref":"#/components/schemas/GroupOp"},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/RuleCondition"}}},"required":["op","conditions"],"additionalProperties":false},"ConditionTrace":{"type":"object","properties":{"signal":{"$ref":"#/components/schemas/SignalKey"},"op":{"$ref":"#/components/schemas/ConditionOperator"},"actual":{"$ref":"#/components/schemas/SignalValue"},"matched":{"type":"boolean"},"value":{"default":null,"$ref":"#/components/schemas/ConditionValue"},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op","actual","matched","value","value2"],"additionalProperties":false},"ConditionValue":{"anyOf":[{"type":"number"},{"type":"string","maxLength":200},{"maxItems":500,"type":"array","items":{"type":"string","maxLength":200}},{"type":"null"}]},"ConfirmDiscordVerifyResponse":{"type":"object","properties":{"ticket":{"type":"string"},"expiresAt":{"type":"string"}},"required":["ticket","expiresAt"],"additionalProperties":false},"ConfirmSubscriptionResponse":{"type":"object","properties":{"storeName":{"type":"string"},"storeUrl":{"type":"string"},"email":{"type":"string"}},"required":["storeName","storeUrl","email"],"additionalProperties":false},"ConnectCommunityResponse":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":false},"ConnectGatewayResponse":{"type":"object","properties":{"connection":{"$ref":"#/components/schemas/GatewayConnection"},"paymentModel":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PaymentModel"},{"type":"null"}]},"switchedToOwn":{"default":false,"type":"boolean"},"onboardingUrl":{"type":["string","null"]}},"required":["connection","paymentModel","switchedToOwn","onboardingUrl"],"additionalProperties":false},"ConsentCategory":{"type":"string","enum":["none","functional","analytics","marketing"]},"ConsentMode":{"type":"string","enum":["cookieless","consent","first_party","off"]},"ConsentState":{"type":"string","enum":["cookieless","granted","denied"]},"ConsentStatus":{"type":"string","enum":["subscribed","pending","unsubscribed","not_subscribed","bounced","complained"]},"Contact":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContactId"},"email":{"type":"string"},"name":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/ConsentStatus"},"source":{"$ref":"#/components/schemas/ContactSource"},"categories":{"$ref":"#/components/schemas/CategoryPrefs"},"tags":{"type":"array","items":{"type":"string"}},"consentAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"unsubscribedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"ordersCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spentMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastOrderAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastOpenAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastClickAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"suppressed":{"anyOf":[{"$ref":"#/components/schemas/SuppressionReason"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","name","customerId","status","source","categories","tags","consentAt","unsubscribedAt","ordersCount","spentMinor","lastOrderAt","lastOpenAt","lastClickAt","suppressed","createdAt"],"additionalProperties":false},"ContactId":{"type":"string","pattern":"^mc_[0-9a-hjkmnp-tv-z]{20}$"},"ContactSource":{"type":"string","enum":["checkout","account","newsletter","import","manual","customer"]},"ContentProtectionSettings":{"type":"object","properties":{"blockRightClick":{"default":true,"type":"boolean"},"blockTextSelection":{"default":false,"type":"boolean"},"blockImageDrag":{"default":true,"type":"boolean"},"blockCopy":{"default":false,"type":"boolean"}},"required":["blockRightClick","blockTextSelection","blockImageDrag","blockCopy"],"additionalProperties":false},"CookieConsentSettings":{"type":"object","properties":{"message":{"default":"We use cookies to run the store, understand traffic and show relevant ads. You choose which ones.","type":"string","minLength":1,"maxLength":240},"policyLink":{"default":"/policies/privacy-policy","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":300}]},"position":{"default":"bottom-left","type":"string","enum":["bottom-left","bottom-bar"]},"showDecline":{"default":true,"type":"boolean"},"granular":{"default":true,"type":"boolean"}},"required":["message","policyLink","position","showDecline","granular"],"additionalProperties":false},"CookielessAnalyticsSettings":{"type":"object","properties":{"provider":{"default":"plausible","type":"string","enum":["plausible","fathom","umami"]},"plausibleDomain":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":120,"pattern":"^(?=.{3,120}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"}]},"fathomSiteId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^[A-Z]{5,12}$"}]},"umamiWebsiteId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]}},"required":["provider","plausibleDomain","fathomSiteId","umamiWebsiteId"],"additionalProperties":false},"CountdownBannerSettings":{"type":"object","properties":{"message":{"default":"Sale ends soon","type":"string","minLength":1,"maxLength":140},"mode":{"default":"fixed","type":"string","enum":["fixed","evergreen"]},"endsAt":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"evergreenMinutes":{"default":60,"type":"integer","minimum":5,"maximum":10080},"linkLabel":{"default":"Shop now","type":"string","maxLength":30},"link":{"default":"/collections/all","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":300}]},"tone":{"default":"accent","type":"string","enum":["accent","dark","warn"]},"position":{"default":"top","type":"string","enum":["top","bottom"]},"dismissible":{"default":true,"type":"boolean"}},"required":["message","mode","endsAt","evergreenMinutes","linkLabel","link","tone","position","dismissible"],"additionalProperties":false},"CountryCode":{"type":"string","pattern":"^[A-Z]{2}$"},"CountryRule":{"type":"object","properties":{"mode":{"type":"string","enum":["all","only","except"]},"list":{"maxItems":250,"type":"array","items":{"$ref":"#/components/schemas/CountryCode"}}},"required":["mode","list"],"additionalProperties":false},"CouponEvent":{"type":"string","enum":["entered","rejected","redeemed","held"]},"CouponReport":{"type":"object","properties":{"discount":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscountId"},"kind":{"$ref":"#/components/schemas/DiscountKind"},"code":{"type":["string","null"]},"title":{"type":"string"},"status":{"$ref":"#/components/schemas/DiscountStatus"},"bulkCodes":{"type":"boolean"}},"required":["id","kind","code","title","status","bulkCodes"],"additionalProperties":false},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"days":{"type":"integer","minimum":1,"maximum":9007199254740991},"kpis":{"type":"object","properties":{"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountedMinor":{"$ref":"#/components/schemas/MinorUnits"},"averageOrderMinor":{"$ref":"#/components/schemas/MinorUnits"},"buyers":{"type":"integer","minimum":0,"maximum":9007199254740991},"entered":{"type":"integer","minimum":0,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversionBps":{"type":"integer","minimum":0,"maximum":9007199254740991},"held":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["orders","revenueMinor","discountedMinor","averageOrderMinor","buyers","entered","rejected","conversionBps","held"],"additionalProperties":false},"codes":{"anyOf":[{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"used":{"type":"integer","minimum":0,"maximum":9007199254740991},"unused":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["total","used","unused"],"additionalProperties":false},{"type":"null"}]},"series":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountedMinor":{"$ref":"#/components/schemas/MinorUnits"},"entered":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["date","orders","revenueMinor","discountedMinor","entered"],"additionalProperties":false}},"topProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"name":{"type":"string"},"units":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["productId","name","units","revenueMinor"],"additionalProperties":false}},"reasons":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["detail","count"],"additionalProperties":false}}},"required":["discount","currency","days","kpis","codes","series","topProducts","reasons"],"additionalProperties":false},"CouponUsageEntry":{"type":"object","properties":{"id":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"at":{"$ref":"#/components/schemas/Timestamp"},"event":{"$ref":"#/components/schemas/CouponEvent"},"code":{"type":["string","null"]},"email":{"type":["string","null"]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"detail":{"type":"string"}},"required":["id","at","event","code","email","orderId","orderNumber","amountMinor","detail"],"additionalProperties":false},"CouponUsagePage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CouponUsageEntry"}},"nextCursor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"CreateApiKeyResponse":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/ApiKey"},"secret":{"type":"string","pattern":"^sk_(live|test)_[0-9a-hjkmnp-tv-z]{20}_[A-Za-z0-9_-]{43}$"}},"required":["key","secret"],"additionalProperties":false},"CreateCategoryResponse":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/Category"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"full":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/ProductId"}}},"required":["category","categories","full"],"additionalProperties":false},"CreateGiftCardProductResponse":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"}},"required":["productId"],"additionalProperties":false},"CreateManualMethodResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ManualMethodId"},"name":{"type":"string"},"instructions":{"type":"string"},"enabled":{"type":"boolean"},"payWithinHours":{"type":"integer","minimum":1,"maximum":720},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"awaiting":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paymentModel":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PaymentModel"},{"type":"null"}]},"switchedToOwn":{"default":false,"type":"boolean"}},"required":["id","name","instructions","enabled","payWithinHours","position","awaiting","createdAt","paymentModel","switchedToOwn"],"additionalProperties":false},"CreateMediaTransformResponse":{"type":"object","properties":{"url":{"type":"string"},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["url","width","height"],"additionalProperties":false},"CreateOAuthAppResponse":{"type":"object","properties":{"app":{"$ref":"#/components/schemas/OAuthApp"},"clientSecret":{"type":"string","pattern":"^sfcs_[A-Za-z0-9_-]{43}$"}},"required":["app","clientSecret"],"additionalProperties":false},"CreateStoreResponse":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/StoreSummary"}},"required":["store"],"additionalProperties":false},"CreateStorefrontKeyResponse":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/StorefrontKey"},"secret":{"type":"string"}},"required":["key","secret"],"additionalProperties":false},"CreateThemePreviewLinkResponse":{"type":"object","properties":{"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["url","expiresAt"],"additionalProperties":false},"CreateThemeTemplateResponse":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/ThemeTemplate"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}}},"required":["template","revision","issues"],"additionalProperties":false},"CreateWebhookEndpointResponse":{"type":"object","properties":{"endpoint":{"$ref":"#/components/schemas/WebhookEndpoint"},"secret":{"type":"string","pattern":"^whsec_[A-Za-z0-9+/=]{32,}$"}},"required":["endpoint","secret"],"additionalProperties":false},"CreditEntryId":{"type":"string","pattern":"^scr_[0-9a-hjkmnp-tv-z]{20}$"},"CreditRefundMode":{"type":"string","enum":["offered","default"]},"CreditRefundSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"bonusBps":{"default":1000,"type":"integer","minimum":0,"maximum":2500},"mode":{"default":"offered","$ref":"#/components/schemas/CreditRefundMode"},"offerDays":{"default":7,"type":"integer","minimum":1,"maximum":30}},"required":["enabled","bonusBps","mode","offerDays"],"additionalProperties":false},"CreditRefundStats":{"type":"object","properties":{"days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"retainedMinor":{"$ref":"#/components/schemas/MinorUnits"},"bonusMinor":{"$ref":"#/components/schemas/MinorUnits"},"moneyRefundedMinor":{"$ref":"#/components/schemas/MinorUnits"},"creditShareBps":{"type":"integer","minimum":0,"maximum":10000},"respentMinor":{"$ref":"#/components/schemas/MinorUnits"},"outstandingMinor":{"$ref":"#/components/schemas/MinorUnits"},"offers":{"type":"object","properties":{"made":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"credit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"original":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["made","credit","original","pending","expired"],"additionalProperties":false},"weeks":{"type":"array","items":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"retainedMinor":{"$ref":"#/components/schemas/MinorUnits"},"moneyMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["start","retainedMinor","moneyMinor"],"additionalProperties":false}}},"required":["days","currency","retainedMinor","bonusMinor","moneyRefundedMinor","creditShareBps","respentMinor","outstandingMinor","offers","weeks"],"additionalProperties":false},"CreditRefundsOverview":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/CreditRefundSettings"},"stats":{"$ref":"#/components/schemas/CreditRefundStats"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/RefundOffer"}}},"required":["settings","stats","offers"],"additionalProperties":false},"CrispWebsiteId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"CryptoAsset":{"type":"string","enum":["BTC","LTC","ETH","USDC","USDT"]},"CryptoCheckoutView":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"storeName":{"type":"string"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"cryptoDiscountBps":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["open","paid","expired"]},"orderPath":{"type":"string"},"rails":{"type":"array","items":{"$ref":"#/components/schemas/CryptoRailOption"}},"payment":{"anyOf":[{"$ref":"#/components/schemas/CryptoPaymentView"},{"type":"null"}]},"shielded":{"type":"boolean"},"lines":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["name","quantity","totalMinor"],"additionalProperties":false}},"buyerEmailMasked":{"type":"string"},"pollSeconds":{"type":"integer","minimum":2,"maximum":60}},"required":["sessionId","storeName","totalMinor","currency","cryptoDiscountBps","state","orderPath","rails","payment","shielded","lines","buyerEmailMasked","pollSeconds"],"additionalProperties":false},"CryptoNetwork":{"type":"string","enum":["bitcoin","litecoin","ethereum","polygon","base","arbitrum","solana"]},"CryptoPaymentId":{"type":"string","pattern":"^cpay_[0-9a-hjkmnp-tv-z]{20}$"},"CryptoPaymentList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CryptoPaymentRow"}},"counts":{"type":"object","properties":{"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"attention":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["open","attention","paid"],"additionalProperties":false}},"required":["items","counts"],"additionalProperties":false},"CryptoPaymentRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CryptoPaymentId"},"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"buyerEmail":{"type":"string"},"rail":{"$ref":"#/components/schemas/CryptoRail"},"label":{"type":"string"},"address":{"type":"string"},"amount":{"type":"string"},"received":{"type":"string"},"overpaid":{"type":"string"},"status":{"$ref":"#/components/schemas/CryptoPaymentStatus"},"confirmations":{"type":"integer","minimum":0,"maximum":9007199254740991},"requiredConfirmations":{"type":"integer","minimum":1,"maximum":9007199254740991},"fiatMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"late":{"type":"boolean"},"reorged":{"type":"boolean"},"note":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"transfers":{"type":"array","items":{"$ref":"#/components/schemas/CryptoTransferView"}}},"required":["id","sessionId","orderId","buyerEmail","rail","label","address","amount","received","overpaid","status","confirmations","requiredConfirmations","fiatMinor","currency","late","reorged","note","createdAt","updatedAt","transfers"],"additionalProperties":false},"CryptoPaymentStatus":{"type":"string","enum":["awaiting","detected","confirming","underpaid","paid","expired","underpaid_expired","late","cancelled","refunded"]},"CryptoPaymentView":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CryptoPaymentId"},"rail":{"$ref":"#/components/schemas/CryptoRail"},"asset":{"$ref":"#/components/schemas/CryptoAsset"},"network":{"$ref":"#/components/schemas/CryptoNetwork"},"label":{"type":"string"},"address":{"type":"string"},"amount":{"type":"string"},"uri":{"type":"string"},"reference":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/CryptoPaymentStatus"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"confirmations":{"type":"integer","minimum":0,"maximum":9007199254740991},"requiredConfirmations":{"type":"integer","minimum":1,"maximum":9007199254740991},"received":{"type":"string"},"remaining":{"type":"string"},"overpaid":{"type":"string"},"topupAmount":{"type":["string","null"]},"topupExpiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"rate":{"type":"string"},"fiatMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"transfers":{"type":"array","items":{"$ref":"#/components/schemas/CryptoTransferView"}},"simulated":{"type":"boolean"}},"required":["id","rail","asset","network","label","address","amount","uri","reference","status","expiresAt","confirmations","requiredConfirmations","received","remaining","overpaid","topupAmount","topupExpiresAt","rate","fiatMinor","currency","transfers","simulated"],"additionalProperties":false},"CryptoRail":{"type":"string","enum":["btc","ltc","eth_ethereum","eth_base","eth_arbitrum","usdc_ethereum","usdc_polygon","usdc_base","usdc_arbitrum","usdt_ethereum","usdt_polygon","usdt_arbitrum","usdc_solana"]},"CryptoRailOption":{"type":"object","properties":{"rail":{"$ref":"#/components/schemas/CryptoRail"},"asset":{"$ref":"#/components/schemas/CryptoAsset"},"network":{"$ref":"#/components/schemas/CryptoNetwork"},"label":{"type":"string"},"estimate":{"type":["string","null"]}},"required":["rail","asset","network","label","estimate"],"additionalProperties":false},"CryptoSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"btcXpub":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"ltcXpub":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"evmAddress":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"solanaAddress":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"rails":{"default":["btc","ltc","usdc_polygon","usdc_base","usdt_ethereum","eth_ethereum","usdc_solana"],"maxItems":13,"type":"array","items":{"$ref":"#/components/schemas/CryptoRail"}},"quoteMinutes":{"default":30,"type":"integer","minimum":10,"maximum":120},"underpayToleranceBps":{"default":50,"type":"integer","minimum":0,"maximum":500},"underpayToleranceMinor":{"default":0,"type":"integer","minimum":0,"maximum":10000,"$ref":"#/components/schemas/MinorUnits"},"topupMinutes":{"default":60,"type":"integer","minimum":10,"maximum":1440},"overpayment":{"default":"keep","$ref":"#/components/schemas/OverpaymentPolicy"},"late":{"default":"reprice","$ref":"#/components/schemas/LatePaymentPolicy"},"confirmations":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/CryptoNetwork"},"additionalProperties":{"type":"integer","minimum":1,"maximum":200}}},"required":["enabled","btcXpub","ltcXpub","evmAddress","solanaAddress","rails","quoteMinutes","underpayToleranceBps","underpayToleranceMinor","topupMinutes","overpayment","late","confirmations"],"additionalProperties":false},"CryptoSettingsView":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/CryptoSettings"},"wallets":{"$ref":"#/components/schemas/CryptoWalletStatus"},"live":{"type":"array","items":{"$ref":"#/components/schemas/CryptoRail"}},"platformEnabled":{"type":"boolean"},"paymentModel":{"type":"string","enum":["merchant_of_record","seller_gateway"]},"chainSource":{"type":"string","enum":["live","simulated"]},"commissionBps":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["settings","wallets","live","platformEnabled","paymentModel","chainSource","commissionBps"],"additionalProperties":false},"CryptoTransferView":{"type":"object","properties":{"txid":{"type":"string"},"amount":{"type":"string"},"confirmations":{"type":"integer","minimum":0,"maximum":9007199254740991},"status":{"type":"string","enum":["mempool","confirmed","dropped"]},"late":{"type":"boolean"},"explorerUrl":{"type":["string","null"]},"seenAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["txid","amount","confirmations","status","late","explorerUrl","seenAt"],"additionalProperties":false},"CryptoWalletStatus":{"type":"object","properties":{"btc":{"anyOf":[{"$ref":"#/components/schemas/XpubCheck"},{"type":"null"}]},"ltc":{"anyOf":[{"$ref":"#/components/schemas/XpubCheck"},{"type":"null"}]},"evm":{"anyOf":[{"type":"object","properties":{"ok":{"type":"boolean"},"address":{"type":["string","null"]},"error":{"type":["string","null"]}},"required":["ok","address","error"],"additionalProperties":false},{"type":"null"}]},"solana":{"anyOf":[{"type":"object","properties":{"ok":{"type":"boolean"},"address":{"type":["string","null"]},"error":{"type":["string","null"]}},"required":["ok","address","error"],"additionalProperties":false},{"type":"null"}]}},"required":["btc","ltc","evm","solana"],"additionalProperties":false},"CsvExport":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"}},"required":["filename","csv"],"additionalProperties":false},"CurrencyCode":{"type":"string","enum":["USD","EUR","GBP","CAD","AUD","INR","NPR","JPY"]},"CurrencyDisplay":{"type":"string","enum":["symbol","code"]},"CurrencyDisplaySettings":{"type":"object","properties":{"currencies":{"default":[{"code":"EUR","rate":0.92},{"code":"GBP","rate":0.79}],"minItems":1,"maxItems":12,"type":"array","items":{"$ref":"#/components/schemas/CurrencyRate"}},"position":{"default":"bottom-left","type":"string","enum":["bottom-left","bottom-right"]},"note":{"default":"Prices are converted for display. You pay in the store currency.","type":"string","maxLength":120}},"required":["currencies","position","note"],"additionalProperties":false},"CurrencyOverview":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"gmvMinor":{"$ref":"#/components/schemas/MinorUnits"},"morVolumeMinor":{"$ref":"#/components/schemas/MinorUnits"},"sellerGatewayVolumeMinor":{"$ref":"#/components/schemas/MinorUnits"},"platformRevenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"planRevenueMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"processorCostMinor":{"$ref":"#/components/schemas/MinorUnits"},"processorCostReportedMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxCollectedMinor":{"$ref":"#/components/schemas/MinorUnits"},"pendingPayoutsMinor":{"$ref":"#/components/schemas/MinorUnits"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"series":{"type":"array","items":{"$ref":"#/components/schemas/OverviewDay"}}},"required":["currency","gmvMinor","morVolumeMinor","sellerGatewayVolumeMinor","platformRevenueMinor","planRevenueMinor","processorCostMinor","processorCostReportedMinor","taxCollectedMinor","pendingPayoutsMinor","orders","stores","series"],"additionalProperties":false},"CurrencyRate":{"type":"object","properties":{"code":{"type":"string","pattern":"^[A-Z]{3}$"},"rate":{"type":"number","exclusiveMinimum":0,"maximum":1000000}},"required":["code","rate"],"additionalProperties":false},"CurrencyStatement":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/StatementLine"}},"opening":{"$ref":"#/components/schemas/BalanceSet"},"closing":{"$ref":"#/components/schemas/BalanceSet"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/StatementCheck"}},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refunds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"payouts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["currency","lines","opening","closing","checks","orders","refunds","disputes","payouts"],"additionalProperties":false},"Cursor":{"type":"string","maxLength":200},"CustomDomain":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DomainId"},"hostname":{"$ref":"#/components/schemas/Hostname"},"apex":{"type":"boolean"},"mode":{"$ref":"#/components/schemas/DomainMode"},"nameservers":{"anyOf":[{"$ref":"#/components/schemas/DomainNameservers"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/DomainStatus"},"sslStatus":{"$ref":"#/components/schemas/SslStatus"},"primary":{"type":"boolean"},"records":{"type":"array","items":{"$ref":"#/components/schemas/DnsRecord"}},"issues":{"type":"array","items":{"type":"string"}},"dns":{"anyOf":[{"$ref":"#/components/schemas/DomainDns"},{"type":"null"}]},"redirectsTo":{"type":["string","null"]},"lastCheckedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"verifiedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","hostname","apex","mode","nameservers","status","sslStatus","primary","records","issues","dns","redirectsTo","lastCheckedAt","verifiedAt","createdAt"],"additionalProperties":false},"CustomFieldAnswer":{"type":"object","properties":{"id":{"type":"string","maxLength":32},"label":{"type":"string","maxLength":80},"value":{"type":"string","maxLength":4000},"sensitive":{"default":false,"type":"boolean"}},"required":["id","label","value","sensitive"],"additionalProperties":false},"CustomFieldType":{"type":"string","enum":["text","textarea","number","email","url","select","checkbox","discord"]},"CustomRole":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RoleId"},"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","maxLength":200},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/StorePermission"}},"memberCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","description","permissions","memberCount","updatedAt"],"additionalProperties":false},"CustomerAnalytics":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totals":{"type":"object","properties":{"customers":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"newCustomers":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"returningCustomers":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"repeatRateBps":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"averageLifetimeMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"ordersPerCustomer":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false}},"required":["customers","newCustomers","returningCustomers","repeatRateBps","averageLifetimeMinor","ordersPerCustomer"],"additionalProperties":false},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"hour":{"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"newCustomers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"returningCustomers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","hour","newCustomers","returningCustomers"],"additionalProperties":false}},"segments":{"$ref":"#/components/schemas/CustomerCounts"},"topCustomers":{"type":"array","items":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"name":{"type":"string"},"email":{"type":"string"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spentMinor":{"$ref":"#/components/schemas/MinorUnits"},"country":{"type":"string"}},"required":["customerId","name","email","orders","spentMinor","country"],"additionalProperties":false}},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["country","customers","revenueMinor"],"additionalProperties":false}}},"required":["range","from","to","period","currency","totals","daily","segments","topCustomers","countries"],"additionalProperties":false},"CustomerCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"new":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"returning":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"highValue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"atRisk":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blocked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","new","returning","highValue","atRisk","blocked"],"additionalProperties":false},"CustomerCredit":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"balanceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/StoreCreditEntry"}}},"required":["customerId","currency","balanceMinor","entries"],"additionalProperties":false},"CustomerDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomerId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryCode"},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"spentMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"firstOrderAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastOrderAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"segments":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSegment"}},"blocked":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"averageOrderMinor":{"$ref":"#/components/schemas/MinorUnits"},"refundedMinor":{"$ref":"#/components/schemas/MinorUnits"},"refunds":{"type":"integer","minimum":0,"maximum":9007199254740991},"disputes":{"type":"integer","minimum":0,"maximum":9007199254740991},"blockedReason":{"type":["string","null"]},"blockedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"notes":{"type":"array","items":{"$ref":"#/components/schemas/CustomerNote"}},"orderList":{"type":"array","items":{"$ref":"#/components/schemas/CustomerOrder"}},"productsOwned":{"type":"array","items":{"$ref":"#/components/schemas/OwnedProduct"}},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/OwnedLicense"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailLogEntry"}},"reviews":{"type":"integer","minimum":0,"maximum":9007199254740991},"mergedFrom":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomerId"},"email":{"$ref":"#/components/schemas/Email"}},"required":["id","email"],"additionalProperties":false}},"affiliateCode":{"type":["string","null"]},"discord":{"$ref":"#/components/schemas/CustomerDiscord"},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSession"}},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/CustomerTimelineEntry"}},"storeCreditMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["id","email","name","country","orders","spentMinor","currency","firstOrderAt","lastOrderAt","tags","segments","blocked","createdAt","averageOrderMinor","refundedMinor","refunds","disputes","blockedReason","blockedAt","notes","orderList","productsOwned","licenses","emails","reviews","mergedFrom","affiliateCode","discord","sessions","timeline","storeCreditMinor"],"additionalProperties":false},"CustomerDiscord":{"type":"object","properties":{"userId":{"type":["string","null"]},"serverConnected":{"type":"boolean"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerDiscordRole"}}},"required":["userId","serverConnected","roles"],"additionalProperties":false},"CustomerDiscordRole":{"type":"object","properties":{"roleName":{"type":"string"},"action":{"type":"string","enum":["grant","revoke"]},"status":{"type":"string","enum":["succeeded","simulated","pending","failed"]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["roleName","action","status","orderId","orderNumber","at"],"additionalProperties":false},"CustomerId":{"type":"string","pattern":"^cus_[0-9a-hjkmnp-tv-z]{20}$"},"CustomerNote":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomerNoteId"},"body":{"type":"string"},"author":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","body","author","createdAt"],"additionalProperties":false},"CustomerNoteId":{"type":"string","pattern":"^cnote_[0-9a-hjkmnp-tv-z]{20}$"},"CustomerOrder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"isTest":{"type":"boolean"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"itemsLabel":{"type":"string"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"coveredBy":{"default":null,"anyOf":[{"$ref":"#/components/schemas/FreeCover"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","number","status","isTest","totalMinor","currency","itemsLabel","paymentMethod","coveredBy","createdAt","paidAt"],"additionalProperties":false},"CustomerRef":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomerId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryCode"}},"required":["id","email","name","country"],"additionalProperties":false},"CustomerRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomerId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"country":{"$ref":"#/components/schemas/CountryCode"},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"spentMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"firstOrderAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastOrderAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"segments":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSegment"}},"blocked":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","name","country","orders","spentMinor","currency","firstOrderAt","lastOrderAt","tags","segments","blocked","createdAt"],"additionalProperties":false},"CustomerSegment":{"type":"string","enum":["new","returning","high_value","at_risk"]},"CustomerSession":{"type":"object","properties":{"ip":{"type":["string","null"]},"country":{"type":["string","null"]},"userAgent":{"type":["string","null"]},"browser":{"type":"string"},"os":{"type":"string"},"device":{"$ref":"#/components/schemas/VisitorDevice"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSessionSource"}},"events":{"type":"integer","minimum":1,"maximum":9007199254740991},"firstSeenAt":{"$ref":"#/components/schemas/Timestamp"},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["ip","country","userAgent","browser","os","device","sources","events","firstSeenAt","lastSeenAt"],"additionalProperties":false},"CustomerSessionSource":{"type":"string","enum":["checkout","order_page","download","account"]},"CustomerTimelineEntry":{"type":"object","properties":{"id":{"type":"string"},"kind":{"$ref":"#/components/schemas/CustomerTimelineKind"},"at":{"$ref":"#/components/schemas/Timestamp"},"title":{"type":"string"},"detail":{"type":"string"},"tone":{"type":"string","enum":["neutral","good","warn","bad","accent"]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"href":{"type":["string","null"]},"amountMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","kind","at","title","detail","tone","orderId","href","amountMinor"],"additionalProperties":false},"CustomerTimelineKind":{"type":"string","enum":["order_placed","order_paid","order_refunded","order_disputed","email","note","review","claim","dispute","sign_in","discord","store_credit","merged"]},"DashboardRoute":{"type":"string","minLength":1,"maxLength":200,"pattern":"^\\/(?:(?::[A-Za-z][A-Za-z0-9]{0,30}|[a-z][a-z0-9-]{0,39})(?:\\/(?::[A-Za-z][A-Za-z0-9]{0,30}|[a-z][a-z0-9-]{0,39}))*)?$"},"DecideOAuthResponse":{"type":"object","properties":{"redirectTo":{"type":"string"}},"required":["redirectTo"],"additionalProperties":false},"DecidedBy":{"type":"string","enum":["platform_list","allow_list","block_list","rule","score","policy"]},"DeleteDeskCannedResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true}},"required":["ok"],"additionalProperties":false},"DeleteThemeDraftsResponse":{"type":"object","properties":{"deleted":{"type":"array","items":{"$ref":"#/components/schemas/ThemeId"}},"skipped":{"type":"array","items":{"type":"object","properties":{"themeId":{"$ref":"#/components/schemas/ThemeId"},"reason":{"type":"string"}},"required":["themeId","reason"],"additionalProperties":false}}},"required":["deleted","skipped"],"additionalProperties":false},"DeleteThemeTemplateResponse":{"type":"object","properties":{"revision":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["revision"],"additionalProperties":false},"DeliveredDownload":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"url":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["productId","name","url","expiresAt"],"additionalProperties":false},"DeliveredKey":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"value":{"type":"string"}},"required":["productId","productName","value"],"additionalProperties":false},"DeliveredNote":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"kind":{"type":"string","enum":["message","option","keys","service","dynamic","warranty"]},"title":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"bookingUrl":{"type":["string","null"]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["productId","productName","kind","title","html","text","bookingUrl","turnaroundDays"],"additionalProperties":false},"DeliveryNoticeSettings":{"type":"object","properties":{"instantText":{"default":"Instant delivery. It is on your order page and in your inbox the moment you pay.","type":"string","minLength":1,"maxLength":160},"manualText":{"default":"Delivered by our team within {hours} hours.","type":"string","minLength":1,"maxLength":160},"manualHours":{"default":12,"type":"integer","minimum":1,"maximum":168},"showHours":{"default":true,"type":"boolean"},"openHour":{"default":9,"type":"integer","minimum":0,"maximum":23},"closeHour":{"default":21,"type":"integer","minimum":1,"maximum":24},"days":{"default":["mon","tue","wed","thu","fri","sat","sun"],"minItems":1,"maxItems":7,"type":"array","items":{"$ref":"#/components/schemas/Weekday"}},"timeZone":{"default":"UTC","$ref":"#/components/schemas/AppTimeZone"}},"required":["instantText","manualText","manualHours","showHours","openHour","closeHour","days","timeZone"],"additionalProperties":false},"DeliveryProof":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/EvidenceKind"},"at":{"$ref":"#/components/schemas/Timestamp"},"detail":{"type":"string"},"ip":{"type":["string","null"]},"country":{"type":["string","null"]},"userAgent":{"type":["string","null"]}},"required":["kind","at","detail","ip","country","userAgent"],"additionalProperties":false},"DeliveryStatus":{"type":"string","enum":["sent","simulated","failed"]},"DeliveryWebhookSecret":{"type":"object","properties":{"secret":{"type":"string"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["secret","version"],"additionalProperties":false},"DeliveryWebhookTest":{"type":"object","properties":{"ok":{"type":"boolean"},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"error":{"type":["string","null"]},"keys":{"maxItems":200,"type":"array","items":{"type":"string"}},"message":{"type":"string"},"bodyPreview":{"type":"string"}},"required":["ok","status","durationMs","error","keys","message","bodyPreview"],"additionalProperties":false},"DeskAttachment":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskAttachmentId"},"filename":{"type":"string"},"contentType":{"$ref":"#/components/schemas/AttachmentContentType"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"url":{"type":"string"},"isImage":{"type":"boolean"}},"required":["id","filename","contentType","bytes","url","isImage"],"additionalProperties":false},"DeskAttachmentId":{"type":"string","pattern":"^dta_[0-9a-hjkmnp-tv-z]{20}$"},"DeskCanned":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskCannedId"},"name":{"type":"string"},"shortcut":{"type":"string"},"body":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"updatedBy":{"type":"string"}},"required":["id","name","shortcut","body","updatedAt","updatedBy"],"additionalProperties":false},"DeskCannedId":{"type":"string","pattern":"^dcr_[0-9a-hjkmnp-tv-z]{20}$"},"DeskChannel":{"type":"string","enum":["dashboard","discord","admin","email"]},"DeskEvent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskEventId"},"kind":{"$ref":"#/components/schemas/DeskEventKind"},"actorName":{"type":"string"},"summary":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","actorName","summary","createdAt"],"additionalProperties":false},"DeskEventId":{"type":"string","pattern":"^dte_[0-9a-hjkmnp-tv-z]{20}$"},"DeskEventKind":{"type":"string","enum":["created","status","priority","assigned","tags","topic","subject","sla_breached","rated","discord","auto"]},"DeskMe":{"type":"object","properties":{"handle":{"type":["string","null"]},"suggested":{"type":"string"},"discordUsername":{"type":["string","null"]},"canAnswer":{"type":"boolean"}},"required":["handle","suggested","discordUsername","canAnswer"],"additionalProperties":false},"DeskMessage":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskMessageId"},"author":{"type":"string","enum":["customer","agent","system"]},"authorName":{"type":"string"},"authorAdminId":{"anyOf":[{"$ref":"#/components/schemas/AdminUserId"},{"type":"null"}]},"body":{"type":"string"},"internal":{"type":"boolean"},"via":{"$ref":"#/components/schemas/DeskChannel"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/DeskAttachment"}},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","author","authorName","authorAdminId","body","internal","via","attachments","createdAt"],"additionalProperties":false},"DeskMessageId":{"type":"string","pattern":"^dtm_[0-9a-hjkmnp-tv-z]{20}$"},"DeskRequester":{"type":"object","properties":{"userId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"name":{"type":"string"},"email":{"type":["string","null"]},"discordUserId":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"discordUsername":{"type":["string","null"]},"storeId":{"anyOf":[{"$ref":"#/components/schemas/StoreId"},{"type":"null"}]},"storeName":{"type":["string","null"]},"verified":{"type":"boolean"}},"required":["userId","name","email","discordUserId","discordUsername","storeId","storeName","verified"],"additionalProperties":false},"DeskSellerContext":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"twoFactor":{"type":"boolean"}},"required":["id","name","email","createdAt","twoFactor"],"additionalProperties":false},"stores":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"type":"string"},"status":{"type":"string"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"currency":{"type":"string"},"sales30dMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paymentModel":{"type":"string"}},"required":["id","name","handle","status","planId","planName","createdAt","currency","sales30dMinor","orders30d","paymentModel"],"additionalProperties":false}},"discord":{"anyOf":[{"type":"object","properties":{"discordUserId":{"$ref":"#/components/schemas/DiscordObjectId"},"username":{"type":"string"},"linkedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["discordUserId","username","linkedAt"],"additionalProperties":false},{"type":"null"}]},"otherTickets":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskTicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","number","subject","status","createdAt"],"additionalProperties":false}}},"required":["user","stores","discord","otherTickets"],"additionalProperties":false},"DeskSettings":{"type":"object","properties":{"topics":{"default":[{"id":"account","label":"Account and sign-in","emoji":"🔐","hint":"Your account email and what happens when you sign in","priority":"high"},{"id":"payouts","label":"Payouts and ShopFast Pay","emoji":"💸","hint":"Which payout, the amount and what you expected","priority":"high"},{"id":"billing","label":"Plans and billing","emoji":"🧾","hint":"Your plan, the invoice and what looks wrong","priority":"normal"},{"id":"store","label":"Store setup and domains","emoji":"🏪","hint":"Your store address and the step you are stuck on","priority":"normal"},{"id":"bots","label":"Discord and Telegram bots","emoji":"🤖","hint":"The server or bot, the command and what it answered","priority":"normal"},{"id":"api","label":"API and developers","emoji":"🧩","hint":"The endpoint, the request id and the response","priority":"normal"},{"id":"problem","label":"Report a problem","emoji":"🚨","hint":"What broke, where, and since when","priority":"urgent"},{"id":"other","label":"Something else","emoji":"💬","hint":"Tell us in a few words","priority":"low"}],"minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DeskTopic"}},"firstResponse":{"default":{"low":1440,"normal":480,"high":120,"urgent":30},"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"],"additionalProperties":false},"resolution":{"default":{"low":10080,"normal":4320,"high":1440,"urgent":240},"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"],"additionalProperties":false},"autoAssign":{"default":"round_robin","type":"string","enum":["round_robin","off"]},"rotation":{"default":[],"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/AdminUserId"}},"autoCloseDays":{"default":3,"type":"integer","minimum":1,"maximum":30},"csat":{"default":true,"type":"boolean"},"acknowledgement":{"default":"Thanks for reaching out. A ShopFast teammate will reply here; we usually answer within {target}.","type":"string","maxLength":500},"maxOpenPerRequester":{"default":3,"type":"integer","minimum":1,"maximum":10}},"required":["topics","firstResponse","resolution","autoAssign","rotation","autoCloseDays","csat","acknowledgement","maxOpenPerRequester"],"additionalProperties":false},"DeskSettingsView":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/DeskSettings"},"agents":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"},"role":{"type":"string"},"inRotation":{"type":"boolean"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","role","inRotation","open"],"additionalProperties":false}}},"required":["settings","agents"],"additionalProperties":false},"DeskStats":{"type":"object","properties":{"days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"breached":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"firstResponseMedianMin":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"resolutionMedianMin":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"slaMetPct":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"csatAvg":{"type":["number","null"]},"csatCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"byDay":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","opened","solved"],"additionalProperties":false}},"byChannel":{"type":"array","items":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/DeskChannel"},"n":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["channel","n"],"additionalProperties":false}},"byTopic":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"label":{"type":"string"},"n":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["topic","label","n"],"additionalProperties":false}},"byAdmin":{"type":"array","items":{"type":"object","properties":{"adminId":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"replies":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"firstResponseMedianMin":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"csatAvg":{"type":["number","null"]}},"required":["adminId","name","solved","replies","firstResponseMedianMin","csatAvg"],"additionalProperties":false}}},"required":["days","opened","solved","open","breached","firstResponseMedianMin","resolutionMedianMin","slaMetPct","csatAvg","csatCount","byDay","byChannel","byTopic","byAdmin"],"additionalProperties":false},"DeskTicketDetail":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/DeskTicketSummary"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/DeskMessage"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/DeskEvent"}},"context":{"anyOf":[{"$ref":"#/components/schemas/DeskSellerContext"},{"type":"null"}]},"discordThreadUrl":{"type":["string","null"]},"firstResponseAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"resolvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"satisfactionComment":{"type":["string","null"]}},"required":["ticket","messages","events","context","discordThreadUrl","firstResponseAt","resolvedAt","satisfactionComment"],"additionalProperties":false},"DeskTicketId":{"type":"string","pattern":"^dtk_[0-9a-hjkmnp-tv-z]{20}$"},"DeskTicketList":{"type":"object","properties":{"tickets":{"type":"array","items":{"$ref":"#/components/schemas/DeskTicketSummary"}},"counts":{"type":"object","properties":{"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mine":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unassigned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"breached":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["open","mine","unassigned","pending","breached","solved","all"],"additionalProperties":false},"nextCursor":{"type":["string","null"]}},"required":["tickets","counts","nextCursor"],"additionalProperties":false},"DeskTicketSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskTicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"priority":{"$ref":"#/components/schemas/TicketPriority"},"topic":{"type":"string"},"topicLabel":{"type":"string"},"channel":{"$ref":"#/components/schemas/DeskChannel"},"requester":{"$ref":"#/components/schemas/DeskRequester"},"assignee":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"sla":{"$ref":"#/components/schemas/SlaState"},"dueAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastMessageAt":{"$ref":"#/components/schemas/Timestamp"},"lastMessageFrom":{"type":"string","enum":["customer","agent"]},"preview":{"type":"string"},"unread":{"type":"boolean"},"messageCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"satisfaction":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","number","subject","status","priority","topic","topicLabel","channel","requester","assignee","tags","sla","dueAt","lastMessageAt","lastMessageFrom","preview","unread","messageCount","satisfaction","createdAt"],"additionalProperties":false},"DeskTopic":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"label":{"type":"string","minLength":1,"maxLength":80},"emoji":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":16},{"type":"null"}]},"hint":{"default":"","type":"string","maxLength":100},"priority":{"default":"normal","$ref":"#/components/schemas/TicketPriority"}},"required":["id","label","emoji","hint","priority"],"additionalProperties":false},"DeviceClass":{"type":"string","enum":["desktop","tablet","mobile"]},"DisconnectGatewayResponse":{"type":"object","properties":{"connection":{"$ref":"#/components/schemas/GatewayConnection"}},"required":["connection"],"additionalProperties":false},"DiscordBotCommand":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"audience":{"$ref":"#/components/schemas/DiscordCommandAudience"},"permission":{"type":["string","null"]},"permissionLabel":{"type":["string","null"]}},"required":["name","description","audience","permission","permissionLabel"],"additionalProperties":false},"DiscordBotOverview":{"type":"object","properties":{"mode":{"type":"string","enum":["live","simulated"]},"interactionsUrl":{"type":"string"},"publicKeyConfigured":{"type":"boolean"},"commands":{"type":"array","items":{"$ref":"#/components/schemas/DiscordBotCommand"}},"staff":{"type":"array","items":{"$ref":"#/components/schemas/DiscordStaffLink"}},"me":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"link":{"anyOf":[{"$ref":"#/components/schemas/DiscordStaffLink"},{"type":"null"}]}},"required":["userId","link"],"additionalProperties":false},"setupCodeExpiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"activity":{"type":"array","items":{"$ref":"#/components/schemas/DiscordCommandEntry"}}},"required":["mode","interactionsUrl","publicKeyConfigured","commands","staff","me","setupCodeExpiresAt","activity"],"additionalProperties":false},"DiscordChannelKind":{"type":"string","enum":["text","announcement"]},"DiscordChannelSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/DiscordChannelKind"},"category":{"type":["string","null"]},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","kind","category","position"],"additionalProperties":false},"DiscordCheckoutClaim":{"type":"object","properties":{"cartId":{"type":"string"},"itemCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"username":{"type":"string"}},"required":["cartId","itemCount","username"],"additionalProperties":false},"DiscordCheckoutId":{"type":"string","pattern":"^dco_[0-9a-hjkmnp-tv-z]{20}$"},"DiscordCheckoutOfCartResponse":{"type":"object","properties":{"username":{"type":["string","null"]}},"required":["username"],"additionalProperties":false},"DiscordCheckoutRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordCheckoutId"},"username":{"type":"string"},"productName":{"type":"string"},"variantName":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/DiscordCheckoutStatus"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","username","productName","variantName","status","priceMinor","orderId","orderNumber","createdAt"],"additionalProperties":false},"DiscordCheckoutStatus":{"type":"string","enum":["open","opened","paid","expired"]},"DiscordClaim":{"type":"object","properties":{"state":{"type":"string","enum":["open","claimed","expired","unavailable"]},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"account":{"type":["string","null"]}},"required":["state","expiresAt","account"],"additionalProperties":false},"DiscordCommandAudience":{"type":"string","enum":["everyone","server_managers","staff"]},"DiscordCommandEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordCommandLogId"},"command":{"type":"string"},"discordUserId":{"type":"string"},"discordUsername":{"type":"string"},"memberName":{"type":["string","null"]},"outcome":{"$ref":"#/components/schemas/DiscordCommandOutcome"},"detail":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","command","discordUserId","discordUsername","memberName","outcome","detail","createdAt"],"additionalProperties":false},"DiscordCommandLogId":{"type":"string","pattern":"^dcl_[0-9a-hjkmnp-tv-z]{20}$"},"DiscordCommandOutcome":{"type":"string","enum":["ok","denied","error"]},"DiscordDeliverySettings":{"type":"object","properties":{"guildId":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"roleId":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"roleName":{"type":"string","maxLength":100},"removeOnRefund":{"type":"boolean"},"removeOnExpiry":{"type":"boolean"},"mode":{"default":"optional","$ref":"#/components/schemas/DiscordMode"},"extraGrants":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DiscordGrant"}}},"required":["guildId","roleId","roleName","removeOnRefund","removeOnExpiry","mode","extraGrants"],"additionalProperties":false},"DiscordDmId":{"type":"string","pattern":"^ddm_[0-9a-hjkmnp-tv-z]{20}$"},"DiscordDmRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordDmId"},"kind":{"$ref":"#/components/schemas/DmKind"},"status":{"$ref":"#/components/schemas/DmStatus"},"detail":{"type":"string"},"username":{"type":["string","null"]},"subject":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"runAt":{"$ref":"#/components/schemas/Timestamp"},"sentAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","status","detail","username","subject","orderId","runAt","sentAt","createdAt"],"additionalProperties":false},"DiscordGrant":{"type":"object","properties":{"guildId":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"roleId":{"$ref":"#/components/schemas/DiscordObjectId"},"roleName":{"type":"string","maxLength":100}},"required":["guildId","roleId","roleName"],"additionalProperties":false},"DiscordGrantState":{"type":"string","enum":["granted","simulated","pending","failed","removed"]},"DiscordGuild":{"type":"object","properties":{"guildId":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"iconUrl":{"type":["string","null"]},"botStatus":{"type":"string","enum":["connected","missing_permissions","disconnected"]},"roles":{"type":"array","items":{"$ref":"#/components/schemas/DiscordRole"}},"connectedAt":{"$ref":"#/components/schemas/Timestamp"},"connectedBy":{"type":"string"},"rolesSyncedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["guildId","name","iconUrl","botStatus","roles","connectedAt","connectedBy","rolesSyncedAt"],"additionalProperties":false},"DiscordInvite":{"type":"string","maxLength":120,"pattern":"^https:\\/\\/(?:discord\\.gg|discord\\.com\\/invite)\\/[A-Za-z0-9-]{2,40}$"},"DiscordLinkSource":{"type":"string","enum":["oauth","command","imported","simulated"]},"DiscordLostServer":{"type":"object","properties":{"guildId":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"main":{"type":"boolean"},"reason":{"type":"string","enum":["bot_removed","server_deleted","disconnected"]},"at":{"$ref":"#/components/schemas/Timestamp"},"products":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["guildId","name","main","reason","at","products"],"additionalProperties":false},"DiscordMapping":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"productType":{"type":"string"},"roleId":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"roleName":{"type":["string","null"]},"removeOnRefund":{"type":"boolean"},"grants30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productId","productName","productType","roleId","roleName","removeOnRefund","grants30d"],"additionalProperties":false},"DiscordMember":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"name":{"type":"string"},"email":{"type":"string"},"discordUserId":{"type":["string","null"]},"username":{"type":["string","null"]},"source":{"anyOf":[{"$ref":"#/components/schemas/DiscordLinkSource"},{"type":"null"}]},"linkedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"canPull":{"type":"boolean"},"server":{"$ref":"#/components/schemas/DiscordServerState"},"serverDetail":{"type":["string","null"]},"lastPulledAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"roles":{"type":"array","items":{"$ref":"#/components/schemas/DiscordMemberRole"}}},"required":["customerId","name","email","discordUserId","username","source","linkedAt","canPull","server","serverDetail","lastPulledAt","roles"],"additionalProperties":false},"DiscordMemberRole":{"type":"object","properties":{"roleName":{"type":"string"},"productName":{"type":["string","null"]},"orderNumber":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/DiscordGrantState"},"detail":{"type":"string"}},"required":["roleName","productName","orderNumber","state","detail"],"additionalProperties":false},"DiscordMembersPage":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/DiscordMember"}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"pageSize":{"type":"integer","minimum":1,"maximum":9007199254740991},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"linked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"waiting":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","linked","waiting","failed"],"additionalProperties":false}},"required":["members","total","page","pageSize","counts"],"additionalProperties":false},"DiscordMode":{"type":"string","enum":["disabled","optional","mandatory"]},"DiscordObjectId":{"type":"string","pattern":"^\\d{17,20}$"},"DiscordOverview":{"type":"object","properties":{"mode":{"type":"string","enum":["live","simulated"]},"guild":{"anyOf":[{"$ref":"#/components/schemas/DiscordGuild"},{"type":"null"}]},"extraServers":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/DiscordGuild"}},"lostServers":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/DiscordLostServer"}},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/DiscordMapping"}},"log":{"type":"array","items":{"$ref":"#/components/schemas/DiscordSyncEntry"}},"stats":{"type":"object","properties":{"linkedCustomers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"grants30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failures30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["linkedCustomers","grants30d","failures30d","pending"],"additionalProperties":false}},"required":["mode","guild","extraServers","lostServers","mappings","log","stats"],"additionalProperties":false},"DiscordPullId":{"type":"string","pattern":"^dpl_[0-9a-hjkmnp-tv-z]{20}$"},"DiscordPullRun":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordPullId"},"status":{"$ref":"#/components/schemas/DiscordPullStatus"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"processed":{"type":"integer","minimum":0,"maximum":9007199254740991},"added":{"type":"integer","minimum":0,"maximum":9007199254740991},"alreadyIn":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"startedBy":{"type":"string"},"detail":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","status","total","processed","added","alreadyIn","failed","startedBy","detail","createdAt","finishedAt"],"additionalProperties":false},"DiscordPullStatus":{"type":"string","enum":["queued","running","succeeded","failed"]},"DiscordReadsMessages":{"type":"string","enum":["yes","no","unknown"]},"DiscordRole":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordObjectId"},"name":{"type":"string"},"color":{"type":["string","null"]},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"manageable":{"type":"boolean"}},"required":["id","name","color","position","manageable"],"additionalProperties":false},"DiscordServerState":{"type":"string","enum":["joined","not_joined","failed","unknown"]},"DiscordSetupCode":{"type":"object","properties":{"code":{"type":"string"},"command":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["code","command","expiresAt"],"additionalProperties":false},"DiscordShopOverview":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/DiscordShopSettings"},"guildConnected":{"type":"boolean"},"mode":{"type":"string","enum":["live","simulated"]},"timezone":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"stats":{"type":"object","properties":{"checkouts30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"paid30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenue30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"dmsSent30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"dmsWaiting":{"type":"integer","minimum":0,"maximum":9007199254740991},"dmsSkipped30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"dmsFailed30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"subscribers":{"type":"integer","minimum":0,"maximum":9007199254740991},"unsubscribed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["checkouts30d","paid30d","revenue30dMinor","dmsSent30d","dmsWaiting","dmsSkipped30d","dmsFailed30d","subscribers","unsubscribed"],"additionalProperties":false},"checkouts":{"type":"array","items":{"$ref":"#/components/schemas/DiscordCheckoutRow"}},"dms":{"type":"array","items":{"$ref":"#/components/schemas/DiscordDmRow"}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"options":{"type":"integer","minimum":0,"maximum":9007199254740991},"onSale":{"type":"boolean"}},"required":["id","name","options","onSale"],"additionalProperties":false}},"preview":{"default":null,"anyOf":[{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"durations":{"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"stock":{"type":"string"}},"required":["title","priceMinor","stock"],"additionalProperties":false}},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["title","description","durations","options","priceMinor"],"additionalProperties":false},{"type":"null"}]}},"required":["settings","guildConnected","mode","timezone","currency","stats","checkouts","dms","products","preview"],"additionalProperties":false},"DiscordShopSettings":{"type":"object","properties":{"buyEnabled":{"default":true,"type":"boolean"},"hiddenProductIds":{"default":[],"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"deliveryDm":{"default":true,"type":"boolean"},"quietHours":{"default":{"enabled":true,"start":1320,"end":480},"type":"object","properties":{"enabled":{"type":"boolean"},"start":{"$ref":"#/components/schemas/DmMinuteOfDay"},"end":{"$ref":"#/components/schemas/DmMinuteOfDay"}},"required":["enabled","start","end"],"additionalProperties":false},"dailyCap":{"default":2,"type":"integer","minimum":1,"maximum":10}},"required":["buyEnabled","hiddenProductIds","deliveryDm","quietHours","dailyCap"],"additionalProperties":false},"DiscordStaffLink":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"type":"string"},"roleName":{"type":"string"},"discordUserId":{"type":"string"},"username":{"type":"string"},"linkedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["userId","name","email","roleName","discordUserId","username","linkedAt"],"additionalProperties":false},"DiscordSyncEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscordSyncId"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"customerEmail":{"type":["string","null"]},"discordUserId":{"type":["string","null"]},"roleName":{"type":"string"},"action":{"type":"string","enum":["grant","revoke"]},"status":{"type":"string","enum":["succeeded","simulated","pending","failed"]},"detail":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","orderId","orderNumber","customerId","customerEmail","discordUserId","roleName","action","status","detail","createdAt"],"additionalProperties":false},"DiscordSyncId":{"type":"string","pattern":"^dsy_[0-9a-hjkmnp-tv-z]{20}$"},"DiscordTicketPanel":{"type":"object","properties":{"channelId":{"$ref":"#/components/schemas/DiscordObjectId"},"messageId":{"$ref":"#/components/schemas/DiscordObjectId"},"postedAt":{"$ref":"#/components/schemas/Timestamp"},"outdated":{"type":"boolean"}},"required":["channelId","messageId","postedAt","outdated"],"additionalProperties":false},"DiscordTicketSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"channelId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"staffRoleIds":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DiscordObjectId"}},"topics":{"default":[{"id":"order","label":"An order","emoji":"📦","hint":"Your order number and what went wrong"},{"id":"billing","label":"Billing and payouts","emoji":"💳","hint":"What you were charged or paid, and when"},{"id":"technical","label":"Something is broken","emoji":"🛠️","hint":"What you did, what you expected, what happened"},{"id":"other","label":"Something else","emoji":"💬","hint":""}],"minItems":1,"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/DiscordTicketTopic"}},"panelTitle":{"default":"Need a hand?","type":"string","minLength":1,"maxLength":100},"panelText":{"default":"Pick what it is about and tell us in a few words. A private thread opens with you and our team; only you and staff can see it.","type":"string","maxLength":1000},"maxOpenPerMember":{"default":1,"type":"integer","minimum":1,"maximum":5},"logChannelId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"closeOnSolve":{"default":true,"type":"boolean"}},"required":["enabled","channelId","staffRoleIds","topics","panelTitle","panelText","maxOpenPerMember","logChannelId","closeOnSolve"],"additionalProperties":false},"DiscordTicketTopic":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"label":{"type":"string","minLength":1,"maxLength":80},"emoji":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":16},{"type":"null"}]},"hint":{"default":"","type":"string","maxLength":100}},"required":["id","label","emoji","hint"],"additionalProperties":false},"DiscordTicketsOverview":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/DiscordTicketSettings"},"connected":{"type":"boolean"},"guildId":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"guildName":{"type":["string","null"]},"channels":{"type":"array","items":{"$ref":"#/components/schemas/DiscordChannelSummary"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/DiscordRole"}},"panel":{"anyOf":[{"$ref":"#/components/schemas/DiscordTicketPanel"},{"type":"null"}]},"readsMessages":{"$ref":"#/components/schemas/DiscordReadsMessages"},"simulated":{"type":"boolean"},"openTickets":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["settings","connected","guildId","guildName","channels","roles","panel","readsMessages","simulated","openTickets"],"additionalProperties":false},"DiscordWidgetSettings":{"type":"object","properties":{"inviteUrl":{"default":"","anyOf":[{"type":"string","const":""},{"$ref":"#/components/schemas/DiscordInvite"}]},"label":{"default":"Join our Discord","type":"string","minLength":1,"maxLength":40},"blurb":{"default":"Updates, status and support from the team.","type":"string","maxLength":140},"position":{"default":"bottom-left","type":"string","enum":["bottom-left","bottom-right"]},"serverId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^\\d{17,20}$"}]}},"required":["inviteUrl","label","blurb","position","serverId"],"additionalProperties":false},"Discount":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/DiscountKind"},"code":{"anyOf":[{"$ref":"#/components/schemas/DiscountCode"},{"type":"null"}]},"title":{"type":"string","minLength":1,"maxLength":80},"valueType":{"$ref":"#/components/schemas/DiscountValueType"},"value":{"type":"integer","minimum":0,"maximum":9007199254740991},"scope":{"$ref":"#/components/schemas/DiscountScope"},"productIds":{"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"collectionIds":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/CollectionId"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/CategoryId"}},"minSubtotalMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"usageLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]},"perCustomerLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"startsAt":{"$ref":"#/components/schemas/Timestamp"},"endsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"combinable":{"type":"boolean"},"autoAddFreeProducts":{"type":"boolean"},"enabled":{"type":"boolean"},"disabledMethods":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"variantIds":{"default":[],"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/VariantId"}},"showInAccount":{"default":false,"type":"boolean"},"firstOrderOnly":{"default":false,"type":"boolean"},"minQuantity":{"default":0,"type":"integer","minimum":0,"maximum":1000},"durations":{"default":[],"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/DurationKey"}},"rule":{"default":{"type":"standard"},"$ref":"#/components/schemas/DiscountRule"},"excludeSaleItems":{"default":false,"type":"boolean"},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100},"activeHours":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ActiveHours"},{"type":"null"}]},"bulkCodes":{"default":false,"type":"boolean"},"id":{"$ref":"#/components/schemas/DiscountId"},"status":{"$ref":"#/components/schemas/DiscountStatus"},"timesUsed":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountedMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["kind","code","title","valueType","value","scope","productIds","collectionIds","categoryIds","minSubtotalMinor","usageLimit","perCustomerLimit","startsAt","endsAt","combinable","autoAddFreeProducts","enabled","disabledMethods","variantIds","showInAccount","firstOrderOnly","minQuantity","durations","rule","excludeSaleItems","priority","activeHours","bulkCodes","id","status","timesUsed","revenueMinor","discountedMinor","currency","createdAt","updatedAt"],"additionalProperties":false},"DiscountAnalytics":{"type":"object","properties":{"discountId":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"customers":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountedMinor":{"$ref":"#/components/schemas/MinorUnits"},"averageOrderMinor":{"$ref":"#/components/schemas/MinorUnits"},"series":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountedMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["date","orders","revenueMinor","discountedMinor"],"additionalProperties":false}},"recent":{"type":"array","items":{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountMinor":{"$ref":"#/components/schemas/MinorUnits"},"status":{"$ref":"#/components/schemas/OrderStatus"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["orderId","number","email","totalMinor","discountMinor","status","createdAt"],"additionalProperties":false}}},"required":["discountId","currency","orders","customers","revenueMinor","discountedMinor","averageOrderMinor","series","recent"],"additionalProperties":false},"DiscountCode":{},"DiscountCodePage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscountCodeRow"}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"unused":{"type":"integer","minimum":0,"maximum":9007199254740991},"used":{"type":"integer","minimum":0,"maximum":9007199254740991},"disabled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","unused","used","disabled"],"additionalProperties":false},"batches":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CodeBatchId"},"prefix":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"usesPerCode":{"type":"integer","minimum":1,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","prefix","count","usesPerCode","createdAt"],"additionalProperties":false}}},"required":["items","total","counts","batches"],"additionalProperties":false},"DiscountCodeRow":{"type":"object","properties":{"code":{"type":"string"},"usageLimit":{"type":"integer","minimum":1,"maximum":9007199254740991},"timesUsed":{"type":"integer","minimum":0,"maximum":9007199254740991},"assignedEmail":{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},"disabled":{"type":"boolean"},"batchId":{"anyOf":[{"$ref":"#/components/schemas/CodeBatchId"},{"type":"null"}]},"source":{"type":"string","enum":["batch","popup"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["code","usageLimit","timesUsed","assignedEmail","disabled","batchId","source","createdAt","lastUsedAt"],"additionalProperties":false},"DiscountCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disabled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","active","scheduled","expired","disabled"],"additionalProperties":false},"DiscountId":{"type":"string","pattern":"^dsc_[0-9a-hjkmnp-tv-z]{20}$"},"DiscountKind":{"type":"string","enum":["code","automatic"]},"DiscountRule":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"standard"}},"required":["type"],"additionalProperties":false},{"$ref":"#/components/schemas/BogoRule"},{"$ref":"#/components/schemas/TieredRule"},{"$ref":"#/components/schemas/DurationBonusRule"}]},"DiscountScope":{"type":"string","enum":["all","products","collections","categories"]},"DiscountStatus":{"type":"string","enum":["active","scheduled","expired","disabled","used_up"]},"DiscountTier":{"type":"object","properties":{"threshold":{"type":"integer","minimum":1,"maximum":100000000},"percentBps":{"type":"integer","minimum":1,"maximum":10000}},"required":["threshold","percentBps"],"additionalProperties":false},"DiscountValueType":{"type":"string","enum":["percent","fixed","free"]},"DisputeActions":{"type":"object","properties":{"message":{"type":"boolean"},"escalate":{"type":"boolean"},"refresh":{"type":"boolean"}},"required":["message","escalate","refresh"],"additionalProperties":false},"DisputeCounts":{"type":"object","properties":{"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"needsResponse":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"underReview":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"won":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lost":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"claims":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["open","needsResponse","underReview","won","lost","claims","all"],"additionalProperties":false},"DisputeDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DisputeId"},"kind":{"$ref":"#/components/schemas/DisputeKind"},"source":{"$ref":"#/components/schemas/DisputeSource"},"status":{"$ref":"#/components/schemas/DisputeStatus"},"reason":{"$ref":"#/components/schemas/DisputeReason"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"customerName":{"type":"string"},"customerEmail":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"feeMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"providerDisputeId":{"type":["string","null"]},"dueAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"resolution":{"anyOf":[{"$ref":"#/components/schemas/ClaimResolution"},{"type":"null"}]},"openedAt":{"$ref":"#/components/schemas/Timestamp"},"closedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"stage":{"default":null,"anyOf":[{"$ref":"#/components/schemas/DisputeStage"},{"type":"null"}]},"buyerMessage":{"type":["string","null"]},"evidence":{"$ref":"#/components/schemas/DisputeEvidence"},"events":{"type":"array","items":{"$ref":"#/components/schemas/DisputeEvent"}},"ledger":{"type":"object","properties":{"heldMinor":{"$ref":"#/components/schemas/MinorUnits"},"returnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"lostMinor":{"$ref":"#/components/schemas/MinorUnits"},"feeMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["heldMinor","returnedMinor","lostMinor","feeMinor"],"additionalProperties":false},"orderStatus":{"$ref":"#/components/schemas/OrderStatus"},"isTest":{"type":"boolean"},"actions":{"default":{"message":false,"escalate":false,"refresh":false},"$ref":"#/components/schemas/DisputeActions"},"buyerBlocked":{"default":false,"type":"boolean"}},"required":["id","kind","source","status","reason","orderId","orderNumber","customerId","customerName","customerEmail","amountMinor","feeMinor","currency","provider","providerDisputeId","dueAt","resolution","openedAt","closedAt","stage","buyerMessage","evidence","events","ledger","orderStatus","isTest","actions","buyerBlocked"],"additionalProperties":false},"DisputeEvent":{"type":"object","properties":{"id":{"type":"string"},"kind":{"$ref":"#/components/schemas/DisputeEventKind"},"detail":{"type":"string"},"actor":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","detail","actor","createdAt"],"additionalProperties":false},"DisputeEventKind":{"type":"string","enum":["opened","status","message_buyer","message_seller","evidence_saved","evidence_submitted","ledger","note","resolved","message_processor","escalated","blocked"]},"DisputeEvidence":{"type":"object","properties":{"order":{"type":"object","properties":{"number":{"type":"string"},"placedAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unitPriceMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["name","type","quantity","unitPriceMinor"],"additionalProperties":false}}},"required":["number","placedAt","paidAt","totalMinor","currency","paymentMethod","items"],"additionalProperties":false},"customer":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"country":{"type":"string"},"ip":{"type":["string","null"]},"ipCountry":{"type":["string","null"]},"priorOrders":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","email","country","ip","ipCountry","priorOrders"],"additionalProperties":false},"delivery":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryProof"}},"text":{"$ref":"#/components/schemas/EvidenceText"},"complete":{"type":"boolean"},"checklist":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"done":{"type":"boolean"}},"required":["label","done"],"additionalProperties":false}},"submittedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["order","customer","delivery","text","complete","checklist","submittedAt"],"additionalProperties":false},"DisputeId":{"type":"string","pattern":"^dsp_[0-9a-hjkmnp-tv-z]{20}$"},"DisputeKind":{"type":"string","enum":["chargeback","claim"]},"DisputeReason":{"type":"string","enum":["fraudulent","not_received","not_as_described","not_working","duplicate","unrecognized","credit_not_processed","subscription_canceled","wrong_item","general","other"]},"DisputeRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DisputeId"},"kind":{"$ref":"#/components/schemas/DisputeKind"},"source":{"$ref":"#/components/schemas/DisputeSource"},"status":{"$ref":"#/components/schemas/DisputeStatus"},"reason":{"$ref":"#/components/schemas/DisputeReason"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"customerName":{"type":"string"},"customerEmail":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"feeMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"providerDisputeId":{"type":["string","null"]},"dueAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"resolution":{"anyOf":[{"$ref":"#/components/schemas/ClaimResolution"},{"type":"null"}]},"openedAt":{"$ref":"#/components/schemas/Timestamp"},"closedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"stage":{"default":null,"anyOf":[{"$ref":"#/components/schemas/DisputeStage"},{"type":"null"}]}},"required":["id","kind","source","status","reason","orderId","orderNumber","customerId","customerName","customerEmail","amountMinor","feeMinor","currency","provider","providerDisputeId","dueAt","resolution","openedAt","closedAt","stage"],"additionalProperties":false},"DisputeSettings":{"type":"object","properties":{"autoBlockOnChargeback":{"default":false,"type":"boolean"}},"required":["autoBlockOnChargeback"],"additionalProperties":false},"DisputeSource":{"type":"string","enum":["stripe","paypal","sandbox","buyer"]},"DisputeStage":{"type":"string","enum":["inquiry","claim","appeal"]},"DisputeStatus":{"type":"string","enum":["needs_response","under_review","won","lost","open","resolved"]},"DividerBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"divider"},"spacing":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","spacing"],"additionalProperties":false},"DmConsentStatus":{"type":"string","enum":["subscribed","unsubscribed"]},"DmKind":{"type":"string","enum":["delivery","flow","test"]},"DmMinuteOfDay":{"type":"integer","minimum":0,"maximum":1439},"DmPreference":{"type":"object","properties":{"storeName":{"type":"string"},"username":{"type":["string","null"]},"status":{"anyOf":[{"$ref":"#/components/schemas/DmConsentStatus"},{"type":"null"}]}},"required":["storeName","username","status"],"additionalProperties":false},"DmStatus":{"type":"string","enum":["queued","sent","simulated","skipped","failed"]},"DnsHost":{"type":"string","enum":["cloudflare","godaddy","namecheap","squarespace","porkbun","hostinger","other"]},"DnsRecord":{"type":"object","properties":{"type":{"type":"string","enum":["CNAME","TXT","A","ALIAS"]},"name":{"type":"string"},"host":{"type":"string"},"value":{"type":"string"},"purpose":{"$ref":"#/components/schemas/DnsRecordPurpose"},"satisfied":{"type":"boolean"},"note":{"type":["string","null"]}},"required":["type","name","host","value","purpose","satisfied","note"],"additionalProperties":false},"DnsRecordId":{"type":"string","pattern":"^[0-9a-f]{32}$"},"DnsRecordPurpose":{"type":"string","enum":["routing","ownership","certificate"]},"DocumentLink":{"type":"object","properties":{"url":{"type":"string"},"filename":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["url","filename","expiresAt"],"additionalProperties":false},"DomainDns":{"type":"object","properties":{"pointed":{"type":"boolean"},"via":{"anyOf":[{"type":"string","enum":["cname","flattened"]},{"type":"null"}]},"cname":{"type":["string","null"]},"addresses":{"type":"array","items":{"type":"string"}},"proxied":{"type":"boolean"},"host":{"$ref":"#/components/schemas/DnsHost"},"nameservers":{"type":"array","items":{"type":"string"}},"checkedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["pointed","via","cname","addresses","proxied","host","nameservers","checkedAt"],"additionalProperties":false},"DomainId":{"type":"string","pattern":"^dom_[0-9a-hjkmnp-tv-z]{20}$"},"DomainMode":{"type":"string","enum":["cname","nameservers"]},"DomainNameservers":{"type":"object","properties":{"assigned":{"type":"array","items":{"type":"string"}},"current":{"type":"array","items":{"type":"string"}},"registrar":{"type":["string","null"]},"switched":{"type":"boolean"},"storefrontReady":{"type":"boolean"}},"required":["assigned","current","registrar","switched","storefrontReady"],"additionalProperties":false},"DomainReadiness":{"type":"object","properties":{"provider":{"type":"string","enum":["cloudflare","simulated","unconfigured"]},"ready":{"type":"boolean"},"cnameTarget":{"type":"string"},"fallbackOrigin":{"type":"object","properties":{"origin":{"type":["string","null"]},"status":{"type":["string","null"]},"errors":{"type":"array","items":{"type":"string"}}},"required":["origin","status","errors"],"additionalProperties":false},"nameserverMode":{"type":"boolean"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/DomainReadinessCheck"}},"checkedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["provider","ready","cnameTarget","fallbackOrigin","nameserverMode","checks","checkedAt"],"additionalProperties":false},"DomainReadinessCheck":{"type":"object","properties":{"id":{"type":"string","enum":["token","saas","fallback_origin","nameservers","origin_ips"]},"label":{"type":"string"},"state":{"type":"string","enum":["ok","warn","fail","off"]},"detail":{"type":"string"}},"required":["id","label","state","detail"],"additionalProperties":false},"DomainStatus":{"type":"string","enum":["pending","active","moved","failed"]},"DomainsOverview":{"type":"object","properties":{"platformHost":{"type":"string"},"primaryHost":{"type":"string"},"primaryUrl":{"type":"string"},"cnameTarget":{"type":"string"},"provider":{"type":"string","enum":["cloudflare","simulated","unconfigured"]},"nameserverMode":{"type":"boolean"},"customHostnamesReady":{"default":true,"type":"boolean"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"domains":{"type":"array","items":{"$ref":"#/components/schemas/CustomDomain"}}},"required":["platformHost","primaryHost","primaryUrl","cnameTarget","provider","nameserverMode","customHostnamesReady","limit","domains"],"additionalProperties":false},"DuplicateCandidate":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/DuplicateReason"},"customers":{"minItems":2,"maxItems":2,"type":"array","items":{"$ref":"#/components/schemas/CustomerRow"}}},"required":["reason","customers"],"additionalProperties":false},"DuplicateReason":{"type":"string","enum":["same_name","same_mailbox"]},"DurationBonusRule":{"type":"object","properties":{"type":{"type":"string","const":"duration_bonus"},"from":{"$ref":"#/components/schemas/DurationKey"},"bonus":{"$ref":"#/components/schemas/DurationKey"}},"required":["type","from","bonus"],"additionalProperties":false},"DurationKey":{"type":"string","enum":["1d","3d","7d","14d","30d","90d","180d","365d","lifetime"]},"DynamicDeliverySettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"url":{"anyOf":[{"$ref":"#/components/schemas/HttpsUrl"},{"type":"null"}]},"secretVersion":{"type":"integer","minimum":1,"maximum":1000000}},"required":["enabled","url","secretVersion"],"additionalProperties":false},"EconomyAdjustmentKind":{"type":"string","enum":["refund","partial_refund","dispute_opened","dispute_won","dispute_lost"]},"EconomyAdjustmentRow":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"journalKey":{"type":"string"},"kind":{"$ref":"#/components/schemas/EconomyAdjustmentKind"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"at":{"$ref":"#/components/schemas/Timestamp"},"cashOutMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"feeReturnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxReturnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"sellerMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["storeId","storeName","storeHandle","journalKey","kind","orderId","orderNumber","paymentModel","at","cashOutMinor","feeReturnedMinor","taxReturnedMinor","sellerMinor"],"additionalProperties":false},"EconomyAdjustments":{"type":"object","properties":{"window":{"$ref":"#/components/schemas/EconomyWindow"},"totals":{"type":"object","properties":{"refunds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cashOutMinor":{"$ref":"#/components/schemas/MinorUnits"},"feeReturnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxReturnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"sellerMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["refunds","disputes","cashOutMinor","feeReturnedMinor","taxReturnedMinor","sellerMinor"],"additionalProperties":false},"series":{"type":"array","items":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"feeReturnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"cashOutMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["start","feeReturnedMinor","cashOutMinor"],"additionalProperties":false}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/EconomyAdjustmentRow"}},"truncated":{"type":"boolean"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/EconomyCheck"}}},"required":["window","totals","series","rows","truncated","checks"],"additionalProperties":false},"EconomyAiCredits":{"type":"object","properties":{"window":{"$ref":"#/components/schemas/EconomyWindow"},"totals":{"type":"object","properties":{"topUpsMinor":{"$ref":"#/components/schemas/MinorUnits"},"topUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"testTopUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"testTopUpsMinor":{"$ref":"#/components/schemas/MinorUnits"},"unpaidTopUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"balanceMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"reservedMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"storesWithBalance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"usageMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"modelCostMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"marginMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"transfersMinor":{"$ref":"#/components/schemas/MinorUnits"},"transfers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"grantedMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"promoUsageMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"promoBalanceMicroUsd":{"$ref":"#/components/schemas/MicroUsd"}},"required":["topUpsMinor","topUps","stores","testTopUps","testTopUpsMinor","unpaidTopUps","balanceMicroUsd","reservedMicroUsd","storesWithBalance","usageMicroUsd","modelCostMicroUsd","marginMicroUsd","transfersMinor","transfers","grantedMicroUsd","promoUsageMicroUsd","promoBalanceMicroUsd"],"additionalProperties":false},"rollForward":{"type":"object","properties":{"openingMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"topUpsMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"transfersMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"grantsMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"spentMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"adjustmentsMicroUsd":{"$ref":"#/components/schemas/MicroUsd"},"closingMicroUsd":{"$ref":"#/components/schemas/MicroUsd"}},"required":["openingMicroUsd","topUpsMicroUsd","transfersMicroUsd","grantsMicroUsd","spentMicroUsd","adjustmentsMicroUsd","closingMicroUsd"],"additionalProperties":false},"series":{"type":"array","items":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"topUpsMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["start","topUpsMinor"],"additionalProperties":false}},"topUps":{"type":"array","items":{"$ref":"#/components/schemas/EconomyAiTopUpRow"}},"truncated":{"type":"boolean"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/EconomyCheck"}}},"required":["window","totals","rollForward","series","topUps","truncated","checks"],"additionalProperties":false},"EconomyAiTopUpRow":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"id":{"$ref":"#/components/schemas/AiTopUpId"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"status":{"$ref":"#/components/schemas/AiTopUpStatus"},"test":{"type":"boolean"},"methodLabel":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"balanceMicroUsd":{"$ref":"#/components/schemas/MicroUsd"}},"required":["storeId","storeName","storeHandle","id","amountMinor","status","test","methodLabel","createdAt","paidAt","balanceMicroUsd"],"additionalProperties":false},"EconomyBucket":{"type":"string","enum":["hour","day","week"]},"EconomyCheck":{"type":"object","properties":{"name":{"type":"string"},"ok":{"type":"boolean"},"expectedMinor":{"$ref":"#/components/schemas/MinorUnits"},"actualMinor":{"$ref":"#/components/schemas/MinorUnits"},"detail":{"type":"string"}},"required":["name","ok","expectedMinor","actualMinor","detail"],"additionalProperties":false},"EconomyCommission":{"type":"object","properties":{"window":{"$ref":"#/components/schemas/EconomyWindow"},"lines":{"type":"object","properties":{"morFeesMinor":{"$ref":"#/components/schemas/MinorUnits"},"ownGatewayFeesMinor":{"$ref":"#/components/schemas/MinorUnits"},"payoutFeesMinor":{"$ref":"#/components/schemas/MinorUnits"},"refundsMinor":{"$ref":"#/components/schemas/MinorUnits"},"disputesMinor":{"$ref":"#/components/schemas/MinorUnits"},"referralsMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"otherMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["morFeesMinor","ownGatewayFeesMinor","payoutFeesMinor","refundsMinor","disputesMinor","referralsMinor","otherMinor","netMinor"],"additionalProperties":false},"components":{"type":"object","properties":{"commissionMinor":{"$ref":"#/components/schemas/MinorUnits"},"fixedFeeMinor":{"$ref":"#/components/schemas/MinorUnits"},"morSurchargeMinor":{"$ref":"#/components/schemas/MinorUnits"},"capMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["commissionMinor","fixedFeeMinor","morSurchargeMinor","capMinor"],"additionalProperties":false},"ownGateway":{"type":"object","properties":{"collectedMinor":{"$ref":"#/components/schemas/MinorUnits"},"notCollectedMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["collectedMinor","notCollectedMinor"],"additionalProperties":false},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"gmvMinor":{"$ref":"#/components/schemas/MinorUnits"},"takeRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processorCostMinor":{"$ref":"#/components/schemas/MinorUnits"},"series":{"type":"array","items":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"feesMinor":{"$ref":"#/components/schemas/MinorUnits"},"returnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["start","feesMinor","returnedMinor","netMinor"],"additionalProperties":false}},"stores":{"type":"array","items":{"$ref":"#/components/schemas/EconomyCommissionStoreRow"}},"truncated":{"type":"boolean"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/EconomyCheck"}}},"required":["window","lines","components","ownGateway","orders","gmvMinor","takeRateBps","processorCostMinor","series","stores","truncated","checks"],"additionalProperties":false},"EconomyCommissionStoreRow":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"planName":{"type":"string"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"gmvMinor":{"$ref":"#/components/schemas/MinorUnits"},"salesFeesMinor":{"$ref":"#/components/schemas/MinorUnits"},"payoutFeesMinor":{"$ref":"#/components/schemas/MinorUnits"},"returnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"takeRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"notCollectedMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["storeId","storeName","storeHandle","planName","paymentModel","orders","gmvMinor","salesFeesMinor","payoutFeesMinor","returnedMinor","netMinor","takeRateBps","notCollectedMinor"],"additionalProperties":false},"EconomyCompRow":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"listPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"reason":{"type":["string","null"]},"endsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"grantedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"grantedBy":{"type":["string","null"]},"review":{"type":"boolean"}},"required":["storeId","storeName","storeHandle","planId","planName","listPriceMinor","reason","endsAt","grantedAt","grantedBy","review"],"additionalProperties":false},"EconomyOwed":{"type":"object","properties":{"window":{"$ref":"#/components/schemas/EconomyWindow"},"asOf":{"$ref":"#/components/schemas/Timestamp"},"totals":{"type":"object","properties":{"clearingMinor":{"$ref":"#/components/schemas/MinorUnits"},"availableMinor":{"$ref":"#/components/schemas/MinorUnits"},"reserveMinor":{"$ref":"#/components/schemas/MinorUnits"},"disputeHoldMinor":{"$ref":"#/components/schemas/MinorUnits"},"inFlightMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["clearingMinor","availableMinor","reserveMinor","disputeHoldMinor","inFlightMinor","totalMinor","stores"],"additionalProperties":false},"blocked":{"default":{"stores":0,"heldMinor":0},"type":"object","properties":{"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"heldMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["stores","heldMinor"],"additionalProperties":false},"paid":{"type":"object","properties":{"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"feesMinor":{"$ref":"#/components/schemas/MinorUnits"},"payouts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["paidMinor","feesMinor","payouts","failed"],"additionalProperties":false},"schedule":{"type":"object","properties":{"payoutSchedule":{"type":"string","enum":["daily","weekly","monthly"]},"payoutWeekday":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"holdDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minimumMinor":{"$ref":"#/components/schemas/MinorUnits"},"nextRunAt":{"$ref":"#/components/schemas/Timestamp"},"nextArrivalDate":{"$ref":"#/components/schemas/IsoDate"},"dueMinor":{"$ref":"#/components/schemas/MinorUnits"},"dueStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["payoutSchedule","payoutWeekday","holdDays","minimumMinor","nextRunAt","nextArrivalDate","dueMinor","dueStores"],"additionalProperties":false},"series":{"type":"array","items":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["start","paidMinor"],"additionalProperties":false}},"stores":{"type":"array","items":{"$ref":"#/components/schemas/EconomyOwedStoreRow"}},"truncated":{"type":"boolean"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/EconomyCheck"}}},"required":["window","asOf","totals","blocked","paid","schedule","series","stores","truncated","checks"],"additionalProperties":false},"EconomyOwedStoreRow":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"clearingMinor":{"$ref":"#/components/schemas/MinorUnits"},"availableMinor":{"$ref":"#/components/schemas/MinorUnits"},"reserveMinor":{"$ref":"#/components/schemas/MinorUnits"},"disputeHoldMinor":{"$ref":"#/components/schemas/MinorUnits"},"inFlightMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"lastPaidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"nextPayout":{"anyOf":[{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["date","amountMinor"],"additionalProperties":false},{"type":"null"}]},"nextPayoutBlocked":{"anyOf":[{"$ref":"#/components/schemas/NextPayoutBlock"},{"type":"null"}]},"leftPay":{"default":false,"type":"boolean"}},"required":["storeId","storeName","storeHandle","paymentModel","clearingMinor","availableMinor","reserveMinor","disputeHoldMinor","inFlightMinor","totalMinor","paidMinor","lastPaidAt","nextPayout","nextPayoutBlocked","leftPay"],"additionalProperties":false},"EconomyPlanInvoiceRow":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"id":{"$ref":"#/components/schemas/PlanInvoiceId"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"reason":{"type":"string","enum":["upgrade","renewal"]},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"invoiceStatus":{"$ref":"#/components/schemas/PlanInvoiceStatus"},"paidVia":{"anyOf":[{"$ref":"#/components/schemas/PlanInvoicePaidVia"},{"type":"null"}]},"periodStart":{"$ref":"#/components/schemas/Timestamp"},"periodEnd":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"subscription":{"$ref":"#/components/schemas/SubscriptionStatus"}},"required":["storeId","storeName","storeHandle","id","planId","planName","reason","amountMinor","invoiceStatus","paidVia","periodStart","periodEnd","paidAt","createdAt","subscription"],"additionalProperties":false},"EconomyPlanRow":{"type":"object","properties":{"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"monthlyPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"payingStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mrrMinor":{"$ref":"#/components/schemas/MinorUnits"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["planId","planName","monthlyPriceMinor","payingStores","mrrMinor","revenueMinor"],"additionalProperties":false},"EconomySubscriptions":{"type":"object","properties":{"window":{"$ref":"#/components/schemas/EconomyWindow"},"totals":{"type":"object","properties":{"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidInvoices":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"newMinor":{"$ref":"#/components/schemas/MinorUnits"},"renewalMinor":{"$ref":"#/components/schemas/MinorUnits"},"viaBalanceMinor":{"$ref":"#/components/schemas/MinorUnits"},"viaAdminMinor":{"$ref":"#/components/schemas/MinorUnits"},"viaCardMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"openMinor":{"$ref":"#/components/schemas/MinorUnits"},"openInvoices":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mrrMinor":{"$ref":"#/components/schemas/MinorUnits"},"payingStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pastDueStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"assignedStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"compedStores":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"compedListMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["revenueMinor","paidInvoices","newMinor","renewalMinor","viaBalanceMinor","viaAdminMinor","viaCardMinor","openMinor","openInvoices","mrrMinor","payingStores","pastDueStores","assignedStores","compedStores","compedListMinor"],"additionalProperties":false},"comps":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/EconomyCompRow"}},"byPlan":{"type":"array","items":{"$ref":"#/components/schemas/EconomyPlanRow"}},"series":{"type":"array","items":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"mrrMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["start","revenueMinor","mrrMinor"],"additionalProperties":false}},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/EconomyPlanInvoiceRow"}},"truncated":{"type":"boolean"}},"required":["window","totals","comps","byPlan","series","invoices","truncated"],"additionalProperties":false},"EconomyWindow":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"bucket":{"$ref":"#/components/schemas/EconomyBucket"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"defaultCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyCode"}},"generatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["from","to","bucket","currency","defaultCurrency","currencies","generatedAt"],"additionalProperties":false},"EffectiveMethodLimits":{"type":"object","properties":{"methods":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/LimitedMethod"},"additionalProperties":{"$ref":"#/components/schemas/MethodLimit"}},"newBuyerCardMaxMinor":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"default":"USD","$ref":"#/components/schemas/CurrencyCode"}},"required":["methods","newBuyerCardMaxMinor","currency"],"additionalProperties":false},"ElementSelector":{"type":"string","minLength":1,"maxLength":300,"pattern":"^[A-Za-z0-9 >.#:_()-]+$"},"Email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"EmailBlock":{"oneOf":[{"$ref":"#/components/schemas/HeadingBlock"},{"$ref":"#/components/schemas/TextBlock"},{"$ref":"#/components/schemas/ButtonBlock"},{"$ref":"#/components/schemas/ImageBlock"},{"$ref":"#/components/schemas/ProductBlock"},{"$ref":"#/components/schemas/OrderSummaryBlock"},{"$ref":"#/components/schemas/KeysBlock"},{"$ref":"#/components/schemas/DividerBlock"},{"$ref":"#/components/schemas/SpacerBlock"},{"$ref":"#/components/schemas/ColumnsBlock"},{"$ref":"#/components/schemas/SocialBlock"},{"$ref":"#/components/schemas/FooterBlock"},{"$ref":"#/components/schemas/HtmlBlock"}]},"EmailBranding":{"type":"object","properties":{"storeName":{"type":"string"},"logoUrl":{"type":["string","null"]},"brandColor":{"type":"string"},"supportEmail":{"type":["string","null"]},"address":{"type":"string"},"storeUrl":{"type":"string"},"assetBase":{"type":["string","null"]}},"required":["storeName","logoUrl","brandColor","supportEmail","address","storeUrl"],"additionalProperties":false},"EmailCategory":{"type":"string","enum":["newsletter","promotions","product_updates","reminders"]},"EmailDocument":{"type":"object","properties":{"version":{"default":1,"type":"number","const":1},"subject":{"type":"string","minLength":1,"maxLength":200},"preheader":{"default":"","type":"string","maxLength":200},"style":{"default":{"accent":null,"background":"#f4f4f7","surface":"#ffffff","text":"#171724","muted":"#6b6c78","border":"#e6e6ec","buttonText":"#ffffff","radius":12,"buttonRadius":10,"font":"system","width":600,"showLogo":true,"accentBar":true},"$ref":"#/components/schemas/EmailStyle"},"blocks":{"maxItems":80,"type":"array","items":{"$ref":"#/components/schemas/EmailBlock"}}},"required":["version","subject","preheader","style","blocks"],"additionalProperties":false},"EmailFont":{"type":"string","enum":["system","humanist","geometric","serif","mono"]},"EmailKind":{"type":"string","enum":["receipt","review_request","claim_update","dispute_notice","affiliate_welcome","reseller_update","other","review_reward"]},"EmailLogEntry":{"type":"object","properties":{"id":{"type":"string"},"kind":{"$ref":"#/components/schemas/EmailKind"},"to":{"type":"string"},"subject":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","to","subject","orderId","orderNumber","createdAt"],"additionalProperties":false},"EmailPreferences":{"type":"object","properties":{"storeName":{"type":"string"},"email":{"type":"string"},"status":{"$ref":"#/components/schemas/ConsentStatus"},"categories":{"$ref":"#/components/schemas/CategoryPrefs"},"storeUrl":{"type":"string"}},"required":["storeName","email","status","categories","storeUrl"],"additionalProperties":false},"EmailStyle":{"type":"object","properties":{"accent":{"default":null,"anyOf":[{"$ref":"#/components/schemas/HexColor"},{"type":"null"}]},"background":{"default":"#f4f4f7","$ref":"#/components/schemas/HexColor"},"surface":{"default":"#ffffff","$ref":"#/components/schemas/HexColor"},"text":{"default":"#171724","$ref":"#/components/schemas/HexColor"},"muted":{"default":"#6b6c78","$ref":"#/components/schemas/HexColor"},"border":{"default":"#e6e6ec","$ref":"#/components/schemas/HexColor"},"buttonText":{"default":"#ffffff","$ref":"#/components/schemas/HexColor"},"radius":{"default":12,"type":"integer","minimum":0,"maximum":28},"buttonRadius":{"default":10,"type":"integer","minimum":0,"maximum":28},"font":{"default":"system","$ref":"#/components/schemas/EmailFont"},"width":{"default":600,"type":"integer","minimum":480,"maximum":720},"showLogo":{"default":true,"type":"boolean"},"accentBar":{"default":true,"type":"boolean"}},"required":["accent","background","surface","text","muted","border","buttonText","radius","buttonRadius","font","width","showLogo","accentBar"],"additionalProperties":false},"EmailTemplate":{"type":"object","properties":{"enabled":{"type":"boolean"},"subject":{"type":"string","minLength":1,"maxLength":200},"heading":{"type":"string","maxLength":200},"body":{"type":"string","maxLength":10000},"buttonLabel":{"type":"string","maxLength":60},"footer":{"type":"string","maxLength":1000},"kind":{"$ref":"#/components/schemas/EmailTemplateKind"},"name":{"type":"string"},"trigger":{"type":"string"},"customized":{"type":"boolean"},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"sent30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["enabled","subject","heading","body","buttonLabel","footer","kind","name","trigger","customized","updatedAt","sent30d"],"additionalProperties":false},"EmailTemplateKind":{"type":"string","enum":["receipt","download_ready","license_key","subscription_renewed","subscription_cancelled","review_request","abandoned_checkout","otp","subscription_renewal_due","subscription_payment_failed","subscription_action_required","subscription_renewal_paused","ticket_received","ticket_reply","ticket_solved","subscribe_confirm","status_update","back_in_stock","payment_waiting","payment_reminder","payment_expired","payment_declined"]},"EmailVersion":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/EmailVersionId"},"label":{"type":"string"},"authorName":{"type":"string"},"subject":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","label","authorName","subject","createdAt"],"additionalProperties":false},"EmailVersionId":{"type":"string","pattern":"^ever_[0-9a-hjkmnp-tv-z]{20}$"},"EmailsOverview":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplate"}},"branding":{"$ref":"#/components/schemas/EmailBranding"},"delivery":{"type":"string","enum":["resend","console"]},"from":{"type":"string"}},"required":["templates","branding","delivery","from"],"additionalProperties":false},"EmbedOrigin":{"type":"string","maxLength":200,"pattern":"^https:\\/\\/[a-z0-9.-]+(?::\\d{1,5})?$|^http:\\/\\/(?:localhost|127\\.0\\.0\\.1)(?::\\d{1,5})?$"},"EmbedSettings":{"type":"object","properties":{"allowedOrigins":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/EmbedOrigin"}}},"required":["allowedOrigins"],"additionalProperties":false},"EndImpersonationResponse":{"type":"object","properties":{"returnUrl":{"type":["string","null"]}},"required":["returnUrl"],"additionalProperties":false},"ErrorApp":{"type":"string","enum":["dashboard","admin","storefront","api","worker"]},"ErrorGroup":{"type":"object","properties":{"fingerprint":{"type":"string"},"app":{"$ref":"#/components/schemas/ErrorApp"},"kind":{"$ref":"#/components/schemas/ErrorKind"},"message":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reports":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"firstSeen":{"$ref":"#/components/schemas/Timestamp"},"lastSeen":{"$ref":"#/components/schemas/Timestamp"},"latestId":{"$ref":"#/components/schemas/ErrorReportId"},"latestPath":{"type":"string"},"latestRelease":{"type":"string"},"releases":{"type":"array","items":{"type":"string"}},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["fingerprint","app","kind","message","count","reports","stores","firstSeen","lastSeen","latestId","latestPath","latestRelease","releases","status"],"additionalProperties":false},"ErrorKind":{"type":"string","enum":["error","rejection","render","router","chunk","api","island","server","job"]},"ErrorOccurrence":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ErrorReportId"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"path":{"type":"string"},"release":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"storeId":{"anyOf":[{"$ref":"#/components/schemas/StoreId"},{"type":"null"}]},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"visible":{"type":["boolean","null"]}},"required":["id","createdAt","path","release","count","storeId","status","visible"],"additionalProperties":false},"ErrorReport":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ErrorReportId"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"app":{"$ref":"#/components/schemas/ErrorApp"},"kind":{"$ref":"#/components/schemas/ErrorKind"},"fingerprint":{"type":"string"},"message":{"type":"string"},"stack":{"type":["string","null"]},"componentStack":{"type":["string","null"]},"path":{"type":"string"},"prevPath":{"type":["string","null"]},"release":{"type":"string"},"userAgent":{"type":["string","null"]},"viewport":{"type":["string","null"]},"sinceLoadMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"visible":{"type":["boolean","null"]},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"storeId":{"anyOf":[{"$ref":"#/components/schemas/StoreId"},{"type":"null"}]},"userId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"sessionId":{"type":["string","null"]},"requestId":{"type":["string","null"]},"method":{"type":["string","null"]},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","createdAt","app","kind","fingerprint","message","stack","componentStack","path","prevPath","release","userAgent","viewport","sinceLoadMs","visible","count","storeId","userId","sessionId","requestId","method","status"],"additionalProperties":false},"ErrorReportId":{"type":"string","pattern":"^err_[0-9a-hjkmnp-tv-z]{20}$"},"EstimateAudienceResponse":{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false},"EvidenceKind":{"type":"string","enum":["payment","delivered","email_sent","download","key_reveal","order_page_view","checkout"]},"EvidenceText":{"type":"object","properties":{"productDescription":{"default":"","type":"string","maxLength":5000},"refundPolicy":{"default":"","type":"string","maxLength":5000},"customerCommunication":{"default":"","type":"string","maxLength":10000},"refusalExplanation":{"default":"","type":"string","maxLength":5000},"additionalNotes":{"default":"","type":"string","maxLength":10000}},"required":["productDescription","refundPolicy","customerCommunication","refusalExplanation","additionalNotes"],"additionalProperties":false},"ExchangeImpersonationResponse":{"type":"object","properties":{"storeId":{"anyOf":[{"$ref":"#/components/schemas/StoreId"},{"type":"null"}]}},"required":["storeId"],"additionalProperties":false},"ExplorerEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"deliveries":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"succeeded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"summary":{"type":"string"}},"required":["id","type","createdAt","deliveries","succeeded","failed","summary"],"additionalProperties":false},"ExplorerEventDetail":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"deliveries":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"succeeded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"summary":{"type":"string"},"body":{"type":"string"},"attempts":{"type":"array","items":{"type":"object","properties":{"deliveryId":{"type":"string"},"endpointId":{"$ref":"#/components/schemas/WebhookEndpointId"},"url":{"type":"string"},"status":{"type":"string"},"lastResponseStatus":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["deliveryId","endpointId","url","status","lastResponseStatus","at"],"additionalProperties":false}}},"required":["id","type","createdAt","deliveries","succeeded","failed","summary","body","attempts"],"additionalProperties":false},"ExportContactsResponse":{"type":"object","properties":{"csv":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["csv","count"],"additionalProperties":false},"ExportFraudListResponse":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filename","csv","rows"],"additionalProperties":false},"ExportProductsResponse":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"}},"required":["filename","csv"],"additionalProperties":false},"ExportStoreAuditJsonResponse":{"type":"object","properties":{"filename":{"type":"string"},"json":{"type":"string"},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filename","json","rows"],"additionalProperties":false},"ExportStoreAuditResponse":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filename","csv","rows"],"additionalProperties":false},"FailoverRestore":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"kind":{"$ref":"#/components/schemas/PaymentFailureKind"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"null"}]},"message":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"address":{"anyOf":[{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"}},"required":["line1","line2","city","region","postalCode"],"additionalProperties":false},{"type":"null"}]},"customFields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"marketingOptIn":{"type":"boolean"},"consent":{"type":"boolean"},"withdrawalWaiver":{"default":false,"type":"boolean"},"tipMinor":{"$ref":"#/components/schemas/MinorUnits"},"tried":{"type":"array","items":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"null"}]}},"required":["provider","method"],"additionalProperties":false}}},"required":["sessionId","kind","provider","method","message","email","name","country","phone","address","customFields","marketingOptIn","consent","withdrawalWaiver","tipMinor","tried"],"additionalProperties":false},"FailoverSettings":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"triggers":{"default":["declined","provider_error","outage","risk_declined"],"maxItems":4,"type":"array","items":{"$ref":"#/components/schemas/PaymentFailureKind"}},"methods":{"default":[],"maxItems":40,"type":"array","items":{"$ref":"#/components/schemas/MethodKey"}},"breakerThreshold":{"default":3,"type":"integer","minimum":2,"maximum":20},"breakerCooldownMinutes":{"default":10,"type":"integer","minimum":1,"maximum":240},"alertSeller":{"default":true,"type":"boolean"}},"required":["enabled","triggers","methods","breakerThreshold","breakerCooldownMinutes","alertSeller"],"additionalProperties":false},"FaqBotSettings":{"type":"object","properties":{"greeting":{"default":"Hi! Questions before you buy?","type":"string","minLength":1,"maxLength":120},"items":{"default":[{"q":"How fast is delivery?","a":"Keys and files are delivered on the order page and by email the moment your payment goes through."},{"q":"Where do I find my key?","a":"Open the link in your receipt email, or sign in to your account to see every order."}],"minItems":1,"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/FaqPair"}},"contactLabel":{"default":"Contact us","type":"string","maxLength":40},"contactLink":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":300},{"type":"string","pattern":"^mailto:[^\\s<>\"']{3,200}$"}]},"position":{"default":"bottom-right","type":"string","enum":["bottom-left","bottom-right"]}},"required":["greeting","items","contactLabel","contactLink","position"],"additionalProperties":false},"FaqPair":{"type":"object","properties":{"q":{"type":"string","minLength":1,"maxLength":140},"a":{"type":"string","minLength":1,"maxLength":600}},"required":["q","a"],"additionalProperties":false},"FeatureFlagView":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/FeatureKey"},"label":{"type":"string"},"description":{"type":"string"},"enabledForAll":{"type":"boolean"},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"grants":{"type":"array","items":{"$ref":"#/components/schemas/FeatureGrant"}}},"required":["key","label","description","enabledForAll","updatedAt","grants"],"additionalProperties":false},"FeatureFlagsView":{"type":"object","properties":{"flags":{"type":"array","items":{"$ref":"#/components/schemas/FeatureFlagView"}}},"required":["flags"],"additionalProperties":false},"FeatureGrant":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FeatureGrantId"},"feature":{"$ref":"#/components/schemas/FeatureKey"},"target":{"$ref":"#/components/schemas/FeatureGrantTarget"},"label":{"type":"string"},"note":{"type":"string","maxLength":280},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"createdBy":{"anyOf":[{"$ref":"#/components/schemas/AdminUserId"},{"type":"null"}]}},"required":["id","feature","target","label","note","createdAt","createdBy"],"additionalProperties":false},"FeatureGrantId":{"type":"string","pattern":"^ffg_[0-9a-hjkmnp-tv-z]{20}$"},"FeatureGrantTarget":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"store"},"storeId":{"$ref":"#/components/schemas/StoreId"}},"required":["kind","storeId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"user"},"userId":{"$ref":"#/components/schemas/UserId"}},"required":["kind","userId"],"additionalProperties":false}]},"FeatureGroup":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":60},"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}}},"required":["title","items"],"additionalProperties":false},"FeatureKey":{"type":"string","enum":["licensing","email_marketing","leak_tracer","pricing_tiers"]},"FeeBreakdown":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"subtotalMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxRateBps":{"$ref":"#/components/schemas/Bps"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"commissionMinor":{"$ref":"#/components/schemas/MinorUnits"},"fixedFeeMinor":{"$ref":"#/components/schemas/MinorUnits"},"morSurchargeMinor":{"$ref":"#/components/schemas/MinorUnits"},"platformFeeMinor":{"$ref":"#/components/schemas/MinorUnits"},"processorFeeMinor":{"$ref":"#/components/schemas/MinorUnits"},"sellerNetMinor":{"$ref":"#/components/schemas/MinorUnits"},"platformNetMinor":{"$ref":"#/components/schemas/MinorUnits"},"tipMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"taxIncluded":{"type":"boolean"}},"required":["currency","paymentModel","subtotalMinor","discountMinor","netMinor","taxRateBps","taxMinor","totalMinor","commissionMinor","fixedFeeMinor","morSurchargeMinor","platformFeeMinor","processorFeeMinor","sellerNetMinor","platformNetMinor"],"additionalProperties":false},"FeeOverride":{"type":"object","properties":{"commissionBps":{"anyOf":[{"$ref":"#/components/schemas/Bps"},{"type":"null"}]},"fixedFeeMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"morSurchargeBps":{"anyOf":[{"$ref":"#/components/schemas/Bps"},{"type":"null"}]},"payoutFeeMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["commissionBps","fixedFeeMinor","morSurchargeBps","payoutFeeMinor"],"additionalProperties":false},"FeeSchedule":{"type":"object","properties":{"commissionBps":{"$ref":"#/components/schemas/Bps"},"fixedFeeMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"morSurchargeBps":{"$ref":"#/components/schemas/Bps"},"payoutFeeMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["commissionBps","fixedFeeMinor","morSurchargeBps","payoutFeeMinor"],"additionalProperties":false},"FeedEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"handle":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"title":{"type":"string"},"description":{"type":"string"},"coverUrl":{"type":["string","null"]},"available":{"type":"boolean"},"priceMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"compareAtMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["id","handle","type","title","description","coverUrl","available","priceMinor","compareAtMinor","currency"],"additionalProperties":false},"FeedPage":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/FeedEntry"}},"next":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"lastModified":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["entries","next","lastModified"],"additionalProperties":false},"FieldRequirement":{"type":"string","enum":["required","optional","hidden"]},"FileDeliverySettings":{"type":"object","properties":{"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"linkExpiryHours":{"anyOf":[{"type":"integer","minimum":1,"maximum":8760},{"type":"null"}]},"notifyOnUpdate":{"type":"boolean"}},"required":["downloadLimit","linkExpiryHours","notifyOnUpdate"],"additionalProperties":false},"FileExport":{"type":"object","properties":{"filename":{"type":"string"},"contentType":{"type":"string"},"body":{"type":"string"},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filename","contentType","body","rows"],"additionalProperties":false},"FileVersionId":{"type":"string","pattern":"^fv_[0-9a-hjkmnp-tv-z]{20}$"},"FillCannedReplyResponse":{"type":"object","properties":{"body":{"type":"string"}},"required":["body"],"additionalProperties":false},"FilterOp":{"type":"string","enum":["is","is_not","contains","not_contains","starts_with"]},"FinancialCsv":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filename","csv","rows"],"additionalProperties":false},"FinancialStatement":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"paymentModel":{"type":"string","enum":["merchant_of_record","seller_gateway"]},"statements":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyStatement"}},"generatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["period","paymentModel","statements","generatedAt"],"additionalProperties":false},"FindResellSupplierResponse":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/ResellStore"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ResellableProduct"}}},"required":["store","currency","products"],"additionalProperties":false},"Flow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlowId"},"kind":{"$ref":"#/components/schemas/FlowKind"},"name":{"type":"string"},"enabled":{"type":"boolean"},"category":{"$ref":"#/components/schemas/EmailCategory"},"steps":{"minItems":1,"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/FlowStep"}},"settings":{"$ref":"#/components/schemas/FlowSettings"},"stats":{"type":"object","properties":{"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"completed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["active","completed","sent","opened","clicked","orders","revenueMinor"],"additionalProperties":false},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","name","enabled","category","steps","settings","stats","updatedAt"],"additionalProperties":false},"FlowChannel":{"type":"string","enum":["email","discord_dm","both"]},"FlowId":{"type":"string","pattern":"^flow_[0-9a-hjkmnp-tv-z]{20}$"},"FlowKind":{"type":"string","enum":["welcome","abandoned_cart","post_purchase","win_back","key_expiry","review_request"]},"FlowSettings":{"type":"object","properties":{"inactiveDays":{"default":60,"type":"integer","minimum":7,"maximum":730},"durationOnly":{"default":true,"type":"boolean"},"requireConsent":{"default":true,"type":"boolean"}},"required":["inactiveDays","durationOnly","requireConsent"],"additionalProperties":false},"FlowStep":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"delayMinutes":{"type":"integer","minimum":0,"maximum":525600},"doc":{"$ref":"#/components/schemas/EmailDocument"},"exitOnPurchase":{"default":true,"type":"boolean"},"channel":{"$ref":"#/components/schemas/FlowChannel"},"dm":{"type":"string","maxLength":1800}},"required":["id","delayMinutes","doc","exitOnPurchase"],"additionalProperties":false},"FooterBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"footer"},"text":{"type":"string","maxLength":1000},"showAddress":{"default":true,"type":"boolean"},"showUnsubscribe":{"default":true,"type":"boolean"},"align":{"default":"center","type":"string","enum":["left","center","right"]}},"required":["id","type","text","showAddress","showUnsubscribe","align"],"additionalProperties":false},"ForwardConfirmation":{"type":"object","properties":{"code":{"type":"string"},"url":{"type":"string"},"receivedAt":{"$ref":"#/components/schemas/Timestamp"},"requestedBy":{"default":null,"type":["string","null"]}},"required":["code","url","receivedAt","requestedBy"],"additionalProperties":false},"FraudAction":{"type":"string","enum":["allow","review","block"]},"FraudCheck":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudCheckId"},"email":{"type":"string"},"ip":{"type":["string","null"]},"country":{"$ref":"#/components/schemas/CountryCode"},"ipCountry":{"type":["string","null"]},"score":{"type":"integer","minimum":0,"maximum":100},"action":{"$ref":"#/components/schemas/FraudAction"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/FraudReason"}},"isTest":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","ip","country","ipCountry","score","action","reasons","isTest","createdAt"],"additionalProperties":false},"FraudCheckDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudCheckId"},"email":{"type":"string"},"ip":{"type":["string","null"]},"country":{"$ref":"#/components/schemas/CountryCode"},"ipCountry":{"type":["string","null"]},"score":{"type":"integer","minimum":0,"maximum":100},"action":{"$ref":"#/components/schemas/FraudAction"},"stage":{"$ref":"#/components/schemas/RuleStage"},"decidedBy":{"anyOf":[{"$ref":"#/components/schemas/DecidedBy"},{"type":"null"}]},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/FraudReason"}},"flags":{"type":"array","items":{"type":"string"}},"requirements":{"anyOf":[{"$ref":"#/components/schemas/FraudRequirements"},{"type":"null"}]},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleTrace"}},"signals":{"$ref":"#/components/schemas/SignalSnapshot"},"isTest":{"type":"boolean"},"checkoutSessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"totalMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}]},"reviewId":{"anyOf":[{"$ref":"#/components/schemas/FraudReviewId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","ip","country","ipCountry","score","action","stage","decidedBy","reasons","flags","requirements","rules","signals","isTest","checkoutSessionId","orderId","orderNumber","totalMinor","currency","reviewId","createdAt"],"additionalProperties":false},"FraudCheckId":{"type":"string","pattern":"^frd_[0-9a-hjkmnp-tv-z]{20}$"},"FraudCheckRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudCheckId"},"email":{"type":"string"},"ip":{"type":["string","null"]},"country":{"$ref":"#/components/schemas/CountryCode"},"ipCountry":{"type":["string","null"]},"score":{"type":"integer","minimum":0,"maximum":100},"action":{"$ref":"#/components/schemas/FraudAction"},"stage":{"$ref":"#/components/schemas/RuleStage"},"decidedBy":{"anyOf":[{"$ref":"#/components/schemas/DecidedBy"},{"type":"null"}]},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/FraudReason"}},"flags":{"type":"array","items":{"type":"string"}},"isTest":{"type":"boolean"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"totalMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","ip","country","ipCountry","score","action","stage","decidedBy","reasons","flags","isTest","orderId","orderNumber","totalMinor","currency","createdAt"],"additionalProperties":false},"FraudDashboard":{"type":"object","properties":{"days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totals":{"type":"object","properties":{"checks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reviewed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blocked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"flagged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"preventedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"openReviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previous":{"type":"object","properties":{"checks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reviewed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blocked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["checks","reviewed","blocked"],"additionalProperties":false}},"required":["checks","allowed","reviewed","blocked","flagged","preventedMinor","openReviews","previous"],"additionalProperties":false},"series":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"allow":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"review":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"block":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","allow","review","block"],"additionalProperties":false}},"scores":{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"to":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allow":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"review":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"block":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["from","to","allow","review","block"],"additionalProperties":false}},"reasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["code","count"],"additionalProperties":false}},"rules":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"name":{"type":"string"},"hits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mode":{"$ref":"#/components/schemas/RuleMode"}},"required":["ruleId","name","hits","mode"],"additionalProperties":false}},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"checks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blocked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["country","checks","blocked"],"additionalProperties":false}},"networks":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"checks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blocked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["label","checks","blocked"],"additionalProperties":false}},"recent":{"type":"array","items":{"$ref":"#/components/schemas/FraudCheckRow"}}},"required":["days","currency","totals","series","scores","reasons","rules","countries","networks","recent"],"additionalProperties":false},"FraudDecision":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/FraudAction"},"score":{"type":"integer","minimum":0,"maximum":100},"decidedBy":{"$ref":"#/components/schemas/DecidedBy"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/FraudReason"}},"requirements":{"$ref":"#/components/schemas/FraudRequirements"},"flags":{"type":"array","items":{"type":"string"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleTrace"}},"buyerMessage":{"type":["string","null"]}},"required":["action","score","decidedBy","reasons","requirements","flags","rules","buyerMessage"],"additionalProperties":false},"FraudListAddResult":{"type":"object","properties":{"added":{"type":"array","items":{"$ref":"#/components/schemas/FraudListEntry"}},"skipped":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"reason":{"type":"string"}},"required":["value","reason"],"additionalProperties":false}}},"required":["added","skipped"],"additionalProperties":false},"FraudListCounts":{"type":"object","properties":{"block":{"type":"integer","minimum":0,"maximum":9007199254740991},"allow":{"type":"integer","minimum":0,"maximum":9007199254740991},"expired":{"type":"integer","minimum":0,"maximum":9007199254740991},"byKind":{"type":"array","items":{"type":"object","properties":{"list":{"$ref":"#/components/schemas/FraudListName"},"kind":{"$ref":"#/components/schemas/BlocklistKind"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["list","kind","count"],"additionalProperties":false}}},"required":["block","allow","expired","byKind"],"additionalProperties":false},"FraudListEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudListEntryId"},"list":{"$ref":"#/components/schemas/FraudListName"},"kind":{"$ref":"#/components/schemas/BlocklistKind"},"value":{"type":"string"},"reason":{"type":"string"},"source":{"$ref":"#/components/schemas/FraudListSource"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"expired":{"type":"boolean"},"matches30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastMatchAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"addedBy":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","list","kind","value","reason","source","expiresAt","expired","matches30d","lastMatchAt","addedBy","createdAt"],"additionalProperties":false},"FraudListEntryId":{"type":"string","pattern":"^(?:blk|alw|pbl)_[0-9a-hjkmnp-tv-z]{20}$"},"FraudListImportResult":{"type":"object","properties":{"rows":{"type":"integer","minimum":0,"maximum":9007199254740991},"added":{"type":"integer","minimum":0,"maximum":9007199254740991},"updated":{"type":"integer","minimum":0,"maximum":9007199254740991},"skipped":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"value":{"type":"string"},"reason":{"type":"string"}},"required":["line","value","reason"],"additionalProperties":false}},"dryRun":{"type":"boolean"}},"required":["rows","added","updated","skipped","dryRun"],"additionalProperties":false},"FraudListName":{"type":"string","enum":["block","allow"]},"FraudListSource":{"type":"string","enum":["manual","import","customer","dispute","review","order","platform"]},"FraudNoteId":{"type":"string","pattern":"^fnote_[0-9a-hjkmnp-tv-z]{20}$"},"FraudReason":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/FraudReasonCode"},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"detail":{"type":"string"}},"required":["code","points","detail"],"additionalProperties":false},"FraudReasonCode":{"type":"string","enum":["blocklist_email","blocklist_domain","blocklist_ip","blocklist_country","proxy","velocity","disposable_email","country_mismatch","blocklist_asn","blocklist_device","blocklist_discord","blocklist_card","platform_blocklist","allowlist","tor","datacenter","ip_reputation","email_mx","email_risk","card_country_mismatch","chargeback_history","refund_history","returning_buyer","new_account","cart_anomaly","behavior","bot","radar","rule","check_failed"]},"FraudRequirements":{"type":"object","properties":{"emailVerification":{"type":"boolean"},"threeDS":{"type":"boolean"},"maxQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"irreversibleOnly":{"type":"boolean"}},"required":["emailVerification","threeDS","maxQuantity"],"additionalProperties":false},"FraudReviewCounts":{"type":"object","properties":{"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refunded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["open","approved","cancelled","refunded"],"additionalProperties":false},"FraudReviewDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudReviewId"},"status":{"$ref":"#/components/schemas/FraudReviewStatus"},"email":{"type":"string"},"score":{"type":"integer","minimum":0,"maximum":100},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/FraudReason"}},"flags":{"type":"array","items":{"type":"string"}},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"paid":{"type":"boolean"},"totalMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"ip":{"type":["string","null"]},"country":{"type":["string","null"]},"ipCountry":{"type":["string","null"]},"notes":{"type":"array","items":{"$ref":"#/components/schemas/FraudReviewNote"}},"decidedBy":{"type":["string","null"]},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/FraudCheckDetail"}},"buyer":{"type":"object","properties":{"paidOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"refunds":{"type":"integer","minimum":0,"maximum":9007199254740991},"chargebacks":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstSeenAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"blocked":{"type":"boolean"},"allowed":{"type":"boolean"}},"required":["paidOrders","refunds","chargebacks","firstSeenAt","blocked","allowed"],"additionalProperties":false},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unitPriceMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","quantity","unitPriceMinor"],"additionalProperties":false}}},"required":["id","status","email","score","reasons","flags","orderId","orderNumber","paid","totalMinor","currency","ip","country","ipCountry","notes","decidedBy","decidedAt","createdAt","checks","buyer","items"],"additionalProperties":false},"FraudReviewId":{"type":"string","pattern":"^frev_[0-9a-hjkmnp-tv-z]{20}$"},"FraudReviewNote":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudNoteId"},"author":{"type":"string"},"authorId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"body":{"type":"string"},"system":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","author","authorId","body","system","createdAt"],"additionalProperties":false},"FraudReviewRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudReviewId"},"status":{"$ref":"#/components/schemas/FraudReviewStatus"},"email":{"type":"string"},"score":{"type":"integer","minimum":0,"maximum":100},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/FraudReason"}},"flags":{"type":"array","items":{"type":"string"}},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"paid":{"type":"boolean"},"totalMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"ip":{"type":["string","null"]},"country":{"type":["string","null"]},"ipCountry":{"type":["string","null"]},"notes":{"type":"integer","minimum":0,"maximum":9007199254740991},"decidedBy":{"type":["string","null"]},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","status","email","score","reasons","flags","orderId","orderNumber","paid","totalMinor","currency","ip","country","ipCountry","notes","decidedBy","decidedAt","createdAt"],"additionalProperties":false},"FraudReviewStatus":{"type":"string","enum":["open","approved","cancelled","refunded"]},"FraudRule":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"description":{"default":"","type":"string","maxLength":300},"enabled":{"default":true,"type":"boolean"},"mode":{"default":"live","$ref":"#/components/schemas/RuleMode"},"stage":{"default":"checkout","$ref":"#/components/schemas/RuleStage"},"match":{"$ref":"#/components/schemas/ConditionGroup"},"actions":{"minItems":1,"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/RuleAction"}},"stop":{"default":false,"type":"boolean"},"id":{"$ref":"#/components/schemas/FraudRuleId"},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"hits30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastHitAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","description","enabled","mode","stage","match","actions","stop","id","position","hits30d","lastHitAt","createdAt","updatedAt"],"additionalProperties":false},"FraudRuleId":{"type":"string","pattern":"^frule_[0-9a-hjkmnp-tv-z]{20}$"},"FraudSettings":{"type":"object","properties":{"vpnPolicy":{"$ref":"#/components/schemas/VpnPolicy"},"maxOrdersPerIpPerHour":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"reviewScore":{"type":"integer","minimum":1,"maximum":100},"blockScore":{"type":"integer","minimum":1,"maximum":100},"blockDisposableEmail":{"type":"boolean"},"flagCountryMismatch":{"type":"boolean"},"usePlatformBlocklist":{"default":false,"type":"boolean"},"platformListAction":{"default":"block","type":"string","enum":["block","review"]},"torPolicy":{"default":"block","$ref":"#/components/schemas/VpnPolicy"},"datacenterPolicy":{"default":"review","$ref":"#/components/schemas/VpnPolicy"},"checkEmailMx":{"default":true,"type":"boolean"},"maxCheckoutsPerEmailPerDay":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"maxCheckoutsPerDevicePerDay":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"reviewNewAccountsDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["vpnPolicy","maxOrdersPerIpPerHour","reviewScore","blockScore","blockDisposableEmail","flagCountryMismatch","usePlatformBlocklist","platformListAction","torPolicy","datacenterPolicy","checkEmailMx","maxCheckoutsPerEmailPerDay","maxCheckoutsPerDevicePerDay","reviewNewAccountsDays"],"additionalProperties":false},"FraudSimulationResult":{"type":"object","properties":{"decision":{"$ref":"#/components/schemas/FraudDecision"},"signals":{"$ref":"#/components/schemas/SignalSnapshot"}},"required":["decision","signals"],"additionalProperties":false},"FreeCover":{"type":"string","enum":["free","gift_card","store_credit"]},"FulfillmentKind":{"type":"string","enum":["payment_confirmed","license_key","file_access","discord_role","email_receipt","seller_webhook","settlement","gift_card","dynamic_delivery"]},"FulfillmentStep":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FulfillmentStepId"},"kind":{"$ref":"#/components/schemas/FulfillmentKind"},"status":{"$ref":"#/components/schemas/StepStatus"},"attempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"detail":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","status","attempts","detail","updatedAt"],"additionalProperties":false},"FulfillmentStepId":{"type":"string","pattern":"^fs_[0-9a-hjkmnp-tv-z]{20}$"},"FunnelDefinition":{"type":"object","properties":{"steps":{"minItems":2,"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/FunnelStep"}},"windowMinutes":{"type":"integer","minimum":1,"maximum":43200},"scope":{"$ref":"#/components/schemas/FunnelScope"},"segment":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/SessionFilter"}},"breakdown":{"default":null,"anyOf":[{"$ref":"#/components/schemas/SessionDimension"},{"type":"null"}]}},"required":["steps","windowMinutes","scope","segment","breakdown"],"additionalProperties":false},"FunnelEventName":{"type":"string","enum":["page_view","product_view","add_to_cart","begin_checkout","payment_attempt","purchase","signup","search","outbound_click","custom"]},"FunnelId":{"type":"string","pattern":"^afn_[0-9a-hjkmnp-tv-z]{20}$"},"FunnelResult":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"steps":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"event":{"$ref":"#/components/schemas/FunnelEventName"},"entities":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversionBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stepBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"dropOff":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"medianMsFromPrevious":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["label","event","entities","conversionBps","stepBps","dropOff","medianMsFromPrevious"],"additionalProperties":false}},"previous":{"anyOf":[{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"type":"null"}]},"breakdown":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"steps":{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}},"required":["key","steps"],"additionalProperties":false}},"entities":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"converted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"overallBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["period","steps","previous","breakdown","entities","converted","overallBps","ms"],"additionalProperties":false},"FunnelScope":{"type":"string","enum":["session","visitor"]},"FunnelStep":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/FunnelEventName"},"label":{"type":"string","minLength":1,"maxLength":60},"filters":{"default":[],"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/StepFilter"}}},"required":["event","label","filters"],"additionalProperties":false},"GamePlatform":{"type":"string","enum":["windows","mac","linux","steam","epic","battlenet","riot","ea","ubisoft","xbox","playstation","switch","android","ios","web","other"]},"GatewayConnected":{"type":"object","properties":{"connection":{"$ref":"#/components/schemas/GatewayConnection"},"paymentModel":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PaymentModel"},{"type":"null"}]},"switchedToOwn":{"default":false,"type":"boolean"}},"required":["connection","paymentModel","switchedToOwn"],"additionalProperties":false},"GatewayConnection":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/GatewayConnectionId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"status":{"type":"string","enum":["connected","pending","disconnected"]},"accountLabel":{"type":"string"},"methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"mode":{"type":"string","enum":["test","live"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","storeId","provider","status","accountLabel","methods","mode","createdAt"],"additionalProperties":false},"GatewayConnectionId":{"type":"string","pattern":"^gw_[0-9a-hjkmnp-tv-z]{20}$"},"GatewayHealthRow":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"displayName":{"type":"string"},"mode":{"type":"string","enum":["test","live"]},"enabledForMor":{"type":"boolean"},"enabledForSellers":{"type":"boolean"},"ready":{"type":"boolean"},"readiness":{"type":"string"},"status":{"$ref":"#/components/schemas/MethodHealthStatus"},"detail":{"type":"string"},"connections":{"type":"object","properties":{"connected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disconnected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["connected","pending","disconnected"],"additionalProperties":false},"checkouts24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"checkouts7d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid7d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastPaidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"expired7d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"events7d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastEventAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["provider","displayName","mode","enabledForMor","enabledForSellers","ready","readiness","status","detail","connections","checkouts24h","paid24h","checkouts7d","paid7d","lastPaidAt","expired7d","events7d","lastEventAt"],"additionalProperties":false},"GatewayModeReadiness":{"type":"object","properties":{"ready":{"type":"boolean"},"processor":{"anyOf":[{"$ref":"#/components/schemas/GatewayProcessor"},{"type":"null"}]},"detail":{"type":"string"}},"required":["ready","processor","detail"],"additionalProperties":false},"GatewayProcessor":{"type":"string","enum":["stripe","paypal","sandbox"]},"GatewayProvider":{"type":"string","enum":["shopfast_pay","sandbox","stripe","paypal","btcpay","manual","plugin","crypto_direct","stripe_keys","paypal_keys","square","mollie","razorpay","paystack","nowpayments","cryptomus","paypal_email","shopify","paddle","heleket","sumup","authorize_net","nmi","skinloop","cashapp","paypal_ff","gift_codes"]},"GatewayReadiness":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"test":{"$ref":"#/components/schemas/GatewayModeReadiness"},"live":{"$ref":"#/components/schemas/GatewayModeReadiness"},"webhookUrl":{"type":["string","null"]},"collectable":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"required":["provider","test","live","webhookUrl","collectable"],"additionalProperties":false},"GatewayState":{"type":"string","enum":["ready","connecting","failed","off"]},"GatewayVerification":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"mode":{"type":"string","enum":["test","live"]},"ok":{"type":"boolean"},"checks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"ok":{"type":"boolean"},"detail":{"type":"string"}},"required":["name","ok","detail"],"additionalProperties":false}},"checkedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["provider","mode","ok","checks","checkedAt"],"additionalProperties":false},"GeneratedCodes":{"type":"object","properties":{"batchId":{"$ref":"#/components/schemas/CodeBatchId"},"created":{"type":"integer","minimum":0,"maximum":9007199254740991},"sample":{"maxItems":20,"type":"array","items":{"type":"string"}}},"required":["batchId","created","sample"],"additionalProperties":false},"GetAccessContactsResponse":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AccessContact"}}},"required":["contacts"],"additionalProperties":false},"GetClaimResponse":{"type":"object","properties":{"claim":{"anyOf":[{"$ref":"#/components/schemas/BuyerClaim"},{"type":"null"}]},"canReport":{"type":"boolean"},"orderNumber":{"type":["string","null"]}},"required":["claim","canReport","orderNumber"],"additionalProperties":false},"GetCommunityRestoreResultResponse":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"},"rows":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["filename","csv","rows"],"additionalProperties":false},"GetDiscordPullResponse":{"type":"object","properties":{"run":{"anyOf":[{"$ref":"#/components/schemas/DiscordPullRun"},{"type":"null"}]},"pullable":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["run","pullable"],"additionalProperties":false},"GetEmailDocumentResponse":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/EmailTemplateKind"},"name":{"type":"string"},"trigger":{"type":"string"},"enabled":{"type":"boolean"},"alwaysOn":{"type":"boolean"},"doc":{"$ref":"#/components/schemas/EmailDocument"},"blocks":{"type":"boolean"},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string","enum":["text","url","money","date","number","code","list"]},"group":{"type":"string","enum":["Store","Customer","Order","Product","Marketing","Subscription","Support"]},"sample":{"type":"string"}},"required":["name","label","type","group","sample"],"additionalProperties":false}},"sample":{"type":"object","properties":{"text":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"price":{"type":"string"}},"required":["name","quantity","price"],"additionalProperties":false}},"links":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"}},"required":["label","url"],"additionalProperties":false}},"keys":{"type":"array","items":{"type":"object","properties":{"product":{"type":"string"},"key":{"type":"string"}},"required":["product","key"],"additionalProperties":false}}},"required":["text","items","links","keys"],"additionalProperties":false},"branding":{"$ref":"#/components/schemas/EmailBranding"},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["kind","name","trigger","enabled","alwaysOn","doc","blocks","variables","sample","branding","updatedAt"],"additionalProperties":false},"GetEmailVersionResponse":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/EmailVersion"},"doc":{"$ref":"#/components/schemas/EmailDocument"}},"required":["version","doc"],"additionalProperties":false},"GetFeedReportResponse":{"type":"object","properties":{"googleUrl":{"type":"string"},"metaUrl":{"type":"string"},"sitemapUrl":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"title":{"type":"string"},"listed":{"type":"boolean"},"reason":{"type":["string","null"]},"issues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"required":["id","field","message"],"additionalProperties":false}}},"required":["productId","title","listed","reason","issues"],"additionalProperties":false}},"nextCursor":{"default":null,"type":["string","null"]},"total":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"listed":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["googleUrl","metaUrl","sitemapUrl","products","nextCursor","total","listed"],"additionalProperties":false},"GetFileDownloadUrlResponse":{"type":"object","properties":{"url":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["url","expiresAt"],"additionalProperties":false},"GetGiftCardResponse":{"type":"object","properties":{"giftCard":{"$ref":"#/components/schemas/GiftCard"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardTransaction"}}},"required":["giftCard","transactions"],"additionalProperties":false},"GetInvoiceResponse":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/InvoiceRow"},"document":{"$ref":"#/components/schemas/InvoiceDocument"}},"required":["row","document"],"additionalProperties":false},"GetMarketingSettingsResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/MarketingSettings"},"address":{"type":"string"},"addressMissing":{"type":"boolean"},"branding":{"$ref":"#/components/schemas/EmailBranding"}},"required":["settings","address","addressMissing","branding"],"additionalProperties":false},"GetPaidMethod":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"label":{"type":"string"},"kind":{"type":"string","enum":["shopfast_pay","gateway","manual","plugin"]},"state":{"$ref":"#/components/schemas/GetPaidMethodState"},"detail":{"type":"string"},"accountLabel":{"type":["string","null"]},"methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"mode":{"type":"string","enum":["test","live"]},"health":{"$ref":"#/components/schemas/MethodHealth"},"estimate":{"anyOf":[{"$ref":"#/components/schemas/ProcessorEstimate"},{"type":"null"}]},"model":{"$ref":"#/components/schemas/PaymentModel"},"atCheckout":{"type":"boolean"},"webhookUrl":{"default":null,"type":["string","null"]},"forwardAddress":{"default":null,"type":["string","null"]},"forwardConfirmation":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ForwardConfirmation"},{"type":"null"}]},"lastReceiptAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"unmatchedPayments":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/UnmatchedPayment"}},"payOptions":{"default":null,"anyOf":[{"$ref":"#/components/schemas/KeyedPayOptions"},{"type":"null"}]}},"required":["provider","label","kind","state","detail","accountLabel","methods","mode","health","estimate","model","atCheckout","webhookUrl","forwardAddress","forwardConfirmation","lastReceiptAt","unmatchedPayments","payOptions"],"additionalProperties":false},"GetPaidMethodState":{"type":"string","enum":["active","connected","pending","available","unavailable"]},"GetPaidOverview":{"type":"object","properties":{"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"pay":{"$ref":"#/components/schemas/SellerPayStatus"},"methods":{"type":"array","items":{"$ref":"#/components/schemas/GetPaidMethod"}},"rules":{"$ref":"#/components/schemas/PaymentMethodRules"},"testMode":{"$ref":"#/components/schemas/PaymentsTestMode"},"fees":{"$ref":"#/components/schemas/FeeSchedule"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"allowedModels":{"type":"array","items":{"$ref":"#/components/schemas/PaymentModel"}},"pricesIncludeTax":{"type":"boolean"},"homeTax":{"$ref":"#/components/schemas/TaxRate"}},"required":["paymentModel","pay","methods","rules","testMode","fees","currency","allowedModels"],"additionalProperties":false},"GetPluginFixturesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PluginFixture"}}},"required":["items"],"additionalProperties":false},"GetPluginVersionResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PluginVersionId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"source":{"type":"string"},"manifest":{"type":"string"}},"required":["id","number","source","manifest"],"additionalProperties":false},"GetProductStatusResponse":{"anyOf":[{"$ref":"#/components/schemas/ProductStatusView"},{"type":"null"}]},"GetResellerProgramResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ResellerSettings"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/ResellerTier"}},"applyUrl":{"type":"string"}},"required":["settings","tiers","applyUrl"],"additionalProperties":false},"GetSectionLibraryResponse":{"type":"object","properties":{"sections":{"type":"array","items":{"$ref":"#/components/schemas/SectionLibraryEntry"}},"categories":{"type":"array","items":{"type":"string"}},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/LibraryLayoutType"}},"productCard":{"type":"string","enum":["configured","available","unsupported"]}},"required":["sections","categories","layouts","productCard"],"additionalProperties":false},"GetStatusOverviewResponse":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/StatusPage"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/StatusLabel"}},"components":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusComponentId"},"name":{"type":"string"},"description":{"type":"string"},"group":{"type":"string"},"productId":{"anyOf":[{"$ref":"#/components/schemas/ProductId"},{"type":"null"}]},"productName":{"type":["string","null"]},"labelId":{"$ref":"#/components/schemas/StatusLabelId"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"showUptime":{"type":"boolean"},"since":{"$ref":"#/components/schemas/Timestamp"},"note":{"type":"string"},"pageId":{"$ref":"#/components/schemas/StatusPageId"}},"required":["id","name","description","group","productId","productName","labelId","position","showUptime","since","note","pageId"],"additionalProperties":false}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusIncidentId"},"kind":{"$ref":"#/components/schemas/IncidentKind"},"title":{"type":"string"},"state":{"$ref":"#/components/schemas/IncidentState"},"componentIds":{"type":"array","items":{"$ref":"#/components/schemas/StatusComponentId"}},"labelId":{"anyOf":[{"$ref":"#/components/schemas/StatusLabelId"},{"type":"null"}]},"scheduledStart":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"scheduledEnd":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"resolvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"updates":{"type":"array","items":{"$ref":"#/components/schemas/IncidentUpdate"}},"pageId":{"$ref":"#/components/schemas/StatusPageId"}},"required":["id","kind","title","state","componentIds","labelId","scheduledStart","scheduledEnd","startedAt","resolvedAt","updates","pageId"],"additionalProperties":false}},"subscribers":{"type":"array","items":{"type":"object","properties":{"pageId":{"$ref":"#/components/schemas/StatusPageId"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pageId","count"],"additionalProperties":false}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"}},"required":["id","name","handle"],"additionalProperties":false}},"embed":{"type":"object","properties":{"origin":{"type":"string"}},"required":["origin"],"additionalProperties":false}},"required":["pages","labels","components","incidents","subscribers","products","embed"],"additionalProperties":false},"GetStorefrontPreviewDataResponse":{"type":"object","properties":{"catalog":{"$ref":"#/components/schemas/StorefrontCatalog"},"storefrontOrigin":{"type":"string"},"accentHue":{"type":"number"},"buyerGate":{"default":null,"anyOf":[{"$ref":"#/components/schemas/BuyerGate"},{"type":"null"}]},"shop":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorefrontShop"},{"type":"null"}]}},"required":["catalog","storefrontOrigin","accentHue","buyerGate","shop"],"additionalProperties":false},"GetSupportSettingsResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/SupportSettings"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"type":"string"},"roleName":{"type":"string"}},"required":["id","name","email","roleName"],"additionalProperties":false}},"inbound":{"type":"object","properties":{"configured":{"type":"boolean"},"domain":{"type":"string"},"example":{"type":"string"}},"required":["configured","domain","example"],"additionalProperties":false},"supportUrl":{"type":"string"}},"required":["settings","members","inbound","supportUrl"],"additionalProperties":false},"GetThemeUpdatePreviewHtmlResponse":{"type":"object","properties":{"html":{"type":"string"},"template":{"type":"string"},"side":{"type":"string","enum":["before","after"]}},"required":["html","template","side"],"additionalProperties":false},"GetThemeVersionResponse":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/ThemeVersionSummary"},"files":{"$ref":"#/components/schemas/ThemeFilesRecord"}},"required":["version","files"],"additionalProperties":false},"GiftCard":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/GiftCardId"},"last4":{"type":"string","minLength":4,"maxLength":4},"initialMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"balanceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"recipientEmail":{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},"recipientName":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"note":{"type":"string","maxLength":280},"status":{"$ref":"#/components/schemas/GiftCardStatus"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastUsedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","last4","initialMinor","balanceMinor","currency","recipientEmail","recipientName","note","status","expiresAt","lastUsedAt","createdAt"],"additionalProperties":false},"GiftCardBalance":{"type":"object","properties":{"last4":{"type":"string"},"balanceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"initialMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/GiftCardStatus"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"shareToken":{"type":["string","null"]}},"required":["last4","balanceMinor","initialMinor","currency","status","expiresAt","shareToken"],"additionalProperties":false},"GiftCardCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"used":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disabled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","active","used","expired","disabled"],"additionalProperties":false},"GiftCardId":{"type":"string","pattern":"^gc_[0-9a-hjkmnp-tv-z]{20}$"},"GiftCardStatus":{"type":"string","enum":["active","used","expired","disabled"]},"GiftCardTransaction":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/GiftCardTransactionKind"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"balanceAfterMinor":{"$ref":"#/components/schemas/MinorUnits"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"note":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["kind","amountMinor","balanceAfterMinor","orderId","orderNumber","note","createdAt"],"additionalProperties":false},"GiftCardTransactionKind":{"type":"string","enum":["issue","redeem","adjust","refund","disable","enable"]},"GiftCodeChange":{"type":"string","enum":["store_credit","none"]},"GiftCodeCurrency":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"unit":{"type":"string","minLength":1,"maxLength":8,"pattern":"^[A-Za-z0-9$\\u20AC\\u00A3\\u00A5\\u20B9 .-]+$"},"faces":{"minItems":1,"maxItems":12,"type":"array","items":{"$ref":"#/components/schemas/GiftCodeFace"}}},"required":["currency","unit","faces"],"additionalProperties":false},"GiftCodeFace":{"type":"object","properties":{"valueMinor":{"type":"integer","minimum":1,"maximum":100000000,"$ref":"#/components/schemas/MinorUnits"},"links":{"default":{"eneba":"","g2a":""},"$ref":"#/components/schemas/GiftCodeLinks"}},"required":["valueMinor","links"],"additionalProperties":false},"GiftCodeImage":{"type":"object","properties":{"uploadId":{"type":"string","minLength":1,"maxLength":64},"url":{"type":"string","maxLength":1000,"format":"uri"}},"required":["uploadId","url"],"additionalProperties":false},"GiftCodeLinks":{"type":"object","properties":{"eneba":{"default":""},"g2a":{"default":""}},"required":["eneba","g2a"],"additionalProperties":false},"GiftCodePreset":{"type":"string","enum":["binance","steam","custom"]},"GiftCodeReview":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/GiftCodeReviewId"},"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"status":{"$ref":"#/components/schemas/GiftCodeReviewStatus"},"typeId":{"type":"string"},"typeName":{"type":"string"},"preset":{"$ref":"#/components/schemas/GiftCodePreset"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"unit":{"type":"string"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"faceMinor":{"$ref":"#/components/schemas/MinorUnits"},"changeMinor":{"$ref":"#/components/schemas/MinorUnits"},"change":{"$ref":"#/components/schemas/GiftCodeChange"},"asked":{"type":"array","items":{"type":"object","properties":{"valueMinor":{"$ref":"#/components/schemas/MinorUnits"},"count":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["valueMinor","count"],"additionalProperties":false}},"codeHints":{"type":"array","items":{"type":"string"}},"reference":{"type":"string"},"buyerEmail":{"type":"string"},"buyerName":{"type":"string"},"receiptUrl":{"type":"string"},"hasScreenshot":{"type":"boolean"},"rejectReason":{"type":"string"},"reviewedBy":{"type":["string","null"]},"reviewedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"isTest":{"type":"boolean"},"checkoutOpen":{"type":"boolean"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","sessionId","status","typeId","typeName","preset","currency","unit","totalMinor","faceMinor","changeMinor","change","asked","codeHints","reference","buyerEmail","buyerName","receiptUrl","hasScreenshot","rejectReason","reviewedBy","reviewedAt","orderId","orderNumber","isTest","checkoutOpen","expiresAt","createdAt"],"additionalProperties":false},"GiftCodeReviewCounts":{"type":"object","properties":{"pending":{"type":"integer","minimum":0,"maximum":9007199254740991},"accepted":{"type":"integer","minimum":0,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["pending","accepted","rejected"],"additionalProperties":false},"GiftCodeReviewDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/GiftCodeReviewId"},"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"status":{"$ref":"#/components/schemas/GiftCodeReviewStatus"},"typeId":{"type":"string"},"typeName":{"type":"string"},"preset":{"$ref":"#/components/schemas/GiftCodePreset"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"unit":{"type":"string"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"faceMinor":{"$ref":"#/components/schemas/MinorUnits"},"changeMinor":{"$ref":"#/components/schemas/MinorUnits"},"change":{"$ref":"#/components/schemas/GiftCodeChange"},"asked":{"type":"array","items":{"type":"object","properties":{"valueMinor":{"$ref":"#/components/schemas/MinorUnits"},"count":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["valueMinor","count"],"additionalProperties":false}},"codeHints":{"type":"array","items":{"type":"string"}},"reference":{"type":"string"},"buyerEmail":{"type":"string"},"buyerName":{"type":"string"},"receiptUrl":{"type":"string"},"hasScreenshot":{"type":"boolean"},"rejectReason":{"type":"string"},"reviewedBy":{"type":["string","null"]},"reviewedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"isTest":{"type":"boolean"},"checkoutOpen":{"type":"boolean"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"codes":{"type":"array","items":{"type":"string"}},"screenshot":{"type":["string","null"]}},"required":["id","sessionId","status","typeId","typeName","preset","currency","unit","totalMinor","faceMinor","changeMinor","change","asked","codeHints","reference","buyerEmail","buyerName","receiptUrl","hasScreenshot","rejectReason","reviewedBy","reviewedAt","orderId","orderNumber","isTest","checkoutOpen","expiresAt","createdAt","codes","screenshot"],"additionalProperties":false},"GiftCodeReviewId":{"type":"string","pattern":"^gcr_[0-9a-hjkmnp-tv-z]{20}$"},"GiftCodeReviewStatus":{"type":"string","enum":["pending","accepted","rejected"]},"GiftCodeSettings":{"type":"object","properties":{"types":{"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/GiftCodeType"}},"change":{"default":"store_credit","$ref":"#/components/schemas/GiftCodeChange"},"reviewHours":{"default":48,"type":"integer","minimum":1,"maximum":168}},"required":["types","change","reviewHours"],"additionalProperties":false},"GiftCodeSettingsView":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/GiftCodeSettings"},"connected":{"type":"boolean"},"saved":{"type":"boolean"},"pending":{"type":"integer","minimum":0,"maximum":9007199254740991},"storeCurrency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["settings","connected","saved","pending","storeCurrency"],"additionalProperties":false},"GiftCodeType":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/GiftCodeTypeId"},"preset":{"$ref":"#/components/schemas/GiftCodePreset"},"enabled":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":40},"image":{"default":null,"anyOf":[{"$ref":"#/components/schemas/GiftCodeImage"},{"type":"null"}]},"currencies":{"minItems":1,"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/GiftCodeCurrency"}},"links":{"default":{"eneba":"","g2a":""},"$ref":"#/components/schemas/GiftCodeLinks"},"instructions":{"default":"","type":"string","maxLength":1000}},"required":["id","preset","enabled","name","image","currencies","links","instructions"],"additionalProperties":false},"GiftCodeTypeId":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,23}$"},"GoogleAdsSettings":{"type":"object","properties":{"conversionId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^AW-\\d{6,12}$"}]},"purchaseLabel":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^[A-Za-z0-9_-]{6,40}$"}]}},"required":["conversionId","purchaseLabel"],"additionalProperties":false},"GoogleAnalyticsId":{"type":"string","pattern":"^G-[A-Z0-9]{6,12}$"},"GoogleAnalyticsSettings":{"type":"object","properties":{"measurementId":{"default":"","anyOf":[{"type":"string","const":""},{"$ref":"#/components/schemas/GoogleAnalyticsId"}]},"ecommerce":{"default":true,"type":"boolean"}},"required":["measurementId","ecommerce"],"additionalProperties":false},"GoogleLink":{"type":"object","properties":{"email":{"type":"string","maxLength":320},"linkedAt":{"$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["email","linkedAt","lastUsedAt"],"additionalProperties":false},"GroupOp":{"type":"string","enum":["all","any"]},"GrowthCsv":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filename","csv","rows"],"additionalProperties":false},"GrowthOverview":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"kpis":{"type":"object","properties":{"revenueMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"orders":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"visitors":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"conversionBps":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"averageOrderMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"newCustomers":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"refundsMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"medianDeliveryMs":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false}},"required":["revenueMinor","orders","visitors","conversionBps","averageOrderMinor","newCustomers","refundsMinor","medianDeliveryMs"],"additionalProperties":false},"series":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"hour":{"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","hour","revenueMinor","orders","visitors"],"additionalProperties":false}},"topProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"unitsSold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["productId","name","unitsSold","revenueMinor"],"additionalProperties":false}},"paymentMethods":{"type":"array","items":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/PaymentMethod"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["method","orders","revenueMinor"],"additionalProperties":false}},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/CountryCode"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["country","orders","revenueMinor"],"additionalProperties":false}},"funnel":{"type":"object","properties":{"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"productViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"addedToCart":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"checkouts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["visitors","productViews","addedToCart","checkouts","paid"],"additionalProperties":false}},"required":["range","from","to","period","currency","kpis","series","topProducts","paymentMethods","countries","funnel"],"additionalProperties":false},"GrowthRange":{"type":"string","enum":["today","yesterday","7d","30d","90d","this_month","last_month","6mo","ytd","365d","custom"]},"GtmContainerId":{"type":"string","pattern":"^GTM-[A-Z0-9]{4,10}$"},"GuidePlatformSchema":{"type":"string","enum":["steam","epic","battlenet","ea","ubisoft","riot","xbox","playstation","switch"]},"HeadingBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"heading"},"text":{"type":"string","maxLength":300},"level":{"default":1,"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"align":{"default":"left","type":"string","enum":["left","center","right"]}},"required":["id","type","text","level","align"],"additionalProperties":false},"HeadlessOverview":{"type":"object","properties":{"endpoints":{"type":"object","properties":{"mcp":{"type":"string"},"shopMcp":{"type":"string"},"storefrontApi":{"type":"string"},"llmsTxt":{"type":"string"},"serverCard":{"type":"string"}},"required":["mcp","shopMcp","storefrontApi","llmsTxt","serverCard"],"additionalProperties":false},"storeHandle":{"type":"string"},"aiAccess":{"type":"boolean"},"aiMembers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"counts":{"type":"object","properties":{"storefrontKeys":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mcpConnections":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mcpCalls24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["storefrontKeys","mcpConnections","mcpCalls24h"],"additionalProperties":false}},"required":["endpoints","storeHandle","aiAccess","aiMembers","counts"],"additionalProperties":false},"Heatmap":{"type":"object","properties":{"routes":{"type":"array","items":{"type":"object","properties":{"route":{"$ref":"#/components/schemas/DashboardRoute"},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["route","clicks"],"additionalProperties":false}},"route":{"anyOf":[{"$ref":"#/components/schemas/DashboardRoute"},{"type":"null"}]},"device":{"$ref":"#/components/schemas/DeviceClass"},"totals":{"type":"object","properties":{"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sellers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["clicks","sessions","sellers"],"additionalProperties":false},"elements":{"type":"array","items":{"type":"object","properties":{"selector":{"$ref":"#/components/schemas/ElementSelector"},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"share":{"type":"number"},"points":{"type":"array","items":{"type":"object","properties":{"rx":{"type":"number"},"ry":{"type":"number"}},"required":["rx","ry"],"additionalProperties":false}}},"required":["selector","clicks","share","points"],"additionalProperties":false}},"dots":{"type":"array","items":{"type":"object","properties":{"px":{"type":"number"},"py":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["px","py"],"additionalProperties":false}},"viewportW":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageHeight":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"snapshot":{"anyOf":[{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/ActivitySessionId"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["sessionId","at"],"additionalProperties":false},{"type":"null"}]}},"required":["routes","route","device","totals","elements","dots","viewportW","pageHeight","snapshot"],"additionalProperties":false},"HexColor":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"Hostname":{"type":"string","maxLength":253,"pattern":"^(?=.{4,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"HtmlBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"html"},"html":{"type":"string","maxLength":20000}},"required":["id","type","html"],"additionalProperties":false},"HttpsUrl":{"type":"string","maxLength":2000,"format":"uri"},"ImageBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"image"},"src":{"type":"string","maxLength":800},"alt":{"type":"string","maxLength":200},"href":{"default":"","type":"string","maxLength":800},"width":{"default":560,"type":"integer","minimum":40,"maximum":680},"align":{"default":"center","type":"string","enum":["left","center","right"]},"rounded":{"default":true,"type":"boolean"}},"required":["id","type","src","alt","href","width","align","rounded"],"additionalProperties":false},"ImageVariantsResponse":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/StoredImageVariants"}}},"required":["images"],"additionalProperties":false},"ImpersonationHandoff":{"type":"object","properties":{"code":{"type":"string"},"user":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"}},"required":["id","name","email"],"additionalProperties":false},"storeId":{"anyOf":[{"$ref":"#/components/schemas/StoreId"},{"type":"null"}]},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["code","user","storeId","expiresAt"],"additionalProperties":false},"ImpersonationState":{"type":"object","properties":{"startedAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["startedAt","expiresAt"],"additionalProperties":false},"ImportContactsResponse":{"type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"type":"string"}}},"required":["added","updated","skipped","errors"],"additionalProperties":false},"ImportEntity":{"type":"string","enum":["products","customers","orders","license_keys"]},"ImportIssue":{"type":"object","properties":{"row":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"field":{"type":["string","null"]},"message":{"type":"string"}},"required":["row","field","message"],"additionalProperties":false},"ImportJob":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ImportJobId"},"entity":{"$ref":"#/components/schemas/ImportEntity"},"fileName":{"type":"string"},"status":{"$ref":"#/components/schemas/ImportStatus"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImportIssue"}},"createdBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","entity","fileName","status","total","processed","created","skipped","failed","errors","createdBy","createdAt","finishedAt"],"additionalProperties":false},"ImportJobId":{"type":"string","pattern":"^imp_[0-9a-hjkmnp-tv-z]{20}$"},"ImportMapping":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"ImportPreview":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"string"}},"sampleRows":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"rowCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"suggestedMapping":{"$ref":"#/components/schemas/ImportMapping"}},"required":["columns","sampleRows","rowCount","suggestedMapping"],"additionalProperties":false},"ImportReport":{"type":"object","properties":{"rowCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"valid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"willCreate":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImportIssue"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ImportIssue"}}},"required":["rowCount","valid","invalid","duplicates","willCreate","errors","warnings"],"additionalProperties":false},"ImportStatus":{"type":"string","enum":["queued","running","completed","failed"]},"InboxCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unread":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"support":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stock":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"payouts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"system":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"announcements":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","unread","orders","support","stock","disputes","reviews","payouts","system","announcements"],"additionalProperties":false},"InboxNotification":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/NotificationId"},"kind":{"$ref":"#/components/schemas/NotificationKind"},"tone":{"$ref":"#/components/schemas/NotificationTone"},"title":{"type":"string"},"body":{"type":"string"},"href":{"type":["string","null"]},"read":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","tone","title","body","href","read","createdAt"],"additionalProperties":false},"IncidentImpact":{"type":"string","enum":["minor","major","critical","maintenance"]},"IncidentKind":{"type":"string","enum":["incident","maintenance"]},"IncidentState":{"type":"string","enum":["investigating","identified","monitoring","resolved","scheduled","in_progress","completed"]},"IncidentStatus":{"type":"string","enum":["investigating","identified","monitoring","resolved","scheduled","in_progress","completed"]},"IncidentUpdate":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusUpdateId"},"state":{"$ref":"#/components/schemas/IncidentState"},"body":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","state","body","createdAt"],"additionalProperties":false},"InstalledApp":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AppId"},"enabled":{"type":"boolean"},"values":{"$ref":"#/components/schemas/AppValues"},"secretSet":{"type":"boolean"},"installedAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"activity":{"type":"array","items":{"type":"object","properties":{"at":{"$ref":"#/components/schemas/Timestamp"},"status":{"type":"string","enum":["sent","failed","simulated","info"]},"detail":{"type":"string"}},"required":["at","status","detail"],"additionalProperties":false}}},"required":["id","enabled","values","secretSet","installedAt","updatedAt","activity"],"additionalProperties":false},"IntegrationsOverview":{"type":"object","properties":{"storefront":{"$ref":"#/components/schemas/StorefrontIntegrations"},"telegram":{"type":"object","properties":{"configured":{"type":"boolean"},"chatId":{"type":["string","null"]},"botName":{"type":["string","null"]}},"required":["configured","chatId","botName"],"additionalProperties":false},"discord":{"type":"object","properties":{"connected":{"type":"boolean"},"guildName":{"type":["string","null"]}},"required":["connected","guildName"],"additionalProperties":false},"webhookEndpoints":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["storefront","telegram","discord","webhookEndpoints"],"additionalProperties":false},"InventoryRow":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"productName":{"type":"string"},"variantName":{"type":["string","null"]},"type":{"$ref":"#/components/schemas/ProductType"},"status":{"$ref":"#/components/schemas/ProductStatus"},"stockMode":{"$ref":"#/components/schemas/StockMode"},"available":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"reserved":{"default":null,"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"sold30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lowStockThreshold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"health":{"$ref":"#/components/schemas/StockHealth"},"daysOfCover":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"outOfStockBehavior":{"$ref":"#/components/schemas/OutOfStockBehavior"},"lastAdjustedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["productId","variantId","productName","variantName","type","status","stockMode","available","reserved","sold30d","lowStockThreshold","health","daysOfCover","outOfStockBehavior","lastAdjustedAt"],"additionalProperties":false},"InviteId":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"},"InviteMemberResponse":{"type":"object","properties":{"invite":{"$ref":"#/components/schemas/TeamInvite"},"acceptUrl":{"type":"string"}},"required":["invite","acceptUrl"],"additionalProperties":false},"InvitePreview":{"type":"object","properties":{"storeName":{"type":"string"},"storeHandle":{"$ref":"#/components/schemas/StoreHandle"},"email":{"$ref":"#/components/schemas/Email"},"roleName":{"type":"string"},"invitedBy":{"type":"string"},"status":{"$ref":"#/components/schemas/InviteStatus"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"requiresTwoFactor":{"default":false,"type":"boolean"}},"required":["storeName","storeHandle","email","roleName","invitedBy","status","expiresAt","requiresTwoFactor"],"additionalProperties":false},"InviteStatus":{"type":"string","enum":["pending","expired","accepted","revoked"]},"InvoiceAllowance":{"type":"object","properties":{"label":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"category":{"$ref":"#/components/schemas/VatCategory"},"rateBps":{"$ref":"#/components/schemas/Bps"}},"required":["label","amountMinor","category","rateBps"],"additionalProperties":false},"InvoiceDocument":{"type":"object","properties":{"v":{"type":"number","const":1},"kind":{"$ref":"#/components/schemas/InvoiceKind"},"number":{"type":"string"},"issueDate":{"$ref":"#/components/schemas/IsoDate"},"supplyDate":{"$ref":"#/components/schemas/IsoDate"},"period":{"anyOf":[{"type":"object","properties":{"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]},"issuedAt":{"$ref":"#/components/schemas/Timestamp"},"language":{"$ref":"#/components/schemas/InvoiceLanguage"},"locale":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"pricesIncludeTax":{"type":"boolean"},"issuer":{"type":"object","properties":{"name":{"type":"string"},"tradingName":{"type":["string","null"]},"address":{"type":"array","items":{"type":"string"}},"country":{"type":["string","null"]},"taxId":{"type":["string","null"]},"taxIdVerified":{"default":false,"type":"boolean"},"registration":{"type":["string","null"]},"email":{"type":["string","null"]},"postal":{"default":null,"anyOf":[{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"}},"required":["line1","line2","city","postalCode","region"],"additionalProperties":false},{"type":"null"}]},"role":{"type":"string","enum":["store","shopfast"]}},"required":["name","tradingName","address","country","taxId","taxIdVerified","registration","email","postal","role"],"additionalProperties":false},"soldThrough":{"anyOf":[{"$ref":"#/components/schemas/InvoiceParty"},{"type":"null"}]},"buyer":{"$ref":"#/components/schemas/InvoiceParty"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceLine"}},"allowances":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceAllowance"}},"breakdown":{"type":"array","items":{"$ref":"#/components/schemas/TaxBreakdownRow"}},"totals":{"$ref":"#/components/schemas/InvoiceTotals"},"taxLabel":{"type":"string"},"payment":{"anyOf":[{"type":"object","properties":{"method":{"type":"string"},"means":{"default":"ZZZ","type":"string"},"provider":{"type":["string","null"]},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"reference":{"type":["string","null"]}},"required":["method","means","provider","paidAt","reference"],"additionalProperties":false},{"type":"null"}]},"order":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"}},"required":["id","number"],"additionalProperties":false},{"type":"null"}]},"references":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"issueDate":{"$ref":"#/components/schemas/IsoDate"}},"required":["id","number","issueDate"],"additionalProperties":false},{"type":"null"}]},"reason":{"type":["string","null"]},"notes":{"type":"array","items":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/InvoiceNoteCode"},"text":{"type":"string"}},"required":["code","text"],"additionalProperties":false}},"footer":{"type":"string"},"brandColor":{"type":"string"},"logoKey":{"type":["string","null"]},"paper":{"type":"string","enum":["a4","letter"]},"isTest":{"type":"boolean"}},"required":["v","kind","number","issueDate","supplyDate","period","issuedAt","language","locale","currency","pricesIncludeTax","issuer","soldThrough","buyer","lines","allowances","breakdown","totals","taxLabel","payment","order","references","reason","notes","footer","brandColor","logoKey","paper","isTest"],"additionalProperties":false},"InvoiceExport":{"type":"object","properties":{"url":{"type":"string"},"filename":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["url","filename","expiresAt","count"],"additionalProperties":false},"InvoiceId":{"type":"string","pattern":"^inv_[0-9a-hjkmnp-tv-z]{20}$"},"InvoiceIssuerRole":{"type":"string","enum":["store","shopfast"]},"InvoiceKind":{"type":"string","enum":["invoice","credit_note"]},"InvoiceLanguage":{"type":"string","enum":["en","de","fr","es","it","nl","pt","pl"]},"InvoiceLine":{"type":"object","properties":{"description":{"type":"string"},"detail":{"type":["string","null"]},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unitPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"category":{"$ref":"#/components/schemas/VatCategory"},"rateBps":{"$ref":"#/components/schemas/Bps"}},"required":["description","detail","quantity","unitPriceMinor","discountMinor","netMinor","category","rateBps"],"additionalProperties":false},"InvoiceList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceRow"}},"nextCursor":{"type":["string","null"]},"totals":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTotalsByCurrency"}}},"required":["items","nextCursor","totals"],"additionalProperties":false},"InvoiceNoteCode":{"type":"string","enum":["reverse_charge","place_of_supply","merchant_of_record","exempt","no_tax","prices_include_tax","tax_id_unverified","test","paid","credit"]},"InvoiceParty":{"type":"object","properties":{"name":{"type":"string"},"tradingName":{"type":["string","null"]},"address":{"type":"array","items":{"type":"string"}},"country":{"type":["string","null"]},"taxId":{"type":["string","null"]},"taxIdVerified":{"default":false,"type":"boolean"},"registration":{"type":["string","null"]},"email":{"type":["string","null"]},"postal":{"default":null,"anyOf":[{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"}},"required":["line1","line2","city","postalCode","region"],"additionalProperties":false},{"type":"null"}]}},"required":["name","tradingName","address","country","taxId","taxIdVerified","registration","email","postal"],"additionalProperties":false},"InvoicePrefix":{"type":"string","pattern":"^[A-Z0-9][A-Z0-9/-]{0,15}$"},"InvoiceRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InvoiceId"},"kind":{"$ref":"#/components/schemas/InvoiceKind"},"number":{"type":"string"},"issueDate":{"$ref":"#/components/schemas/IsoDate"},"issuer":{"$ref":"#/components/schemas/InvoiceIssuerRole"},"orderId":{"type":"string"},"orderNumber":{"type":"string"},"buyerName":{"type":"string"},"buyerEmail":{"type":"string"},"buyerCompany":{"type":["string","null"]},"buyerTaxId":{"type":["string","null"]},"buyerCountry":{"type":["string","null"]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"reverseCharge":{"type":"boolean"},"creditsNumber":{"type":["string","null"]},"isTest":{"type":"boolean"}},"required":["id","kind","number","issueDate","issuer","orderId","orderNumber","buyerName","buyerEmail","buyerCompany","buyerTaxId","buyerCountry","currency","netMinor","taxMinor","totalMinor","reverseCharge","creditsNumber","isTest"],"additionalProperties":false},"InvoiceSettings":{"type":"object","properties":{"prefix":{"$ref":"#/components/schemas/InvoicePrefix"},"creditNotePrefix":{"$ref":"#/components/schemas/InvoicePrefix"},"yearly":{"default":false,"type":"boolean"},"startNumber":{"default":1,"type":"integer","minimum":1,"maximum":99999999},"footer":{"default":"","type":"string","maxLength":600},"language":{"default":"en","$ref":"#/components/schemas/InvoiceLanguage"},"matchBuyerLanguage":{"default":true,"type":"boolean"},"emailToBuyer":{"default":true,"type":"boolean"},"showLogo":{"default":true,"type":"boolean"},"logoKey":{"default":null,"anyOf":[{"type":"string","maxLength":400},{"type":"null"}]},"paper":{"default":"auto","type":"string","enum":["auto","a4","letter"]},"ownGatewayTax":{"default":"none","$ref":"#/components/schemas/OwnGatewayTax"},"fixedRateBps":{"default":0,"$ref":"#/components/schemas/Bps"},"exemptionNote":{"default":"","type":"string","maxLength":200}},"required":["prefix","creditNotePrefix","yearly","startNumber","footer","language","matchBuyerLanguage","emailToBuyer","showLogo","logoKey","paper","ownGatewayTax","fixedRateBps","exemptionNote"],"additionalProperties":false},"InvoiceSettingsView":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/InvoiceSettings"},"legal":{"$ref":"#/components/schemas/LegalDetails"},"storeName":{"type":"string"},"storeLogoUrl":{"type":["string","null"]},"invoiceLogoUrl":{"type":["string","null"]},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"nextInvoiceNumber":{"type":"string"},"nextCreditNoteNumber":{"type":"string"},"issuedCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"platform":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"taxIds":{"type":"string"}},"required":["name","address","taxIds"],"additionalProperties":false}},"required":["settings","legal","storeName","storeLogoUrl","invoiceLogoUrl","paymentModel","nextInvoiceNumber","nextCreditNoteNumber","issuedCount","platform"],"additionalProperties":false},"InvoiceTotals":{"type":"object","properties":{"lineNetMinor":{"$ref":"#/components/schemas/MinorUnits"},"allowanceMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxableMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"dueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["lineNetMinor","allowanceMinor","taxableMinor","taxMinor","totalMinor","paidMinor","dueMinor"],"additionalProperties":false},"InvoiceTotalsByCurrency":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"invoices":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditNotes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["currency","invoices","creditNotes","netMinor","taxMinor","totalMinor"],"additionalProperties":false},"IsoDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},"IssueGiftCardResponse":{"type":"object","properties":{"giftCard":{"$ref":"#/components/schemas/GiftCard"},"code":{"type":"string"}},"required":["giftCard","code"],"additionalProperties":false},"IssuedReviewReward":{"type":"object","properties":{"discountId":{"type":"string"},"code":{"type":"string"},"type":{"$ref":"#/components/schemas/ReviewRewardType"},"value":{"type":"integer","minimum":0,"maximum":9007199254740991},"used":{"type":"boolean"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"issuedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["discountId","code","type","value","used","expiresAt","issuedAt"],"additionalProperties":false},"JsonExport":{"type":"object","properties":{"filename":{"type":"string"},"json":{"type":"string"}},"required":["filename","json"],"additionalProperties":false},"JsonPatchOp":{"type":"object","properties":{"op":{"type":"string","enum":["add","remove","replace","move"]},"path":{"type":"string"},"from":{"type":"string"},"value":{"$ref":"#/components/schemas/Shared7"}},"required":["op","path"],"additionalProperties":false},"KeyDeliverySettings":{"type":"object","properties":{"pattern":{"anyOf":[{"$ref":"#/components/schemas/KeyPattern"},{"type":"null"}]},"instructions":{"type":"string","maxLength":2000}},"required":["pattern","instructions"],"additionalProperties":false},"KeyImportResult":{"type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicatesInInput":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicatesInPool":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"value":{"type":"string"}},"required":["line","value"],"additionalProperties":false}},"invalidCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stock":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["added","duplicatesInInput","duplicatesInPool","invalid","invalidCount","stock"],"additionalProperties":false},"KeyPattern":{"type":"string","minLength":1,"maxLength":200},"KeyPoolStats":{"type":"object","properties":{"available":{"type":"integer","minimum":0,"maximum":9007199254740991},"assigned":{"type":"integer","minimum":0,"maximum":9007199254740991},"byVariant":{"type":"array","items":{"type":"object","properties":{"variantId":{"$ref":"#/components/schemas/VariantId"},"available":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["variantId","available"],"additionalProperties":false}},"shared":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["available","assigned","byVariant","shared"],"additionalProperties":false},"KeyedPayOptions":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"}},"atCheckout":{"type":"array","items":{"type":"string"}},"readAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"note":{"type":["string","null"]},"inPage":{"type":"boolean"},"paymentMethodConfig":{"type":["string","null"]}},"required":["options","atCheckout","readAt","note","inPage","paymentMethodConfig"],"additionalProperties":false},"KeysBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"keys"},"title":{"default":"Your keys","type":"string","maxLength":120},"showDownloads":{"default":true,"type":"boolean"},"note":{"default":"Keep your keys private. They are also saved on your order page.","type":"string","maxLength":400}},"required":["id","type","title","showDownloads","note"],"additionalProperties":false},"Kpi":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"LatePaymentPolicy":{"type":"string","enum":["reprice","accept","manual"]},"LeafBlock":{"oneOf":[{"$ref":"#/components/schemas/HeadingBlock"},{"$ref":"#/components/schemas/TextBlock"},{"$ref":"#/components/schemas/ButtonBlock"},{"$ref":"#/components/schemas/ImageBlock"},{"$ref":"#/components/schemas/ProductBlock"},{"$ref":"#/components/schemas/DividerBlock"},{"$ref":"#/components/schemas/SpacerBlock"},{"$ref":"#/components/schemas/SocialBlock"},{"$ref":"#/components/schemas/HtmlBlock"}]},"LeakMatch":{"type":"object","properties":{"code":{"type":"string"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"buyerEmail":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"fileName":{"type":"string"},"version":{"type":"string"},"markedAt":{"$ref":"#/components/schemas/Timestamp"},"downloads":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderStatus":{"type":"string"}},"required":["code","orderId","orderNumber","buyerEmail","customerId","productId","productName","fileName","version","markedAt","downloads","orderStatus"],"additionalProperties":false},"LeakTraceResult":{"type":"object","properties":{"filename":{"type":"string"},"kind":{"anyOf":[{"$ref":"#/components/schemas/WatermarkKind"},{"type":"null"}]},"evidence":{"type":"array","items":{"type":"object","properties":{"where":{"type":"string"},"code":{"type":"string"}},"required":["where","code"],"additionalProperties":false}},"match":{"anyOf":[{"$ref":"#/components/schemas/LeakMatch"},{"type":"null"}]},"notes":{"type":"array","items":{"type":"string"}}},"required":["filename","kind","evidence","match","notes"],"additionalProperties":false},"LegalDetails":{"type":"object","properties":{"businessName":{"type":"string","maxLength":120},"registrationNumber":{"type":"string","maxLength":60},"vatNumber":{"type":"string","maxLength":40},"addressLine1":{"type":"string","maxLength":120},"addressLine2":{"type":"string","maxLength":120},"city":{"type":"string","maxLength":80},"postalCode":{"type":"string","maxLength":20},"region":{"type":"string","maxLength":80},"country":{"anyOf":[{"$ref":"#/components/schemas/CountryCode"},{"type":"null"}]}},"required":["businessName","registrationNumber","vatNumber","addressLine1","addressLine2","city","postalCode","region","country"],"additionalProperties":false},"LibraryLayoutType":{"type":"string","enum":["full","split","grid","list","carousel","stack","masonry","tabs","banner","strip","table","centered"]},"LicenseActivationId":{"type":"string","pattern":"^lact_[0-9a-hjkmnp-tv-z]{20}$"},"LicenseActor":{"type":"string","enum":["buyer","seller","loader","system"]},"LicenseClock":{"type":"string","enum":["purchase","activation"]},"LicenseDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/LicenseKeyId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"plan":{"$ref":"#/components/schemas/LicensePlanOut"},"keyMasked":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"buyerEmail":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/LicenseState"},"clock":{"$ref":"#/components/schemas/LicenseClock"},"startedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"activatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"devicesUsed":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxDevices":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"validations":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastValidatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"assignedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"productPaused":{"type":"boolean"},"extraSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revokedReason":{"type":"string"},"maxDevicesOverride":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"devices":{"type":"array","items":{"$ref":"#/components/schemas/LicenseDevice"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/LicenseEvent"}},"checkoutSessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"buyerResets":{"type":"object","properties":{"used30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"per30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["used30d","per30d"],"additionalProperties":false}},"required":["id","productId","productName","plan","keyMasked","orderId","orderNumber","buyerEmail","state","clock","startedAt","expiresAt","activatedAt","devicesUsed","maxDevices","validations","lastValidatedAt","assignedAt","productPaused","extraSeconds","revokedReason","maxDevicesOverride","devices","events","checkoutSessionId","buyerResets"],"additionalProperties":false},"LicenseDevice":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/LicenseActivationId"},"label":{"type":"string"},"fingerprint":{"type":"string"},"firstSeenAt":{"$ref":"#/components/schemas/Timestamp"},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"},"country":{"type":["string","null"]},"releasedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"releasedBy":{"anyOf":[{"$ref":"#/components/schemas/LicenseActor"},{"type":"null"}]}},"required":["id","label","fingerprint","firstSeenAt","lastSeenAt","country","releasedAt","releasedBy"],"additionalProperties":false},"LicenseEvent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/LicenseEventId"},"kind":{"$ref":"#/components/schemas/LicenseEventKind"},"actor":{"$ref":"#/components/schemas/LicenseActor"},"actorName":{"type":["string","null"]},"outcome":{"type":"string"},"summary":{"type":"string"},"country":{"type":["string","null"]},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","actor","actorName","outcome","summary","country","at"],"additionalProperties":false},"LicenseEventId":{"type":"string","pattern":"^levt_[0-9a-hjkmnp-tv-z]{20}$"},"LicenseEventKind":{"type":"string","enum":["validate","activate","device_reset","device_release","extend","compensate","revoke","restore","suspend","resume","add_time","set_expiry","set_max_devices","clock_start","expiring","expired","sales_paused","sales_resumed","keys_rotated"]},"LicenseExtendStart":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"payUrl":{"type":"string"},"accessToken":{"type":"string"}},"required":["sessionId","payUrl","accessToken"],"additionalProperties":false},"LicenseKeyId":{"type":"string","pattern":"^key_[0-9a-hjkmnp-tv-z]{20}$"},"LicenseKeyRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/LicenseKeyId"},"value":{"type":"string"},"status":{"type":"string","enum":["available","assigned","revoked"]},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"variantName":{"type":["string","null"]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"customerEmail":{"type":["string","null"]},"assignedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","value","status","variantId","variantName","orderId","orderNumber","customerEmail","assignedAt","createdAt"],"additionalProperties":false},"LicenseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LicenseRow"}},"counts":{"type":"object","propertyNames":{"$ref":"#/components/schemas/LicenseListFilter"},"additionalProperties":{"type":"integer","minimum":0,"maximum":9007199254740991},"required":["all","active","expiring","expired","not_started","revoked","suspended"]},"nextCursor":{"type":["string","null"]},"exactKey":{"type":"boolean"}},"required":["items","counts","nextCursor","exactKey"],"additionalProperties":false},"LicenseListFilter":{"type":"string","enum":["all","active","expiring","expired","not_started","revoked","suspended"]},"LicenseMetadata":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z0-9_.-]{1,40}$"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":500},{"type":"number"},{"type":"boolean"}]}},"LicensePlanOut":{"type":"object","properties":{"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"name":{"type":"string"},"duration":{"anyOf":[{"$ref":"#/components/schemas/DurationKey"},{"type":"null"}]},"label":{"type":"string"}},"required":["variantId","name","duration","label"],"additionalProperties":false},"LicenseRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/LicenseKeyId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"plan":{"$ref":"#/components/schemas/LicensePlanOut"},"keyMasked":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"buyerEmail":{"type":["string","null"]},"state":{"$ref":"#/components/schemas/LicenseState"},"clock":{"$ref":"#/components/schemas/LicenseClock"},"startedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"activatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"devicesUsed":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxDevices":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"validations":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastValidatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"assignedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"productPaused":{"type":"boolean"}},"required":["id","productId","productName","plan","keyMasked","orderId","orderNumber","buyerEmail","state","clock","startedAt","expiresAt","activatedAt","devicesUsed","maxDevices","validations","lastValidatedAt","assignedAt","productPaused"],"additionalProperties":false},"LicenseSettings":{"type":"object","properties":{"apiEnabled":{"default":false,"type":"boolean"},"clock":{"default":"purchase","$ref":"#/components/schemas/LicenseClock"},"hwid":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"maxDevices":{"default":1,"type":"integer","minimum":1,"maximum":50},"buyerResetsPer30d":{"default":2,"type":"integer","minimum":0,"maximum":30},"resetCooldownHours":{"default":24,"type":"integer","minimum":0,"maximum":720}},"required":["enabled","maxDevices","buyerResetsPer30d","resetCooldownHours"],"additionalProperties":false},"autoPause":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"when":{"default":"outage","$ref":"#/components/schemas/PauseWhen"},"storefront":{"default":"show_disabled","$ref":"#/components/schemas/PausedStorefront"},"blockValidation":{"default":true,"type":"boolean"},"compensate":{"default":true,"type":"boolean"},"notifyBuyers":{"default":true,"type":"boolean"}},"required":["enabled","when","storefront","blockValidation","compensate","notifyBuyers"],"additionalProperties":false},"extendEnabled":{"default":true,"type":"boolean"},"metadata":{"default":{},"$ref":"#/components/schemas/LicenseMetadata"},"rateLimitPerMinute":{"default":60,"type":"integer","minimum":10,"maximum":600}},"required":["apiEnabled","clock","hwid","autoPause","extendEnabled","metadata","rateLimitPerMinute"],"additionalProperties":false},"LicenseSignature":{"type":"object","properties":{"alg":{"type":"string","const":"Ed25519"},"keyId":{"type":"string"},"payload":{"type":"string"},"value":{"type":"string"}},"required":["alg","keyId","payload","value"],"additionalProperties":false},"LicenseState":{"type":"string","enum":["active","not_started","expired","revoked","suspended"]},"LicenseValidateResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/LicenseValidity"},"valid":{"type":"boolean"},"message":{"type":"string"},"licenseId":{"anyOf":[{"$ref":"#/components/schemas/LicenseKeyId"},{"type":"null"}]},"product":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"plan":{"anyOf":[{"$ref":"#/components/schemas/LicensePlanOut"},{"type":"null"}]},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"activatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"devices":{"anyOf":[{"type":"object","properties":{"used":{"type":"integer","minimum":0,"maximum":9007199254740991},"max":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["used","max"],"additionalProperties":false},{"type":"null"}]},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":500},{"type":"number"},{"type":"boolean"}]}},"nonce":{"type":["string","null"]},"issuedAt":{"$ref":"#/components/schemas/Timestamp"},"hwidHash":{"type":["string","null"]},"validUntil":{"$ref":"#/components/schemas/Timestamp"},"productStatus":{"default":null,"anyOf":[{"type":"object","properties":{"label":{"type":"string"},"note":{"type":"string"},"paused":{"type":"boolean"}},"required":["label","note","paused"],"additionalProperties":false},{"type":"null"}]},"signature":{"$ref":"#/components/schemas/LicenseSignature"}},"required":["status","valid","message","licenseId","product","plan","expiresAt","activatedAt","devices","metadata","nonce","issuedAt","hwidHash","validUntil","productStatus","signature"],"additionalProperties":false},"LicenseValidity":{"type":"string","enum":["valid","expired","revoked","hwid_mismatch","paused","invalid"]},"LimitedMethod":{"type":"string","enum":["card","paypal","crypto","bank"]},"LinkAdminDiscordResponse":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":false},"LinkMyCommunityResponse":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":false},"LinkedComponent":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"pageName":{"type":"string"},"label":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"},"severity":{"type":"string","enum":["operational","degraded","maintenance","outage"]}},"required":["name","color","severity"],"additionalProperties":false},"pausing":{"type":"boolean"}},"required":["id","name","pageName","label","pausing"],"additionalProperties":false},"LinkedSeller":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"type":"string"},"discordUserId":{"$ref":"#/components/schemas/DiscordObjectId"},"discordUsername":{"type":"string"},"linkedAt":{"$ref":"#/components/schemas/Timestamp"},"joined":{"type":"string","enum":["joined","not_joined","unknown"]},"roles":{"type":"array","items":{"type":"string"}},"syncedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"syncError":{"type":["string","null"]},"stores":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"planName":{"type":"string"},"status":{"type":"string"}},"required":["id","name","planName","status"],"additionalProperties":false}}},"required":["userId","name","email","discordUserId","discordUsername","linkedAt","joined","roles","syncedAt","syncError","stores"],"additionalProperties":false},"LintPluginResponse":{"type":"object","properties":{"diagnostics":{"type":"array","items":{"$ref":"#/components/schemas/PluginDiagnostic"}}},"required":["diagnostics"],"additionalProperties":false},"ListAffiliatesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/AffiliateCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListAlertsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Alert"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/AlertEvent"}}},"required":["items","events"],"additionalProperties":false},"ListAnnotationsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Annotation"}}},"required":["items"],"additionalProperties":false},"ListApiKeysResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}},"required":["items"],"additionalProperties":false},"ListApiRequestsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ApiRequestLog"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListAudienceSegmentsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AudienceSegment"}},"presets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"rules":{"$ref":"#/components/schemas/SegmentRules"}},"required":["name","description","rules"],"additionalProperties":false}},"events":{"type":"array","items":{"type":"string"}}},"required":["items","presets","events"],"additionalProperties":false},"ListBuilderRunsResponse":{"type":"object","properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/BuilderRun"}}},"required":["runs"],"additionalProperties":false},"ListBundlesResponse":{"type":"object","properties":{"bundles":{"type":"array","items":{"$ref":"#/components/schemas/BundleRow"}}},"required":["bundles"],"additionalProperties":false},"ListCampaignsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CampaignRow"}}},"required":["items"],"additionalProperties":false},"ListCannedRepliesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CannedReply"}}},"required":["items"],"additionalProperties":false},"ListCheckoutsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/CheckoutCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListCollectionsResponse":{"type":"object","properties":{"collections":{"type":"array","items":{"$ref":"#/components/schemas/StoreCollection"}}},"required":["collections"],"additionalProperties":false},"ListCommunityIncidentsResponse":{"type":"object","properties":{"incidents":{"type":"array","items":{"$ref":"#/components/schemas/CommunityIncident"}},"nextCursor":{"type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["incidents","nextCursor","total"],"additionalProperties":false},"ListCommunityMembersResponse":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/LinkedSeller"}},"nextCursor":{"type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["members","nextCursor","total"],"additionalProperties":false},"ListCommunityModerationResponse":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/CommunityModEvent"}},"nextCursor":{"type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["events","nextCursor","total"],"additionalProperties":false},"ListCommunityVerifiedResponse":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/VerifiedMember"}},"nextCursor":{"type":["string","null"]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["members","nextCursor","total"],"additionalProperties":false},"ListContactsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"nextCursor":{"type":["string","null"]},"counts":{"$ref":"#/components/schemas/AudienceCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListCustomerDuplicatesResponse":{"type":"object","properties":{"candidates":{"type":"array","items":{"$ref":"#/components/schemas/DuplicateCandidate"}}},"required":["candidates"],"additionalProperties":false},"ListCustomersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CustomerRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/CustomerCounts"},"countries":{"type":"array","items":{"type":"string"}}},"required":["items","nextCursor","counts","countries"],"additionalProperties":false},"ListDeletedProductsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"type":"string"},"deletedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","type","deletedAt"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false},"ListDeskCannedResponse":{"type":"array","items":{"$ref":"#/components/schemas/DeskCanned"}},"ListDiscordCheckoutsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscordCheckoutRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListDiscordCommandsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscordCommandEntry"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListDiscordDmsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscordDmRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListDiscordSyncLogResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscordSyncEntry"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListDiscountsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"counts":{"$ref":"#/components/schemas/DiscountCounts"}},"required":["items","counts"],"additionalProperties":false},"ListDisputesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DisputeRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/DisputeCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListEmailTemplatesGalleryResponse":{"type":"object","properties":{"gallery":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"doc":{"$ref":"#/components/schemas/EmailDocument"}},"required":["id","name","description","category","doc"],"additionalProperties":false}},"saved":{"type":"array","items":{"$ref":"#/components/schemas/SavedTemplate"}}},"required":["gallery","saved"],"additionalProperties":false},"ListEmailVersionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EmailVersion"}}},"required":["items"],"additionalProperties":false},"ListFlowsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}}},"required":["items"],"additionalProperties":false},"ListFraudChecksResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FraudCheckRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListFraudListsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FraudListEntry"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/FraudListCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListFraudReviewsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FraudReviewRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/FraudReviewCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListFraudRulesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FraudRule"}}},"required":["items"],"additionalProperties":false},"ListFunnelsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SavedFunnel"}}},"required":["items"],"additionalProperties":false},"ListGatewaysResponse":{"type":"object","properties":{"connections":{"type":"array","items":{"$ref":"#/components/schemas/GatewayConnection"}},"available":{"type":"array","items":{"$ref":"#/components/schemas/PlatformGateway"}}},"required":["connections","available"],"additionalProperties":false},"ListGiftCardProductsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"status":{"type":"string"},"sold":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productId","name","status","sold"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false},"ListGiftCardsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCard"}},"counts":{"$ref":"#/components/schemas/GiftCardCounts"},"outstandingMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["items","counts","outstandingMinor"],"additionalProperties":false},"ListGiftCodeReviewsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GiftCodeReview"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/GiftCodeReviewCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListImportsResponse":{"type":"object","properties":{"imports":{"type":"array","items":{"$ref":"#/components/schemas/ImportJob"}}},"required":["imports"],"additionalProperties":false},"ListInventoryResponse":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/InventoryRow"}},"nextCursor":{"default":null,"type":["string","null"]},"total":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countedUnits":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"low":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"out":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pools":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"counted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","low","out","pools","counted"],"additionalProperties":false},"pools":{"type":"object","properties":{"keysAvailable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"keysAssigned30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"productsLow":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["keysAvailable","keysAssigned30d","productsLow"],"additionalProperties":false}},"required":["rows","nextCursor","total","countedUnits","counts","pools"],"additionalProperties":false},"ListKeysResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LicenseKeyRow"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"stats":{"$ref":"#/components/schemas/KeyPoolStats"}},"required":["items","nextCursor","stats"],"additionalProperties":false},"ListManualMethodsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ManualPaymentMethod"}}},"required":["items"],"additionalProperties":false},"ListMcpCallsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/McpCall"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListNewsletterSubscribersResponse":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"last30Days":{"type":"integer","minimum":0,"maximum":9007199254740991},"subscribers":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"source":{"type":"string"},"page":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["email","source","page","createdAt"],"additionalProperties":false}}},"required":["total","last30Days","subscribers"],"additionalProperties":false},"ListNotificationDeliveriesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDelivery"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListNotificationsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InboxNotification"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/InboxCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListOAuthAppsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApp"}}},"required":["items"],"additionalProperties":false},"ListOAuthConnectionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OAuthConnection"}}},"required":["items"],"additionalProperties":false},"ListOfferRulesResponse":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/OfferRule"}}},"required":["rules"],"additionalProperties":false},"ListOrderInvoicesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceRow"}}},"required":["items"],"additionalProperties":false},"ListOrdersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/OrderCounts"},"checkouts":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CheckoutRow"}},"sequence":{"default":[],"type":"array","items":{"type":"string"}}},"required":["items","nextCursor","counts","checkouts","sequence"],"additionalProperties":false},"ListPagesResponse":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/StorePage"}}},"required":["pages"],"additionalProperties":false},"ListPendingActionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PendingAction"}},"now":{"$ref":"#/components/schemas/Timestamp"}},"required":["items","now"],"additionalProperties":false},"ListPendingAnnouncementsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SellerAnnouncement"}}},"required":["items"],"additionalProperties":false},"ListPlatformInvoicesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PlatformInvoiceRow"}}},"required":["items"],"additionalProperties":false},"ListPluginCatalogResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PluginCatalogEntry"}}},"required":["items"],"additionalProperties":false},"ListPluginKvResponse":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"preview":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updatedAt":{"type":"string"},"expiresAt":{"type":["string","null"]}},"required":["key","preview","bytes","updatedAt","expiresAt"],"additionalProperties":false}},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["items","limit"],"additionalProperties":false},"ListPluginRunsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PluginRun"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListPluginsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PluginSummary"}}},"required":["items"],"additionalProperties":false},"ListPopupsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Popup"}},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"draft":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paused":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"archived":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","live","draft","paused","archived"],"additionalProperties":false}},"required":["items","counts"],"additionalProperties":false},"ListProductPresetsResponse":{"type":"object","properties":{"presets":{"type":"array","items":{"$ref":"#/components/schemas/ProductPreset"}}},"required":["presets"],"additionalProperties":false},"ListProductStatusesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductStatusRow"}}},"required":["items"],"additionalProperties":false},"ListProductSubscribersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubscriber"}},"counts":{"type":"object","properties":{"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pastDue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ended":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["active","pastDue","ended"],"additionalProperties":false}},"required":["items","counts"],"additionalProperties":false},"ListProductsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/ProductCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListPromotionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"}},"counts":{"$ref":"#/components/schemas/PromotionCounts"}},"required":["items","counts"],"additionalProperties":false},"ListRescueImportsResponse":{"type":"object","properties":{"imports":{"type":"array","items":{"$ref":"#/components/schemas/RescueImportSummary"}},"allowance":{"$ref":"#/components/schemas/RescueAllowance"}},"required":["imports","allowance"],"additionalProperties":false},"ListResellPartnershipsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ResellPartnership"}},"counts":{"$ref":"#/components/schemas/ResellCounts"}},"required":["items","counts"],"additionalProperties":false},"ListResellerOrdersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ResellerOrder"}}},"required":["items"],"additionalProperties":false},"ListResellersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ResellerRow"}},"counts":{"$ref":"#/components/schemas/ResellerCounts"}},"required":["items","counts"],"additionalProperties":false},"ListReviewsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SellerReview"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/ReviewCounts"},"summary":{"$ref":"#/components/schemas/RatingSummary"}},"required":["items","nextCursor","counts","summary"],"additionalProperties":false},"ListSalesPausesResponse":{"type":"object","properties":{"pauses":{"type":"array","items":{"$ref":"#/components/schemas/SalesPause"}}},"required":["pauses"],"additionalProperties":false},"ListScheduledReportsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledReport"}}},"required":["items"],"additionalProperties":false},"ListSegmentsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}},"required":["items"],"additionalProperties":false},"ListSharesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReportShare"}}},"required":["items"],"additionalProperties":false},"ListStatusSubscribersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StatusSubscriber"}}},"required":["items"],"additionalProperties":false},"ListStockHistoryResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StockAdjustment"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"ListStoreAuditResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StoreAuditEntry"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"facets":{"$ref":"#/components/schemas/StoreAuditFacets"}},"required":["items","nextCursor","facets"],"additionalProperties":false},"ListStoreReviewsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SellerStoreReview"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"$ref":"#/components/schemas/StoreReviewCounts"}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListStorefrontKeysResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontKey"}}},"required":["items"],"additionalProperties":false},"ListStudioTemplateEventsResponse":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/TemplateEvent"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["events","nextCursor"],"additionalProperties":false},"ListStudioTemplatesResponse":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/TemplateSummary"}},"starters":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TemplateSlug"},"name":{"type":"string"},"version":{"$ref":"#/components/schemas/SemVer"}},"required":["id","name","version"],"additionalProperties":false}}},"required":["templates","starters"],"additionalProperties":false},"ListSuppressionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"reason":{"$ref":"#/components/schemas/SuppressionReason"},"source":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["email","reason","source","createdAt"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false},"ListTemplateReviewsResponse":{"type":"object","properties":{"releases":{"type":"array","items":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/TemplateSummary"},"release":{"$ref":"#/components/schemas/TemplateReleaseSummary"}},"required":["template","release"],"additionalProperties":false}}},"required":["releases"],"additionalProperties":false},"ListThemeAssetsResponse":{"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/ThemeAsset"}}},"required":["assets"],"additionalProperties":false},"ListThemeRevisionsResponse":{"type":"object","properties":{"revisions":{"type":"array","items":{"$ref":"#/components/schemas/ThemeRevisionSummary"}}},"required":["revisions"],"additionalProperties":false},"ListThemeTemplatesResponse":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/ThemeTemplate"}}},"required":["templates"],"additionalProperties":false},"ListThemeVersionsResponse":{"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/ThemeVersionSummary"}}},"required":["versions"],"additionalProperties":false},"ListThemesResponse":{"type":"object","properties":{"themes":{"type":"array","items":{"$ref":"#/components/schemas/ThemeSummary"}},"stock":{"type":"array","items":{"$ref":"#/components/schemas/StockTheme"}},"live":{"anyOf":[{"type":"object","properties":{"themeId":{"$ref":"#/components/schemas/ThemeId"},"versionId":{"$ref":"#/components/schemas/ThemeVersionId"}},"required":["themeId","versionId"],"additionalProperties":false},{"type":"null"}]}},"required":["themes","stock","live"],"additionalProperties":false},"ListTicketsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TicketSummary"}},"nextCursor":{"type":["string","null"]},"counts":{"$ref":"#/components/schemas/TicketCounts"},"tags":{"type":"array","items":{"type":"string"}}},"required":["items","nextCursor","counts","tags"],"additionalProperties":false},"ListToursResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TourProgress"}}},"required":["items"],"additionalProperties":false},"ListWebhookDeliveriesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDelivery"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"succeeded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","succeeded","failed","pending"],"additionalProperties":false}},"required":["items","nextCursor","counts"],"additionalProperties":false},"ListWebhookEndpointsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEndpoint"}},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["items","limit"],"additionalProperties":false},"ListWebhookEventsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ExplorerEvent"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","count"],"additionalProperties":false}}},"required":["items","nextCursor","types"],"additionalProperties":false},"LiveChatSettings":{"type":"object","properties":{"provider":{"default":"crisp","type":"string","enum":["crisp","tawk"]},"crispWebsiteId":{"default":"","anyOf":[{"type":"string","const":""},{"$ref":"#/components/schemas/CrispWebsiteId"}]},"tawkPropertyId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^[0-9a-f]{24}$"}]},"tawkWidgetId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^[0-9a-z]{6,12}$"}]}},"required":["provider","crispWebsiteId","tawkPropertyId","tawkWidgetId"],"additionalProperties":false},"LivePromotion":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PromotionId"},"name":{"type":"string"},"percentOffBps":{"$ref":"#/components/schemas/Bps"},"target":{"$ref":"#/components/schemas/PromotionTarget"},"collectionIds":{"type":"array","items":{"$ref":"#/components/schemas/CollectionId"}},"categoryIds":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CategoryId"}},"productIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"startsAt":{"$ref":"#/components/schemas/Timestamp"},"endsAt":{"$ref":"#/components/schemas/Timestamp"},"stacking":{"$ref":"#/components/schemas/PromotionStacking"},"banner":{"$ref":"#/components/schemas/PromotionBanner"}},"required":["id","name","percentOffBps","target","collectionIds","categoryIds","productIds","startsAt","endsAt","stacking","banner"],"additionalProperties":false},"LoginResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"challenge":{"default":null,"type":["string","null"]}},"required":["user","challenge"],"additionalProperties":false},"LoginSecondFactorResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"}},"required":["user"],"additionalProperties":false},"ManualMethodId":{"type":"string","pattern":"^mpm_[0-9a-hjkmnp-tv-z]{20}$"},"ManualPaymentMethod":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ManualMethodId"},"name":{"type":"string"},"instructions":{"type":"string"},"enabled":{"type":"boolean"},"payWithinHours":{"type":"integer","minimum":1,"maximum":720},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"awaiting":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","instructions","enabled","payWithinHours","position","awaiting","createdAt"],"additionalProperties":false},"MarkNotificationsResponse":{"type":"object","properties":{"unread":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["unread"],"additionalProperties":false},"MarketingOverview":{"type":"object","properties":{"audience":{"$ref":"#/components/schemas/AudienceCounts"},"growth":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"subscribed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unsubscribed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["day","subscribed","unsubscribed"],"additionalProperties":false}},"last30":{"type":"object","properties":{"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"opened":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unsubscribed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["sent","opened","clicked","orders","revenueMinor","unsubscribed"],"additionalProperties":false},"currency":{"type":"string"},"sending":{"type":"string","enum":["resend","console"]}},"required":["audience","growth","last30","currency","sending"],"additionalProperties":false},"MarketingProductPicksResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductPick"}}},"required":["items"],"additionalProperties":false},"MarketingSettings":{"type":"object","properties":{"doubleOptIn":{"type":"boolean"},"senderName":{"type":"string","maxLength":80},"replyTo":{"type":"string","maxLength":254},"footerText":{"type":"string","maxLength":400},"trackOpens":{"type":"boolean"},"trackClicks":{"type":"boolean"},"syncCheckoutConsent":{"type":"boolean"}},"required":["doubleOptIn","senderName","replyTo","footerText","trackOpens","trackClicks","syncCheckoutConsent"],"additionalProperties":false},"McpCall":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/McpCallId"},"server":{"$ref":"#/components/schemas/McpServerKind"},"tool":{"type":"string"},"outcome":{"$ref":"#/components/schemas/McpCallOutcome"},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"client":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":["string","null"]},"credential":{"$ref":"#/components/schemas/McpCredentialKind"}},"required":["name","version","credential"],"additionalProperties":false},"actor":{"type":["string","null"]},"detail":{"type":["string","null"]},"input":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","server","tool","outcome","status","durationMs","client","actor","detail","input","createdAt"],"additionalProperties":false},"McpCallId":{"type":"string","pattern":"^mcc_[0-9a-hjkmnp-tv-z]{20}$"},"McpCallOutcome":{"type":"string","enum":["ok","error","refused","invalid_input","confirmation_required","dry_run","replayed","rate_limited"]},"McpCredentialKind":{"type":"string","enum":["oauth","api_key","public"]},"McpServerKind":{"type":"string","enum":["seller","shop"]},"McpUsage":{"type":"object","properties":{"days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"series":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"calls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"writes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["day","calls","errors","writes"],"additionalProperties":false}},"clients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"calls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","calls","lastAt"],"additionalProperties":false}},"tools":{"type":"array","items":{"type":"object","properties":{"tool":{"type":"string"},"calls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tool","calls","errors"],"additionalProperties":false}},"totals":{"type":"object","properties":{"calls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refused":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"confirmations":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shopCalls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["calls","errors","refused","confirmations","shopCalls"],"additionalProperties":false}},"required":["days","series","clients","tools","totals"],"additionalProperties":false},"MeResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"stores":{"type":"array","items":{"$ref":"#/components/schemas/StoreSummary"}},"impersonation":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ImpersonationState"},{"type":"null"}]}},"required":["user","stores","impersonation"],"additionalProperties":false},"MediaAsset":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/MediaAssetId"},"folderId":{"anyOf":[{"$ref":"#/components/schemas/MediaFolderId"},{"type":"null"}]},"filename":{"type":"string"},"kind":{"$ref":"#/components/schemas/MediaKind"},"visibility":{"$ref":"#/components/schemas/MediaVisibility"},"contentType":{"type":"string"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"pages":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"sha256":{"type":["string","null"]},"alt":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"url":{"type":["string","null"]},"previewUrl":{"type":["string","null"]},"posterUrl":{"type":["string","null"]},"scan":{"$ref":"#/components/schemas/MediaScan"},"usage":{"type":"array","items":{"$ref":"#/components/schemas/MediaUsageRef"}},"version":{"type":"integer","minimum":1,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","folderId","filename","kind","visibility","contentType","bytes","width","height","pages","sha256","alt","tags","url","previewUrl","posterUrl","scan","usage","version","createdAt","updatedAt"],"additionalProperties":false},"MediaAssetId":{"type":"string","pattern":"^upl_[0-9a-hjkmnp-tv-z]{20}$"},"MediaBulkResult":{"type":"object","properties":{"changed":{"type":"integer","minimum":0,"maximum":9007199254740991},"inUse":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/MediaAssetId"},"filename":{"type":"string"},"usage":{"type":"array","items":{"$ref":"#/components/schemas/MediaUsageRef"}}},"required":["id","filename","usage"],"additionalProperties":false}}},"required":["changed","inUse"],"additionalProperties":false},"MediaFolder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/MediaFolderId"},"parentId":{"anyOf":[{"$ref":"#/components/schemas/MediaFolderId"},{"type":"null"}]},"name":{"type":"string"},"assetCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","parentId","name","assetCount","createdAt"],"additionalProperties":false},"MediaFolderId":{"type":"string","pattern":"^mfd_[0-9a-hjkmnp-tv-z]{20}$"},"MediaId":{"type":"string","pattern":"^med_[0-9a-hjkmnp-tv-z]{20}$"},"MediaKind":{"type":"string","enum":["image","video","audio","pdf","archive","text","file"]},"MediaLibrary":{"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/MediaAsset"}},"folders":{"type":"array","items":{"$ref":"#/components/schemas/MediaFolder"}},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["tag","count"],"additionalProperties":false}},"usage":{"$ref":"#/components/schemas/MediaUsageSummary"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["assets","folders","tags","usage","total"],"additionalProperties":false},"MediaLink":{"type":"object","properties":{"url":{"type":"string"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["url","expiresAt"],"additionalProperties":false},"MediaQuota":{"type":"object","properties":{"storageBytes":{"type":"integer","minimum":0,"maximum":10995116277760},"fileCount":{"type":"integer","minimum":0,"maximum":10000000},"maxFileBytes":{"type":"integer","minimum":1,"maximum":2147483647}},"required":["storageBytes","fileCount","maxFileBytes"],"additionalProperties":false},"MediaScan":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/MediaScanStatus"},"engine":{"type":"string"},"detail":{"type":["string","null"]},"scannedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["status","engine","detail","scannedAt"],"additionalProperties":false},"MediaScanStatus":{"type":"string","enum":["unscanned","pending","clean","infected","error"]},"MediaUploadIntent":{"type":"object","properties":{"intentId":{"$ref":"#/components/schemas/MediaAssetId"},"url":{"type":"string"},"method":{"type":"string","const":"PUT"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sha256":{"$ref":"#/components/schemas/Sha256Hex"}},"required":["intentId","url","method","headers","expiresAt","bytes","sha256"],"additionalProperties":false},"MediaUsageKind":{"type":"string","enum":["product","product_file","theme","email","popup","store","collection","pay"]},"MediaUsageRef":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/MediaUsageKind"},"refId":{"type":"string"},"label":{"type":"string"},"href":{"type":["string","null"]}},"required":["kind","refId","label","href"],"additionalProperties":false},"MediaUsageSummary":{"type":"object","properties":{"planName":{"type":"string"},"showPlan":{"default":false,"type":"boolean"},"quota":{"$ref":"#/components/schemas/MediaQuota"},"usedBytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"fileCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"reservedBytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["planName","showPlan","quota","usedBytes","fileCount","reservedBytes"],"additionalProperties":false},"MediaVisibility":{"type":"string","enum":["public","private"]},"MemberAttributes":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"department":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"tags":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}},"required":["userId","department","tags"],"additionalProperties":false},"MemberRoleKind":{"type":"string","enum":["owner","admin","staff","support","finance","custom"]},"MetaPixelId":{"type":"string","pattern":"^\\d{10,20}$"},"MetaPixelSettings":{"type":"object","properties":{"pixelId":{"default":"","anyOf":[{"type":"string","const":""},{"$ref":"#/components/schemas/MetaPixelId"}]},"ecommerce":{"default":true,"type":"boolean"}},"required":["pixelId","ecommerce"],"additionalProperties":false},"MethodDiscount":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/PaymentMethod"},"bps":{"type":"integer","minimum":100,"maximum":3000}},"required":["method","bps"],"additionalProperties":false},"MethodHealth":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/MethodHealthStatus"},"detail":{"type":"string"},"checkouts7d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid7d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastPaidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["status","detail","checkouts7d","paid7d","lastPaidAt"],"additionalProperties":false},"MethodHealthStatus":{"type":"string","enum":["healthy","attention","down","idle"]},"MethodKey":{"type":"string","pattern":"^[a-z_]{3,20}:[a-z0-9_]{3,40}$"},"MethodLimit":{"type":"object","properties":{"minMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"maxMinor":{"anyOf":[{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["minMinor","maxMinor"],"additionalProperties":false},"MethodLimits":{"type":"object","properties":{"methods":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/LimitedMethod"},"additionalProperties":{"$ref":"#/components/schemas/MethodLimit"}},"newBuyerCardMaxMinor":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["methods","newBuyerCardMaxMinor"],"additionalProperties":false},"MethodMultiplier":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/PaymentMethod"},"bps":{"type":"integer","minimum":5000,"maximum":20000}},"required":["method","bps"],"additionalProperties":false},"MethodRule":{"type":"object","properties":{"enabled":{"type":"boolean"},"countries":{"$ref":"#/components/schemas/CountryRule"},"minMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"maxMinor":{"anyOf":[{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["enabled","countries","minMinor","maxMinor"],"additionalProperties":false},"Metric":{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov"]},"MicroUsd":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"MinorUnits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ModAction":{"type":"string","enum":["automod","timeout","untimeout","kick","ban","unban","delete"]},"ModeChangeResult":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/PaySettings"},"switchedToOwn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unavailable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"restored":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["settings","switchedToOwn","unavailable","restored"],"additionalProperties":false},"MonthlyRow":{"type":"object","properties":{"month":{"$ref":"#/components/schemas/IsoDate"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"grossMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountsMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netSalesMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"feesMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundsMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputesMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"taxMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"earningsMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"payoutsMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"closingMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","currency","orders","grossMinor","discountsMinor","netSalesMinor","feesMinor","refundsMinor","disputesMinor","taxMinor","earningsMinor","payoutsMinor","closingMinor"],"additionalProperties":false},"MonthlyStatements":{"type":"object","properties":{"timezone":{"type":"string"},"months":{"type":"array","items":{"$ref":"#/components/schemas/MonthlyRow"}}},"required":["timezone","months"],"additionalProperties":false},"MyCommunity":{"type":"object","properties":{"available":{"type":"boolean"},"linked":{"anyOf":[{"type":"object","properties":{"discordUserId":{"$ref":"#/components/schemas/DiscordObjectId"},"username":{"type":"string"},"linkedAt":{"$ref":"#/components/schemas/Timestamp"},"joined":{"type":"string","enum":["joined","not_joined","unknown"]},"roles":{"type":"array","items":{"type":"string"}},"syncError":{"type":["string","null"]}},"required":["discordUserId","username","linkedAt","joined","roles","syncError"],"additionalProperties":false},{"type":"null"}]},"inviteUrl":{"type":["string","null"]},"serverName":{"type":["string","null"]}},"required":["available","linked","inviteUrl","serverName"],"additionalProperties":false},"MyDeskOverview":{"type":"object","properties":{"tickets":{"type":"array","items":{"$ref":"#/components/schemas/MyDeskTicket"}},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9-]{1,24}$"},"label":{"type":"string","minLength":1,"maxLength":80},"emoji":{"default":null,"anyOf":[{"type":"string","minLength":1,"maxLength":16},{"type":"null"}]},"hint":{"default":"","type":"string","maxLength":100},"priority":{"default":"normal","$ref":"#/components/schemas/TicketPriority"},"responseTime":{"type":"string"}},"required":["id","label","emoji","hint","priority","responseTime"],"additionalProperties":false}},"stores":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"responseTime":{"type":"string"},"discordInvite":{"type":["string","null"]}},"required":["tickets","topics","stores","responseTime","discordInvite"],"additionalProperties":false},"MyDeskTicket":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskTicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"topic":{"type":"string"},"topicLabel":{"type":"string"},"channel":{"$ref":"#/components/schemas/DeskChannel"},"lastMessageAt":{"$ref":"#/components/schemas/Timestamp"},"lastMessageFrom":{"type":"string","enum":["you","shopfast"]},"preview":{"type":"string"},"unread":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","number","subject","status","topic","topicLabel","channel","lastMessageAt","lastMessageFrom","preview","unread","createdAt"],"additionalProperties":false},"MyDeskTicketDetail":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/MyDeskTicket"},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskMessageId"},"from":{"type":"string","enum":["you","shopfast","system"]},"authorName":{"type":"string"},"body":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/DeskAttachment"}},"via":{"$ref":"#/components/schemas/DeskChannel"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","from","authorName","body","attachments","via","createdAt"],"additionalProperties":false}},"canRate":{"type":"boolean"},"satisfaction":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}]},"discordThreadUrl":{"type":["string","null"]}},"required":["ticket","messages","canRate","satisfaction","discordThreadUrl"],"additionalProperties":false},"NextPayoutBlock":{"type":"string","enum":["own_gateway","suspended","payout_hold","email_unverified","below_minimum","no_payout_method"]},"NotificationChannel":{"type":"string","enum":["owner_email","team_email","discord","telegram"]},"NotificationDelivery":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/NotificationDeliveryId"},"event":{"anyOf":[{"$ref":"#/components/schemas/NotificationEvent"},{"type":"null"}]},"channel":{"$ref":"#/components/schemas/NotificationChannel"},"target":{"type":"string"},"status":{"$ref":"#/components/schemas/DeliveryStatus"},"detail":{"type":"string"},"isTest":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","event","channel","target","status","detail","isTest","createdAt"],"additionalProperties":false},"NotificationDeliveryId":{"type":"string","pattern":"^ntf_[0-9a-hjkmnp-tv-z]{20}$"},"NotificationEvent":{"type":"string","enum":["order_paid","order_refunded","order_disputed","product_low_stock","product_out_of_stock","product_restocked","review_posted","subscription_renewed","subscription_cancelled","payout_sent","team_member_joined","checkout_blocked","security_alert","ticket_opened","ticket_replied","ticket_sla_breached","ticket_rated","discord_problem","payment_waiting","payment_review"]},"NotificationId":{"type":"string","pattern":"^inb_[0-9a-hjkmnp-tv-z]{20}$"},"NotificationKind":{"type":"string","enum":["order","low_stock","dispute","claim","review","payout","webhook_failed","announcement","affiliate","reseller","support"]},"NotificationRule":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/NotificationEvent"},"ownerEmail":{"type":"boolean"},"teamEmail":{"type":"boolean"},"discord":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["event","ownerEmail","teamEmail","discord","telegram"],"additionalProperties":false},"NotificationSettings":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/NotificationRule"}},"owner":{"type":"object","properties":{"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"}},"required":["name","email"],"additionalProperties":false},"teamRecipients":{"type":"array","items":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"roleName":{"type":"string"},"enabled":{"type":"boolean"}},"required":["userId","name","email","roleName","enabled"],"additionalProperties":false}},"discord":{"type":"object","properties":{"configured":{"type":"boolean"},"hint":{"type":["string","null"]}},"required":["configured","hint"],"additionalProperties":false},"telegram":{"type":"object","properties":{"configured":{"type":"boolean"},"chatId":{"type":["string","null"]},"botName":{"type":["string","null"]}},"required":["configured","chatId","botName"],"additionalProperties":false},"simulated":{"type":"boolean"},"recent":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDelivery"}}},"required":["rules","owner","teamRecipients","discord","telegram","simulated","recent"],"additionalProperties":false},"NotificationSummaryResponse":{"type":"object","properties":{"unread":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"latest":{"type":"array","items":{"$ref":"#/components/schemas/InboxNotification"}}},"required":["unread","latest"],"additionalProperties":false},"NotificationTone":{"type":"string","enum":["accent","good","warn","bad","neutral"]},"OAuthApp":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OAuthAppId"},"name":{"type":"string"},"description":{"type":"string"},"homepageUrl":{"type":["string","null"]},"clientId":{"type":"string"},"secretHint":{"type":"string"},"redirectUris":{"type":"array","items":{"type":"string"}},"scopes":{"$ref":"#/components/schemas/ApiKeyScopes"},"status":{"type":"string","enum":["active","disabled"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"installs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","description","homepageUrl","clientId","secretHint","redirectUris","scopes","status","createdAt","installs"],"additionalProperties":false},"OAuthAppId":{"type":"string","pattern":"^oap_[0-9a-hjkmnp-tv-z]{20}$"},"OAuthClientRegistration":{"type":"string","enum":["manual","dynamic","metadata"]},"OAuthConnection":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OAuthGrantId"},"kind":{"default":"app","type":"string","enum":["app","mcp"]},"registration":{"default":"manual","$ref":"#/components/schemas/OAuthClientRegistration"},"appName":{"type":"string"},"publisher":{"type":"string"},"homepageUrl":{"type":["string","null"]},"scopes":{"$ref":"#/components/schemas/ApiKeyScopes"},"approvedBy":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","kind","registration","appName","publisher","homepageUrl","scopes","approvedBy","createdAt","lastUsedAt"],"additionalProperties":false},"OAuthConsent":{"type":"object","properties":{"app":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"homepageUrl":{"type":["string","null"]},"publisher":{"type":"string"},"clientId":{"type":"string"}},"required":["name","description","homepageUrl","publisher","clientId"],"additionalProperties":false},"scopes":{"type":"array","items":{"type":"object","properties":{"area":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"level":{"type":"string","enum":["read","write"]}},"required":["area","label","description","level"],"additionalProperties":false}},"redirectUri":{"type":"string"},"stores":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"},"canApprove":{"type":"boolean"},"alreadyConnected":{"type":"boolean"},"aiAccess":{"default":true,"type":"boolean"}},"required":["id","name","handle","canApprove","alreadyConnected","aiAccess"],"additionalProperties":false}},"client":{"default":{"registration":"manual","verified":true,"redirectHost":"","logoUri":null},"type":"object","properties":{"registration":{"$ref":"#/components/schemas/OAuthClientRegistration"},"verified":{"type":"boolean"},"redirectHost":{"type":"string"},"logoUri":{"type":["string","null"]}},"required":["registration","verified","redirectHost","logoUri"],"additionalProperties":false},"mcp":{"default":false,"type":"boolean"}},"required":["app","scopes","redirectUri","stores","client","mcp"],"additionalProperties":false},"OAuthGrantId":{"type":"string","pattern":"^ogr_[0-9a-hjkmnp-tv-z]{20}$"},"OfferDiscount":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"percent"},"bps":{"type":"integer","minimum":1,"maximum":10000}},"required":["kind","bps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fixed_price"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["kind","priceMinor"],"additionalProperties":false}]},"OfferKind":{"type":"string","enum":["order_bump","upsell","cross_sell"]},"OfferPlacement":{"type":"string","enum":["cart","checkout","product_page"]},"OfferRule":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OfferRuleId"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/OfferKind"},"triggerProductIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"offerProductId":{"$ref":"#/components/schemas/ProductId"},"offerVariantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"discount":{"$ref":"#/components/schemas/OfferDiscount"},"headline":{"type":"string"},"body":{"type":"string"},"placement":{"$ref":"#/components/schemas/OfferPlacement"},"enabled":{"type":"boolean"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"regularPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"offerPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"conversions30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenue30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","kind","triggerProductIds","offerProductId","offerVariantId","discount","headline","body","placement","enabled","position","regularPriceMinor","offerPriceMinor","currency","conversions30d","revenue30dMinor","updatedAt"],"additionalProperties":false},"OfferRuleId":{"type":"string","pattern":"^offr_[0-9a-hjkmnp-tv-z]{20}$"},"Ok":{"type":"object","properties":{"ok":{"type":"boolean","const":true}},"required":["ok"],"additionalProperties":false},"Onboarding":{"type":"object","properties":{"steps":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OnboardingStepId"},"title":{"type":"string"},"description":{"type":"string"},"done":{"type":"boolean"}},"required":["id","title","description","done"],"additionalProperties":false}},"completed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["steps","completed","total"],"additionalProperties":false},"OnboardingStepId":{"type":"string","enum":["create_store","add_product","customize_store","choose_payments","test_sale","connect_domain"]},"OpenApiDocument":{"type":"object","properties":{"openapi":{"type":"string"},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}},"required":["title","version"],"additionalProperties":{}},"paths":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared8"}},"components":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared9"}}},"required":["openapi","info","paths","components"],"additionalProperties":{}},"Order":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"storeId":{"$ref":"#/components/schemas/StoreId"},"customer":{"$ref":"#/components/schemas/CustomerRef"},"items":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"fees":{"$ref":"#/components/schemas/FeeBreakdown"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"coveredBy":{"default":null,"anyOf":[{"$ref":"#/components/schemas/FreeCover"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/OrderStatus"},"isTest":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"refundedMinor":{"default":0,"minimum":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["id","number","storeId","customer","items","fees","provider","paymentMethod","coveredBy","status","isTest","createdAt","paidAt","refundedMinor"],"additionalProperties":false},"OrderCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fulfilled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refunded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"partiallyRefunded":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"awaitingPayment":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","pending","paid","fulfilled","refunded","disputed","failed","partiallyRefunded","awaitingPayment"],"additionalProperties":false},"OrderDeliverables":{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/DeliveredKey"}},"downloads":{"type":"array","items":{"$ref":"#/components/schemas/DeliveredDownload"}},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/BuyerSubscription"}},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldAnswer"}},"notes":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/DeliveredNote"}},"redirectUrl":{"default":null,"type":["string","null"]},"giftCards":{"default":[],"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"last4":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"balanceMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["code","last4","amountMinor","balanceMinor","currency"],"additionalProperties":false}}},"required":["orderId","number","keys","downloads","subscriptions","customFields","notes","redirectUrl","giftCards"],"additionalProperties":false},"OrderDeliveredKey":{"type":"object","properties":{"id":{"type":"string"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"value":{"type":"string"},"status":{"type":"string","enum":["assigned","revoked"]},"assignedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","productId","productName","value","status","assignedAt"],"additionalProperties":false},"OrderDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"storeId":{"$ref":"#/components/schemas/StoreId"},"customer":{"$ref":"#/components/schemas/CustomerRef"},"items":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"fees":{"$ref":"#/components/schemas/FeeBreakdown"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"coveredBy":{"default":null,"anyOf":[{"$ref":"#/components/schemas/FreeCover"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/OrderStatus"},"isTest":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"refundedMinor":{"default":0,"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentStep"}},"refunds":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/OrderRefund"}},"customFields":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["id","label","value"],"additionalProperties":false}},"buyerNote":{"default":"","type":"string"},"client":{"default":null,"anyOf":[{"type":"object","properties":{"ip":{"type":["string","null"]},"country":{"type":["string","null"]},"userAgent":{"type":["string","null"]},"proxy":{"type":"boolean"}},"required":["ip","country","userAgent","proxy"],"additionalProperties":false},{"type":"null"}]},"discounts":{"default":[],"type":"array","items":{"type":"object","properties":{"code":{"type":["string","null"]},"title":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["code","title","amountMinor"],"additionalProperties":false}},"giftCard":{"default":null,"anyOf":[{"type":"object","properties":{"last4":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["last4","amountMinor"],"additionalProperties":false},{"type":"null"}]},"storeCreditMinor":{"default":0,"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"affiliate":{"default":null,"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}},"required":["id","name","code"],"additionalProperties":false},{"type":"null"}]},"payment":{"default":{"providerPaymentId":null,"providerUrl":null,"mode":null},"type":"object","properties":{"providerPaymentId":{"type":["string","null"]},"providerUrl":{"type":["string","null"]},"mode":{"anyOf":[{"type":"string","enum":["test","live"]},{"type":"null"}]}},"required":["providerPaymentId","providerUrl","mode"],"additionalProperties":false},"delivered":{"default":{"keys":[],"downloads":[],"discordRoles":[],"giftCards":[]},"type":"object","properties":{"keys":{"type":"array","items":{"$ref":"#/components/schemas/OrderDeliveredKey"}},"downloads":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"downloads":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productId","name","downloads"],"additionalProperties":false}},"discordRoles":{"type":"array","items":{"type":"object","properties":{"roleName":{"type":"string"},"status":{"type":"string"}},"required":["roleName","status"],"additionalProperties":false}},"giftCards":{"type":"array","items":{"type":"object","properties":{"last4":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["last4","amountMinor"],"additionalProperties":false}}},"required":["keys","downloads","discordRoles","giftCards"],"additionalProperties":false},"notes":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/OrderNote"}},"manual":{"default":null,"anyOf":[{"type":"object","properties":{"methodName":{"type":"string"},"reference":{"type":"string"}},"required":["methodName","reference"],"additionalProperties":false},{"type":"null"}]},"blocked":{"default":{"email":false,"ip":false},"type":"object","properties":{"email":{"type":"boolean"},"ip":{"type":"boolean"}},"required":["email","ip"],"additionalProperties":false},"discordUserId":{"default":null,"type":["string","null"]},"orderPageUrl":{"default":null,"type":["string","null"]},"fulfilledAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"refundedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"attention":{"default":null,"anyOf":[{"type":"object","properties":{"reason":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["reason","at"],"additionalProperties":false},{"type":"null"}]},"claims":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["claim","chargeback"]},"status":{"type":"string"},"reason":{"type":"string"},"openedAt":{"$ref":"#/components/schemas/Timestamp"},"closedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","kind","status","reason","openedAt","closedAt"],"additionalProperties":false}}},"required":["id","number","storeId","customer","items","fees","provider","paymentMethod","coveredBy","status","isTest","createdAt","paidAt","refundedMinor","steps","refunds","customFields","buyerNote","client","discounts","giftCard","storeCreditMinor","affiliate","payment","delivered","notes","manual","blocked","discordUserId","orderPageUrl","fulfilledAt","refundedAt","attention","claims"],"additionalProperties":false},"OrderDocuments":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InvoiceId"},"kind":{"$ref":"#/components/schemas/InvoiceKind"},"number":{"type":"string"},"issueDate":{"$ref":"#/components/schemas/IsoDate"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"token":{"type":"string"}},"required":["id","kind","number","issueDate","totalMinor","currency","token"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false},"OrderExport":{"type":"object","properties":{"filename":{"type":"string"},"contentType":{"type":"string"},"body":{"type":"string"},"rows":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["filename","contentType","body","rows"],"additionalProperties":false},"OrderId":{"type":"string","pattern":"^ord_[0-9a-hjkmnp-tv-z]{20}$"},"OrderItem":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"unitPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"variantName":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"discountMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"taxRateBps":{"$ref":"#/components/schemas/Bps"},"taxCategory":{"$ref":"#/components/schemas/TaxCategory"}},"required":["productId","name","type","quantity","unitPriceMinor"],"additionalProperties":false},"OrderNote":{"type":"object","properties":{"id":{"type":"string"},"body":{"type":"string"},"authorName":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","body","authorName","createdAt"],"additionalProperties":false},"OrderPage":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"status":{"type":"string","enum":["open","paid","expired"]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"items":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unitPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"variantName":{"default":null,"type":["string","null"]},"imageUrl":{"default":null,"type":["string","null"]}},"required":["productId","name","type","quantity","unitPriceMinor","variantName","imageUrl"],"additionalProperties":false}},"subtotalMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountMinor":{"$ref":"#/components/schemas/MinorUnits"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscount"}},"giftCardMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxRateBps":{"$ref":"#/components/schemas/Bps"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxIncluded":{"default":false,"type":"boolean"},"tipMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"buyerEmailMasked":{"type":"string"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"order":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"steps":{"type":"array","items":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/FulfillmentKind"},"status":{"$ref":"#/components/schemas/StepStatus"},"detail":{"type":"string"}},"required":["kind","status","detail"],"additionalProperties":false}},"held":{"default":false,"type":"boolean"},"refundedMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"refundedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","number","status","paidAt","steps","held","refundedMinor","refundedAt"],"additionalProperties":false},{"type":"null"}]},"deliverables":{"anyOf":[{"$ref":"#/components/schemas/OrderDeliverables"},{"type":"null"}]},"canCreateAccount":{"type":"boolean"},"expiresAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"storeCreditMinor":{"default":0,"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"manual":{"default":null,"anyOf":[{"type":"object","properties":{"methodName":{"type":"string"},"instructions":{"type":"string"},"reference":{"type":"string"}},"required":["methodName","instructions","reference"],"additionalProperties":false},{"type":"null"}]},"payPage":{"default":null,"type":["string","null"]},"test":{"type":"boolean"}},"required":["sessionId","status","currency","items","subtotalMinor","discountMinor","discounts","giftCardMinor","taxRateBps","taxMinor","totalMinor","taxIncluded","tipMinor","buyerEmailMasked","paymentModel","order","deliverables","canCreateAccount","expiresAt","storeCreditMinor","manual","payPage"],"additionalProperties":false},"OrderRefund":{"type":"object","properties":{"id":{"type":"string"},"amountMinor":{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},"reason":{"type":"string"},"destination":{"type":"string","enum":["original","store_credit"]},"source":{"type":"string","enum":["seller","provider"]},"providerRefundId":{"type":["string","null"]},"actorName":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","amountMinor","reason","destination","source","providerRefundId","actorName","createdAt"],"additionalProperties":false},"OrderRefundOffers":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/CreditRefundSettings"},"offer":{"anyOf":[{"$ref":"#/components/schemas/RefundOffer"},{"type":"null"}]}},"required":["settings","offer"],"additionalProperties":false},"OrderStats":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/OrderStatsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"from":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"timezone":{"type":"string"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatusStat"}},"totals":{"type":"object","properties":{"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"grossMinor":{"$ref":"#/components/schemas/MinorUnits"},"refundedMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"averageOrderMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["orders","grossMinor","refundedMinor","netMinor","averageOrderMinor"],"additionalProperties":false},"awaitingPayment":{"type":"integer","minimum":0,"maximum":9007199254740991},"abandoned":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["period","currency","from","timezone","groups","totals","awaitingPayment","abandoned"],"additionalProperties":false},"OrderStatsPeriod":{"type":"string","enum":["today","7d","4w","all"]},"OrderStatus":{"type":"string","enum":["pending","paid","fulfilled","partially_fulfilled","refunded","disputed","failed"]},"OrderStatusStat":{"type":"object","properties":{"group":{"type":"string","enum":["paid","completed","pending","refunded","partially_refunded","disputed","failed"]},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["group","count","revenueMinor"],"additionalProperties":false},"OrderSummaryBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"order_summary"},"title":{"default":"Order summary","type":"string","maxLength":120},"showTotal":{"default":true,"type":"boolean"}},"required":["id","type","title","showTotal"],"additionalProperties":false},"OutOfStockBehavior":{"type":"string","enum":["hide","show_sold_out","allow_preorder"]},"OverpaymentPolicy":{"type":"string","enum":["keep","store_credit"]},"OverviewDay":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"gmvMinor":{"$ref":"#/components/schemas/MinorUnits"},"platformRevenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"planRevenueMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["date","gmvMinor","platformRevenueMinor","planRevenueMinor"],"additionalProperties":false},"OwnGatewayTax":{"type":"string","enum":["none","included_buyer_rate","included_fixed","exempt"]},"OwnedLicense":{"type":"object","properties":{"id":{"type":"string"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"value":{"type":"string"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"assignedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","productId","productName","value","orderId","orderNumber","assignedAt"],"additionalProperties":false},"OwnedProduct":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"imageUrl":{"default":null,"type":["string","null"]},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"firstPurchasedAt":{"$ref":"#/components/schemas/Timestamp"},"orders":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["productId","name","type","imageUrl","quantity","firstPurchasedAt","orders"],"additionalProperties":false},"PageDataResponse":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontProduct"}},"missing":{"type":"array","items":{"type":"string"}},"redirects":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false}},"slices":{"type":"array","items":{"$ref":"#/components/schemas/CollectionSlice"}},"generatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["products","missing","redirects","slices","generatedAt"],"additionalProperties":false},"PageHandle":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"PageId":{"type":"string","pattern":"^pg_[0-9a-hjkmnp-tv-z]{20}$"},"PageRow":{"type":"object","properties":{"path":{"type":"string"},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"entries":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"exits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"exitRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avgTimeMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avgScrollPct":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","views","visitors","entries","exits","exitRateBps","avgTimeMs","avgScrollPct","previousViews"],"additionalProperties":false},"PagesReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totals":{"type":"object","properties":{"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avgTimeMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avgScrollPct":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"uniquePaths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["views","previousViews","avgTimeMs","avgScrollPct","uniquePaths"],"additionalProperties":false},"pages":{"type":"array","items":{"$ref":"#/components/schemas/PageRow"}},"landing":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bounceRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversionRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","sessions","bounceRateBps","conversions","conversionRateBps","revenueMinor"],"additionalProperties":false}},"exits":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"exits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"exitRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","exits","views","exitRateBps"],"additionalProperties":false}},"scroll":{"type":"array","items":{"type":"object","properties":{"depth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"leaves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shareBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["depth","leaves","shareBps"],"additionalProperties":false}},"time":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"maxMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"leaves":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["label","maxMs","leaves"],"additionalProperties":false}}},"required":["period","currency","totals","pages","landing","exits","scroll","time"],"additionalProperties":false},"PaidPeriod":{"type":"object","properties":{"planName":{"type":"string"},"start":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"end":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"type":"string"},"daysLeft":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["planName","start","end","paidMinor","currency","daysLeft"],"additionalProperties":false},"PauseWhen":{"type":"string","enum":["outage","degraded","not_live"]},"PausedStorefront":{"type":"string","enum":["show_disabled","hide"]},"PayAccessMode":{"type":"string","enum":["open","application","disabled"]},"PayAccessState":{"type":"string","enum":["open","not_applied","draft","in_review","info_requested","approved","rejected","disabled","suspended"]},"PayApplication":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayApplicationId"},"status":{"$ref":"#/components/schemas/PayApplicationStatus"},"answers":{"$ref":"#/components/schemas/PayApplicationDraft"},"kyc":{"$ref":"#/components/schemas/PayKycDraft"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/PayDocument"}},"infoRequest":{"type":["string","null"]},"decisionReason":{"type":["string","null"]},"submittedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"events":{"type":"array","items":{"$ref":"#/components/schemas/PayEvent"}}},"required":["id","status","answers","kyc","documents","infoRequest","decisionReason","submittedAt","decidedAt","createdAt","updatedAt","events"],"additionalProperties":false},"PayApplicationCounts":{"type":"object","properties":{"submitted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"info_requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"draft":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"withdrawn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["submitted","info_requested","approved","rejected","draft","withdrawn","all"],"additionalProperties":false},"PayApplicationDraft":{"type":"object","properties":{"categories":{"default":[],"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/PaySellCategory"}},"productExamples":{"default":"","type":"string","maxLength":1000},"links":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":300}},"monthlyVolumeMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":100000000000,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"averageOrderMinor":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":10000000000,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"buyerCountries":{"default":[],"maxItems":60,"type":"array","items":{"$ref":"#/components/schemas/CountryCode"}},"refundPolicy":{"default":"","type":"string","maxLength":2000},"yearsSelling":{"default":null,"anyOf":[{"$ref":"#/components/schemas/YearsSelling"},{"type":"null"}]},"discord":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"telegram":{"default":null,"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"website":{"default":null,"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"entityType":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PayEntityType"},{"type":"null"}]},"businessName":{"default":null,"anyOf":[{"type":"string","maxLength":160},{"type":"null"}]}},"required":["categories","productExamples","links","monthlyVolumeMinor","averageOrderMinor","buyerCountries","refundPolicy","yearsSelling","discord","telegram","website","entityType","businessName"],"additionalProperties":false},"PayApplicationId":{"type":"string","pattern":"^papp_[0-9a-hjkmnp-tv-z]{20}$"},"PayApplicationStatus":{"type":"string","enum":["draft","submitted","info_requested","approved","rejected","withdrawn"]},"PayDocument":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayDocumentId"},"kind":{"$ref":"#/components/schemas/PayDocumentKind"},"filename":{"type":"string"},"contentType":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"uploadedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","filename","contentType","bytes","uploadedAt"],"additionalProperties":false},"PayDocumentId":{"type":"string","pattern":"^pdoc_[0-9a-hjkmnp-tv-z]{20}$"},"PayDocumentKind":{"type":"string","enum":["identity","proof_of_address","business_registration","other"]},"PayEntityType":{"type":"string","enum":["individual","business"]},"PayEvent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayEventId"},"kind":{"$ref":"#/components/schemas/PayEventKind"},"actor":{"$ref":"#/components/schemas/PayEventActor"},"message":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","actor","message","createdAt"],"additionalProperties":false},"PayEventActor":{"type":"string","enum":["seller","admin","system"]},"PayEventId":{"type":"string","pattern":"^pev_[0-9a-hjkmnp-tv-z]{20}$"},"PayEventKind":{"type":"string","enum":["created","submitted","info_requested","replied","approved","rejected","withdrawn","limits_changed","suspended","reinstated","payout_hold","payout_release","mode_changed"]},"PayFallback":{"type":"string","enum":["none","switched_to_own","unavailable"]},"PayKycDraft":{"type":"object","properties":{"legalName":{"default":"","type":"string","maxLength":120},"country":{"default":null,"anyOf":[{"$ref":"#/components/schemas/CountryCode"},{"type":"null"}]},"dateOfBirth":{"default":null,"anyOf":[{"$ref":"#/components/schemas/IsoDate"},{"type":"null"}]}},"required":["legalName","country","dateOfBirth"],"additionalProperties":false},"PayLimits":{"type":"object","properties":{"rollingCapMinor":{"anyOf":[{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"windowDays":{"type":"integer","minimum":1,"maximum":90},"maxOrderMinor":{"anyOf":[{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"reserveBps":{"anyOf":[{"$ref":"#/components/schemas/Bps"},{"type":"null"}]}},"required":["rollingCapMinor","windowDays","maxOrderMinor","reserveBps"],"additionalProperties":false},"PayOptionId":{"type":"string","pattern":"^[a-z][a-z0-9_]{1,39}$"},"PayRiskFlag":{"type":"string","enum":["watchlist","high_risk_category","chargeback_history","identity_mismatch","manual_review"]},"PayRiskSignal":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"severity":{"type":"string","enum":["info","warn","high"]},"detail":{"type":"string"}},"required":["code","label","severity","detail"],"additionalProperties":false},"PaySellCategory":{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]},"PaySettings":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/PayAccessMode"},"defaults":{"$ref":"#/components/schemas/PayLimits"},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["mode","defaults","updatedAt"],"additionalProperties":false},"PayStats":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/PayAccessMode"},"counts":{"$ref":"#/components/schemas/PayApplicationCounts"},"activeStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"suspendedStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"heldPayoutStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approvalRate90d":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"medianReviewHours90d":{"type":["number","null"]},"oldestWaitingAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"volume30d":{"type":"array","items":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["currency","amountMinor"],"additionalProperties":false}}},"required":["mode","counts","activeStores","suspendedStores","heldPayoutStores","approvalRate90d","medianReviewHours90d","oldestWaitingAt","volume30d"],"additionalProperties":false},"PaymentAttemptId":{"type":"string","pattern":"^pat_[0-9a-hjkmnp-tv-z]{20}$"},"PaymentAttemptRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PaymentAttemptId"},"at":{"$ref":"#/components/schemas/Timestamp"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/PaymentAttemptStatus"},"failureKind":{"anyOf":[{"$ref":"#/components/schemas/PaymentFailureKind"},{"type":"null"}]},"failureMessage":{"type":["string","null"]},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"attemptNo":{"type":"integer","minimum":1,"maximum":9007199254740991},"recovered":{"type":"boolean"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]}},"required":["id","at","provider","method","status","failureKind","failureMessage","amountMinor","attemptNo","recovered","orderId"],"additionalProperties":false},"PaymentAttemptStatus":{"type":"string","enum":["started","failed","succeeded","voided"]},"PaymentFailureKind":{"type":"string","enum":["declined","provider_error","outage","risk_declined"]},"PaymentIconsSettings":{"type":"object","properties":{"methods":{"default":["visa","mastercard","apple_pay","google_pay","bitcoin"],"minItems":1,"maxItems":12,"type":"array","items":{"$ref":"#/components/schemas/PaymentMark"}},"label":{"default":"Pay securely with","type":"string","maxLength":40},"placement":{"default":"product_and_cart","type":"string","enum":["product","product_and_cart","everywhere"]},"style":{"default":"mono","type":"string","enum":["mono","color"]}},"required":["methods","label","placement","style"],"additionalProperties":false},"PaymentLimitsView":{"type":"object","properties":{"limits":{"$ref":"#/components/schemas/MethodLimits"},"caps":{"type":"object","propertyNames":{"$ref":"#/components/schemas/LimitedMethod"},"additionalProperties":{"$ref":"#/components/schemas/MethodLimit"}},"effective":{"$ref":"#/components/schemas/EffectiveMethodLimits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"offered":{"type":"array","items":{"$ref":"#/components/schemas/LimitedMethod"}},"clamped":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/LimitedMethod"}}},"required":["limits","caps","effective","currency","offered","clamped"],"additionalProperties":false},"PaymentMark":{"type":"string","enum":["visa","mastercard","amex","paypal","apple_pay","google_pay","bitcoin","ethereum","usdt","litecoin","solana","binance_pay","paysafecard","skrill","bank_transfer","cash_app"]},"PaymentMethod":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","store_credit","manual","cash_app","skins","gift_code"]},"PaymentMethodRules":{"type":"object","properties":{"order":{"maxItems":7,"type":"array","items":{"$ref":"#/components/schemas/GatewayProvider"}},"rules":{"type":"object","propertyNames":{"$ref":"#/components/schemas/GatewayProvider"},"additionalProperties":{"$ref":"#/components/schemas/MethodRule"}}},"required":["order","rules"],"additionalProperties":false},"PaymentModel":{"type":"string","enum":["merchant_of_record","seller_gateway"]},"PaymentRules":{"type":"object","properties":{"disabledMethods":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"multipliers":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/MethodMultiplier"}}},"required":["disabledMethods","multipliers"],"additionalProperties":false},"PaymentSetupId":{"type":"string","pattern":"^pms_[0-9a-hjkmnp-tv-z]{20}$"},"PaymentsTestMode":{"type":"object","properties":{"on":{"type":"boolean"},"until":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["on","until"],"additionalProperties":false},"Payout":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayoutId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"feeMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/PayoutStatus"},"arrivalDate":{"$ref":"#/components/schemas/IsoDate"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"rail":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PayoutRail"},{"type":"null"}]},"address":{"default":null,"type":["string","null"]},"origin":{"default":"schedule","$ref":"#/components/schemas/PayoutOrigin"},"txHash":{"default":null,"type":["string","null"]},"reason":{"default":null,"type":["string","null"]},"paidAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","storeId","amountMinor","feeMinor","currency","status","arrivalDate","createdAt","rail","address","origin","txHash","reason","paidAt"],"additionalProperties":false},"PayoutCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processing":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","scheduled","processing","paid","failed"],"additionalProperties":false},"PayoutId":{"type":"string","pattern":"^po_[0-9a-hjkmnp-tv-z]{20}$"},"PayoutOrigin":{"type":"string","enum":["schedule","seller","admin"]},"PayoutRail":{"type":"string","enum":["usdt_tron","usdt_bsc","usdt_ethereum","usdt_solana","usdc_base","usdc_polygon","usdc_solana","btc","ltc","eth"]},"PayoutReconRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PayoutId"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"arrivalDate":{"$ref":"#/components/schemas/IsoDate"},"status":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"amountMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"feeMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ledgerGrossMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ledgerFeeMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ledgerSentMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reversed":{"type":"boolean"},"matched":{"type":"boolean"},"providerTransferId":{"type":["string","null"]}},"required":["id","createdAt","paidAt","arrivalDate","status","currency","amountMinor","feeMinor","ledgerGrossMinor","ledgerFeeMinor","ledgerSentMinor","reversed","matched","providerTransferId"],"additionalProperties":false},"PayoutReconciliation":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"payouts":{"type":"array","items":{"$ref":"#/components/schemas/PayoutReconRow"}},"rollForward":{"type":"array","items":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"openingAvailableMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"settledMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"releasedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundsMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputesMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"otherMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"payoutsMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"closingAvailableMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"differenceMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["currency","openingAvailableMinor","settledMinor","releasedMinor","refundsMinor","disputesMinor","otherMinor","payoutsMinor","closingAvailableMinor","differenceMinor"],"additionalProperties":false}},"unmatched":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["period","payouts","rollForward","unmatched"],"additionalProperties":false},"PayoutStatus":{"type":"string","enum":["scheduled","processing","paid","failed"]},"PayoutWallet":{"type":"object","properties":{"rail":{"$ref":"#/components/schemas/PayoutRail"},"address":{"type":"string"},"setAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["rail","address","setAt"],"additionalProperties":false},"PayoutWalletCheck":{"type":"string","enum":["totp","email"]},"PayoutWalletVerification":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/PayoutWalletCheck"},"rail":{"$ref":"#/components/schemas/PayoutRail"},"address":{"type":"string"},"sentTo":{"type":["string","null"]},"verifyToken":{"type":["string","null"]},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["method","rail","address","sentTo","verifyToken","expiresAt"],"additionalProperties":false},"PendingAction":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PendingActionId"},"kind":{"$ref":"#/components/schemas/PendingActionKind"},"label":{"type":"string"},"state":{"$ref":"#/components/schemas/PendingActionState"},"commitAt":{"$ref":"#/components/schemas/Timestamp"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"settledAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"error":{"type":["string","null"]},"target":{"type":"object","properties":{"kind":{"type":"string","enum":["order","campaign","product","products","discounts"]},"id":{"type":["string","null"]}},"required":["kind","id"],"additionalProperties":false},"actorName":{"type":"string"},"mine":{"type":"boolean"}},"required":["id","kind","label","state","commitAt","createdAt","settledAt","error","target","actorName","mine"],"additionalProperties":false},"PendingActionId":{"type":"string","pattern":"^pact_[0-9a-hjkmnp-tv-z]{20}$"},"PendingActionKind":{"type":"string","enum":["refund","campaign_send","broadcast_send","products_delete","discounts_delete"]},"PendingActionState":{"type":"string","enum":["pending","committed","cancelled","failed"]},"PermissionPattern":{"anyOf":[{"$ref":"#/components/schemas/StorePermission"},{"type":"string","pattern":"^(catalog|orders|customers|disputes|reviews|marketing|analytics|storefront|payments|finance|team|settings|discord|fraud|developers|audit|support|ai):\\*$"},{"type":"string","const":"*"}]},"Plan":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanId"},"name":{"type":"string","minLength":1,"maxLength":40},"monthlyPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"fees":{"$ref":"#/components/schemas/FeeSchedule"},"isDefault":{"type":"boolean"},"allowedModels":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PaymentModel"}},"storeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"selectable":{"default":true,"type":"boolean"},"mediaQuota":{"default":{"storageBytes":5368709120,"fileCount":5000,"maxFileBytes":2147483647},"$ref":"#/components/schemas/MediaQuota"},"limits":{"default":{"products":null,"ordersPerMonth":null,"teamMembers":null,"customDomains":null,"removeBranding":true,"developerTools":true,"themeCode":true,"shopfastPay":true,"addOns":[]},"$ref":"#/components/schemas/PlanLimits"},"trialDays":{"default":0,"type":"integer","minimum":0,"maximum":365}},"required":["id","name","monthlyPriceMinor","currency","fees","isDefault","allowedModels","storeCount","updatedAt","selectable","mediaQuota","limits","trialDays"],"additionalProperties":false},"PlanAddOn":{"type":"string","enum":["licensing","email_marketing","leak_tracer"]},"PlanChangeKind":{"type":"string","enum":["start_now","upgrade_now","downgrade_at_period_end","cancel_at_period_end","keep_after_trial","end_trial","undo"]},"PlanChangeLine":{"type":"object","properties":{"label":{"type":"string"},"detail":{"type":["string","null"]},"amountMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["label","detail","amountMinor"],"additionalProperties":false},"PlanChangePreview":{"type":"object","properties":{"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"kind":{"$ref":"#/components/schemas/PlanChangeKind"},"currency":{"type":"string"},"monthlyPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/PlanChangeLine"}},"dueNowMinor":{"$ref":"#/components/schemas/MinorUnits"},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"renewsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"needsCard":{"type":"boolean"},"endsTrial":{"default":false,"type":"boolean"},"summary":{"type":"string"}},"required":["planId","planName","kind","currency","monthlyPriceMinor","lines","dueNowMinor","startsAt","renewsAt","needsCard","endsTrial","summary"],"additionalProperties":false},"PlanComp":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanCompId"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"reason":{"type":"string"},"endsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"grantedAt":{"$ref":"#/components/schemas/Timestamp"},"grantedBy":{"type":["string","null"]}},"required":["id","planId","planName","reason","endsAt","grantedAt","grantedBy"],"additionalProperties":false},"PlanCompId":{"type":"string","pattern":"^pcm_[0-9a-hjkmnp-tv-z]{20}$"},"PlanId":{"type":"string","pattern":"^plan_[0-9a-hjkmnp-tv-z]{20}$"},"PlanInvoice":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanInvoiceId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/PlanInvoiceStatus"},"periodStart":{"type":"string"},"periodEnd":{"type":"string"},"reason":{"type":"string","enum":["upgrade","renewal"]},"paidVia":{"anyOf":[{"$ref":"#/components/schemas/PlanInvoicePaidVia"},{"type":"null"}]},"paidAt":{"type":["string","null"]},"createdAt":{"type":"string"},"creditMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"creditNote":{"default":null,"type":["string","null"]}},"required":["id","storeId","planId","planName","amountMinor","currency","status","periodStart","periodEnd","reason","paidVia","paidAt","createdAt","creditMinor","creditNote"],"additionalProperties":false},"PlanInvoiceId":{"type":"string","pattern":"^pinv_[0-9a-hjkmnp-tv-z]{20}$"},"PlanInvoicePaidVia":{"type":"string","enum":["balance","admin","card"]},"PlanInvoiceStatus":{"type":"string","enum":["open","paid","void","refunded"]},"PlanLimitKey":{"type":"string","enum":["products","ordersPerMonth","teamMembers","customDomains","removeBranding","developerTools","themeCode","shopfastPay"]},"PlanLimits":{"type":"object","properties":{"products":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"ordersPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000000},{"type":"null"}]},"teamMembers":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"customDomains":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000},{"type":"null"}]},"removeBranding":{"type":"boolean"},"developerTools":{"type":"boolean"},"themeCode":{"type":"boolean"},"shopfastPay":{"type":"boolean"},"addOns":{"maxItems":3,"type":"array","items":{"$ref":"#/components/schemas/PlanAddOn"}}},"required":["products","ordersPerMonth","teamMembers","customDomains","removeBranding","developerTools","themeCode","shopfastPay","addOns"],"additionalProperties":false},"PlanLimitsOverride":{"type":"object","properties":{"products":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}]},"ordersPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000000},{"type":"null"}]},"teamMembers":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"customDomains":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000},{"type":"null"}]},"removeBranding":{"type":"boolean"},"developerTools":{"type":"boolean"},"themeCode":{"type":"boolean"},"shopfastPay":{"type":"boolean"},"addOns":{"maxItems":3,"type":"array","items":{"$ref":"#/components/schemas/PlanAddOn"}}},"additionalProperties":false},"PlanOverview":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/StorePlanState"},"usage":{"$ref":"#/components/schemas/PlanUsage"}},"required":["state","usage"],"additionalProperties":false},"PlanPayResult":{"type":"object","properties":{"status":{"type":"string","enum":["paid","requires_action","failed","nothing_owed"]},"message":{"type":["string","null"]},"action":{"anyOf":[{"type":"object","properties":{"publishableKey":{"type":"string"},"clientSecret":{"type":"string"},"paymentIntentId":{"type":"string","format":"starts_with","pattern":"^pi_.*"}},"required":["publishableKey","clientSecret","paymentIntentId"],"additionalProperties":false},{"type":"null"}]}},"required":["status","message","action"],"additionalProperties":false},"PlanUsage":{"type":"object","properties":{"products":{"type":"integer","minimum":0,"maximum":9007199254740991},"lockedProducts":{"type":"integer","minimum":0,"maximum":9007199254740991},"ordersThisMonth":{"type":"integer","minimum":0,"maximum":9007199254740991},"teamMembers":{"type":"integer","minimum":0,"maximum":9007199254740991},"customDomains":{"type":"integer","minimum":0,"maximum":9007199254740991},"monthResetsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["products","lockedProducts","ordersThisMonth","teamMembers","customDomains","monthResetsAt"],"additionalProperties":false},"PlanVoucher":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanVoucherId"},"code":{"type":"string"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"months":{"type":"integer","minimum":1,"maximum":36},"maxRedemptions":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"redeemedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"pausedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/PlanVoucherStatus"},"note":{"type":"string","maxLength":280},"createdBy":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"signupUrl":{"type":"string"}},"required":["id","code","planId","planName","months","maxRedemptions","redeemedCount","expiresAt","pausedAt","status","note","createdBy","createdAt","signupUrl"],"additionalProperties":false},"PlanVoucherId":{"type":"string","pattern":"^pvc_[0-9a-hjkmnp-tv-z]{20}$"},"PlanVoucherPreview":{"type":"object","properties":{"code":{"type":"string"},"planName":{"type":"string"},"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unavailableReason":{"type":["string","null"]}},"required":["code","planName","months","unavailableReason"],"additionalProperties":false},"PlanVoucherRedemption":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanVoucherRedemptionId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"type":"string"},"ownerEmail":{"$ref":"#/components/schemas/Email"},"redeemedAt":{"$ref":"#/components/schemas/Timestamp"},"freeUntil":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"ended":{"type":"boolean"}},"required":["id","storeId","storeName","storeHandle","ownerEmail","redeemedAt","freeUntil","ended"],"additionalProperties":false},"PlanVoucherRedemptionId":{"type":"string","pattern":"^pvr_[0-9a-hjkmnp-tv-z]{20}$"},"PlanVoucherStatus":{"type":"string","enum":["active","paused","expired","used_up"]},"PlatformBlocklistEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FraudListEntryId"},"kind":{"$ref":"#/components/schemas/BlocklistKind"},"value":{"type":"string"},"reason":{"type":"string"},"severity":{"type":"string","enum":["high","medium"]},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"addedBy":{"type":["string","null"]},"storesMatched30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","value","reason","severity","expiresAt","addedBy","storesMatched30d","createdAt"],"additionalProperties":false},"PlatformGateway":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"displayName":{"type":"string"},"enabledForMor":{"type":"boolean"},"enabledForSellers":{"type":"boolean"},"mode":{"type":"string","enum":["test","live"]},"methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"estimatedFeeBps":{"$ref":"#/components/schemas/Bps"},"estimatedFixedMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["provider","displayName","enabledForMor","enabledForSellers","mode","methods","estimatedFeeBps","estimatedFixedMinor"],"additionalProperties":false},"PlatformIncident":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CommunityIncidentId"},"title":{"type":"string"},"impact":{"$ref":"#/components/schemas/IncidentImpact"},"status":{"$ref":"#/components/schemas/IncidentStatus"},"components":{"type":"array","items":{"type":"string"}},"updates":{"type":"array","items":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IncidentStatus"},"body":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["status","body","at"],"additionalProperties":false}},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"resolvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","title","impact","status","components","updates","startedAt","resolvedAt"],"additionalProperties":false},"PlatformInvoiceId":{"type":"string","pattern":"^pinv_[0-9a-hjkmnp-tv-z]{20}$"},"PlatformInvoiceRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlatformInvoiceId"},"number":{"type":"string"},"issueDate":{"$ref":"#/components/schemas/IsoDate"},"source":{"$ref":"#/components/schemas/PlatformInvoiceSource"},"description":{"type":"string"},"period":{"anyOf":[{"type":"object","properties":{"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"paidVia":{"type":"string"}},"required":["id","number","issueDate","source","description","period","currency","netMinor","taxMinor","totalMinor","paidVia"],"additionalProperties":false},"PlatformInvoiceSource":{"type":"string","enum":["plan","pay_fees","ai_credits"]},"PlatformListInfo":{"type":"object","properties":{"optedIn":{"type":"boolean"},"action":{"type":"string","enum":["block","review"]},"entries":{"type":"integer","minimum":0,"maximum":9007199254740991},"byKind":{"type":"array","items":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/BlocklistKind"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","count"],"additionalProperties":false}},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"matches30d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["optedIn","action","entries","byKind","updatedAt","matches30d"],"additionalProperties":false},"PlatformMethodCapsView":{"type":"object","properties":{"byCurrency":{"type":"object","propertyNames":{"$ref":"#/components/schemas/CurrencyCode"},"additionalProperties":{"type":"object","propertyNames":{"$ref":"#/components/schemas/LimitedMethod"},"additionalProperties":{"$ref":"#/components/schemas/MethodLimit"}}},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["byCurrency","updatedAt"],"additionalProperties":false},"PlatformOverview":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"gmvMinor":{"$ref":"#/components/schemas/MinorUnits"},"morVolumeMinor":{"$ref":"#/components/schemas/MinorUnits"},"sellerGatewayVolumeMinor":{"$ref":"#/components/schemas/MinorUnits"},"platformRevenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"planRevenueMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"processorCostMinor":{"$ref":"#/components/schemas/MinorUnits"},"processorCostReportedMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxCollectedMinor":{"$ref":"#/components/schemas/MinorUnits"},"pendingPayoutsMinor":{"$ref":"#/components/schemas/MinorUnits"},"activeStores":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"series":{"type":"array","items":{"$ref":"#/components/schemas/OverviewDay"}},"byCurrency":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CurrencyOverview"}}},"required":["currency","from","to","gmvMinor","morVolumeMinor","sellerGatewayVolumeMinor","platformRevenueMinor","planRevenueMinor","processorCostMinor","processorCostReportedMinor","taxCollectedMinor","pendingPayoutsMinor","activeStores","orders","series","byCurrency"],"additionalProperties":false},"PlatformSchedule":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ScheduleName"},"label":{"type":"string"},"cadence":{"type":"string"},"nextRunAt":{"$ref":"#/components/schemas/Timestamp"},"lastRunAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastResult":{"type":["string","null"]},"lastError":{"type":["string","null"]}},"required":["name","label","cadence","nextRunAt","lastRunAt","lastResult","lastError"],"additionalProperties":false},"PlatformSettings":{"type":"object","properties":{"settlement":{"$ref":"#/components/schemas/SettlementSettings"},"taxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"ebookTaxRates":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"defaultCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"referrals":{"default":{"enabled":true,"shareBps":2000,"months":12,"holdDays":30,"linkDays":60},"$ref":"#/components/schemas/ReferralSettings"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["settlement","taxRates","ebookTaxRates","defaultCurrency","referrals","updatedAt"],"additionalProperties":false},"PlatformStatus":{"type":"object","properties":{"checkedAt":{"$ref":"#/components/schemas/Timestamp"},"state":{"$ref":"#/components/schemas/ComponentState"},"components":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"state":{"$ref":"#/components/schemas/ComponentState"},"uptime":{"type":"number"},"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"state":{"$ref":"#/components/schemas/ComponentState"},"incidents":{"type":"array","items":{"type":"string"}}},"required":["date","state","incidents"],"additionalProperties":false}}},"required":["name","state","uptime","days"],"additionalProperties":false}},"active":{"type":"array","items":{"$ref":"#/components/schemas/PlatformIncident"}},"upcoming":{"type":"array","items":{"$ref":"#/components/schemas/PlatformIncident"}},"history":{"type":"array","items":{"$ref":"#/components/schemas/PlatformIncident"}},"discordInvite":{"type":["string","null"]}},"required":["checkedAt","state","components","active","upcoming","history","discordInvite"],"additionalProperties":false},"PluginCatalogEntry":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/PluginKind"},"version":{"type":"string"},"description":{"type":"string"},"author":{"type":"string"},"category":{"type":"string"},"verified":{"type":"boolean"},"permissions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"detail":{"type":"string"}},"required":["id","label","detail"],"additionalProperties":false}},"installed":{"type":"boolean"}},"required":["slug","name","kind","version","description","author","category","verified","permissions","installed"],"additionalProperties":false},"PluginDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PluginId"},"slug":{"type":"string"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/PluginKind"},"status":{"$ref":"#/components/schemas/PluginStatus"},"description":{"type":"string"},"version":{"type":["string","null"]},"catalogSlug":{"type":["string","null"]},"needsApproval":{"type":"boolean"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"runs24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"source":{"type":"string"},"manifest":{"$ref":"#/components/schemas/PluginManifest"},"settings":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/PluginSettingValue"}},"secretsSet":{"type":"array","items":{"type":"string"}},"activeVersionId":{"anyOf":[{"$ref":"#/components/schemas/PluginVersionId"},{"type":"null"}]},"latestVersionId":{"anyOf":[{"$ref":"#/components/schemas/PluginVersionId"},{"type":"null"}]},"approvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"approvedBy":{"type":["string","null"]},"permissions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"detail":{"type":"string"},"approved":{"type":"boolean"}},"required":["id","label","detail","approved"],"additionalProperties":false}},"versions":{"type":"array","items":{"$ref":"#/components/schemas/PluginVersionSummary"}},"stats":{"$ref":"#/components/schemas/PluginStats"},"callbackUrl":{"type":["string","null"]}},"required":["id","slug","name","kind","status","description","version","catalogSlug","needsApproval","updatedAt","runs24h","errors24h","source","manifest","settings","secretsSet","activeVersionId","latestVersionId","approvedAt","approvedBy","permissions","versions","stats","callbackUrl"],"additionalProperties":false},"PluginDiagnostic":{"type":"object","properties":{"severity":{"type":"string","enum":["error","warning","info"]},"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"column":{"default":1,"type":"integer","minimum":1,"maximum":9007199254740991},"message":{"type":"string"},"source":{"type":"string","enum":["syntax","lint","manifest","runtime"]}},"required":["severity","line","column","message","source"],"additionalProperties":false},"PluginFixture":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"hook":{"$ref":"#/components/schemas/PluginHook"},"input":{"$ref":"#/components/schemas/Shared10"},"settings":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/PluginSettingValue"}},"http":{"default":[],"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/PluginHttpMock"}},"kv":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expect":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Shared11"},{"type":"null"}]},"expectError":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["name","hook","input","settings","http","kv","expect","expectError"],"additionalProperties":false},"PluginHook":{"type":"string","enum":["create_payment","verify_callback","deliver","validate_cart","transform"]},"PluginHostPattern":{"type":"string","maxLength":253,"pattern":"^(\\*\\.)?(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"},"PluginHttpMock":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000},"method":{"default":"*","type":"string","maxLength":10},"status":{"default":200,"type":"integer","minimum":100,"maximum":599},"headers":{"default":{},"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"body":{"default":"","type":"string","maxLength":262144}},"required":["url","method","status","headers","body"],"additionalProperties":false},"PluginId":{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"},"PluginKind":{"type":"string","enum":["payment","delivery","checkout_hook","webhook_transformer"]},"PluginLogLevel":{"type":"string","enum":["debug","info","warn","error"]},"PluginLogLine":{"type":"object","properties":{"level":{"$ref":"#/components/schemas/PluginLogLevel"},"message":{"type":"string"},"atMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["level","message","atMs"],"additionalProperties":false},"PluginManifest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"version":{"$ref":"#/components/schemas/PluginSemver"},"kind":{"$ref":"#/components/schemas/PluginKind"},"description":{"default":"","type":"string","maxLength":300},"author":{"default":"","type":"string","maxLength":80},"homepage":{"default":null,"anyOf":[{"type":"string","maxLength":500,"format":"uri"},{"type":"null"}]},"permissions":{"default":{"http":[],"kv":false},"$ref":"#/components/schemas/PluginPermissions"},"settings":{"default":[],"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/PluginSettingDef"}},"payment":{"default":null,"anyOf":[{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":40},"methods":{"minItems":1,"maxItems":4,"type":"array","items":{"type":"string","enum":["card","apple_pay","google_pay","paypal","crypto","bank_transfer","manual","cash_app","skins","gift_code"]}}},"required":["label","methods"],"additionalProperties":false},{"type":"null"}]}},"required":["name","version","kind","description","author","homepage","permissions","settings","payment"],"additionalProperties":false},"PluginMetrics":{"type":"object","properties":{"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"cpuMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"instructions":{"type":"integer","minimum":0,"maximum":9007199254740991},"memoryPeakBytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"fetches":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["durationMs","cpuMs","instructions","memoryPeakBytes","fetches"],"additionalProperties":false},"PluginPermissions":{"type":"object","properties":{"http":{"default":[],"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PluginHostPattern"}},"kv":{"default":false,"type":"boolean"}},"required":["http","kv"],"additionalProperties":false},"PluginRun":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PluginRunId"},"hook":{"$ref":"#/components/schemas/PluginHook"},"trigger":{"$ref":"#/components/schemas/PluginTrigger"},"status":{"$ref":"#/components/schemas/PluginRunStatus"},"version":{"type":["string","null"]},"error":{"type":["string","null"]},"metrics":{"$ref":"#/components/schemas/PluginMetrics"},"logs":{"type":"array","items":{"$ref":"#/components/schemas/PluginLogLine"}},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","hook","trigger","status","version","error","metrics","logs","at"],"additionalProperties":false},"PluginRunId":{"type":"string","pattern":"^plr_[0-9a-hjkmnp-tv-z]{20}$"},"PluginRunStatus":{"type":"string","enum":["ok","error","timeout","limit","denied"]},"PluginSemver":{"type":"string","pattern":"^\\d{1,4}\\.\\d{1,4}\\.\\d{1,4}(?:-[0-9a-z.-]{1,20})?$"},"PluginSettingDef":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/PluginSettingKey"},"label":{"type":"string","minLength":1,"maxLength":80},"type":{"$ref":"#/components/schemas/PluginSettingType"},"required":{"default":false,"type":"boolean"},"help":{"default":"","type":"string","maxLength":240},"options":{"default":[],"maxItems":30,"type":"array","items":{"type":"string","minLength":1,"maxLength":60}}},"required":["key","label","type","required","help","options"],"additionalProperties":false},"PluginSettingKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"PluginSettingType":{"type":"string","enum":["text","secret","number","boolean","select","products"]},"PluginSettingValue":{"anyOf":[{"type":"string","maxLength":4000},{"type":"number"},{"type":"boolean"},{"maxItems":200,"type":"array","items":{"type":"string","maxLength":40}},{"type":"null"}]},"PluginStats":{"type":"object","properties":{"runs24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"p95Ms":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastRunAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"hourly":{"type":"array","items":{"type":"object","properties":{"hour":{"$ref":"#/components/schemas/Timestamp"},"ok":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["hour","ok","failed"],"additionalProperties":false}}},"required":["runs24h","errors24h","p95Ms","lastRunAt","hourly"],"additionalProperties":false},"PluginStatus":{"type":"string","enum":["draft","active","disabled"]},"PluginSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PluginId"},"slug":{"type":"string"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/PluginKind"},"status":{"$ref":"#/components/schemas/PluginStatus"},"description":{"type":"string"},"version":{"type":["string","null"]},"catalogSlug":{"type":["string","null"]},"needsApproval":{"type":"boolean"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"runs24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","slug","name","kind","status","description","version","catalogSlug","needsApproval","updatedAt","runs24h","errors24h"],"additionalProperties":false},"PluginTestResult":{"type":"object","properties":{"fixture":{"type":"string"},"hook":{"$ref":"#/components/schemas/PluginHook"},"status":{"$ref":"#/components/schemas/PluginRunStatus"},"passed":{"type":"boolean"},"output":{"anyOf":[{"$ref":"#/components/schemas/Shared12"},{"type":"null"}]},"error":{"type":["string","null"]},"mismatch":{"type":["string","null"]},"metrics":{"$ref":"#/components/schemas/PluginMetrics"},"logs":{"type":"array","items":{"$ref":"#/components/schemas/PluginLogLine"}},"http":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"status":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"mocked":{"type":"boolean"},"error":{"type":["string","null"]}},"required":["method","url","status","mocked","error"],"additionalProperties":false}}},"required":["fixture","hook","status","passed","output","error","mismatch","metrics","logs","http"],"additionalProperties":false},"PluginTrigger":{"type":"string","enum":["test","checkout","payment","callback","delivery","webhook"]},"PluginVersionId":{"type":"string","pattern":"^plv_[0-9a-hjkmnp-tv-z]{20}$"},"PluginVersionSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PluginVersionId"},"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"version":{"type":"string"},"note":{"type":"string"},"sha256":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"createdBy":{"type":["string","null"]},"active":{"type":"boolean"},"permissionsChanged":{"type":"boolean"},"fingerprint":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"detail":{"type":"string"}},"required":["id","label","detail"],"additionalProperties":false}}},"required":["id","number","version","note","sha256","createdAt","createdBy","active","permissionsChanged","fingerprint","permissions"],"additionalProperties":false},"PolicyCondition":{"type":"object","properties":{"attribute":{"$ref":"#/components/schemas/AttributeKey"},"op":{"$ref":"#/components/schemas/ConditionOperator"},"value":{"default":null,"$ref":"#/components/schemas/ConditionValue"},"value2":{"default":null,"type":["number","null"]}},"required":["attribute","op","value","value2"],"additionalProperties":false},"PolicyEffect":{"type":"string","enum":["allow","deny"]},"PolicyGroup":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/PolicyCondition"}},"groups":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["all","any"]},"conditions":{"minItems":1,"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/PolicyCondition"}}},"required":["op","conditions"],"additionalProperties":false}}},"required":["op","conditions","groups"],"additionalProperties":false},"PolicySubjects":{"type":"object","properties":{"everyone":{"default":false,"type":"boolean"},"roles":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","enum":["admin","staff","support","finance","custom"]}},"customRoleIds":{"default":[],"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/RoleId"}},"userIds":{"default":[],"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/UserId"}},"departments":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"tags":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}},"required":["everyone","roles","customRoleIds","userIds","departments","tags"],"additionalProperties":false},"PolicyTrace":{"type":"object","properties":{"policyId":{"type":"string"},"name":{"type":"string"},"effect":{"$ref":"#/components/schemas/PolicyEffect"},"subject":{"type":"boolean"},"covers":{"type":"boolean"},"matched":{"type":["boolean","null"]},"enabled":{"default":true,"type":"boolean"},"unresolved":{"default":false,"type":"boolean"},"conditions":{"type":"array","items":{"type":"object","properties":{"attribute":{"$ref":"#/components/schemas/AttributeKey"},"op":{"$ref":"#/components/schemas/ConditionOperator"},"actual":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"matched":{"type":"boolean"}},"required":["attribute","op","actual","matched"],"additionalProperties":false}}},"required":["policyId","name","effect","subject","covers","matched","enabled","unresolved","conditions"],"additionalProperties":false},"Popup":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"$ref":"#/components/schemas/PopupKind"},"status":{"$ref":"#/components/schemas/PopupStatus"},"trigger":{"$ref":"#/components/schemas/PopupTrigger"},"targeting":{"$ref":"#/components/schemas/PopupTargeting"},"frequency":{"$ref":"#/components/schemas/PopupFrequency"},"variants":{"minItems":1,"maxItems":3,"type":"array","items":{"$ref":"#/components/schemas/PopupVariant"}},"startsAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"endsAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"priority":{"default":50,"type":"integer","minimum":0,"maximum":100},"id":{"$ref":"#/components/schemas/PopupId"},"showing":{"type":"boolean"},"stats":{"type":"array","items":{"$ref":"#/components/schemas/PopupVariantStats"}},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","kind","status","trigger","targeting","frequency","variants","startsAt","endsAt","priority","id","showing","stats","createdAt","updatedAt"],"additionalProperties":false},"PopupContent":{"type":"object","properties":{"eyebrow":{"default":"","type":"string","maxLength":40},"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":300},"ctaLabel":{"default":"Shop now","type":"string","maxLength":30},"ctaLink":{"default":"/collections/all","type":"string","maxLength":300},"dismissLabel":{"default":"No thanks","type":"string","maxLength":30},"couponMode":{"default":"none","$ref":"#/components/schemas/PopupCouponMode"},"discountId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/DiscountId"},{"type":"null"}]},"revealAfterEmail":{"default":false,"type":"boolean"},"emailCapture":{"default":false,"type":"boolean"},"emailPlaceholder":{"default":"you@example.com","type":"string","maxLength":60},"consentLabel":{"default":"Send me offers and updates by email. Unsubscribe anytime.","type":"string","maxLength":200},"requireConsent":{"default":false,"type":"boolean"},"submitLabel":{"default":"Get my code","type":"string","maxLength":30},"successHeading":{"default":"You are in","type":"string","maxLength":80},"successBody":{"default":"Use your code at checkout.","type":"string","maxLength":300},"timerMinutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1440},{"type":"null"}]},"upsellHandle":{"default":null,"anyOf":[{"type":"string","maxLength":140},{"type":"null"}]}},"required":["eyebrow","heading","body","ctaLabel","ctaLink","dismissLabel","couponMode","discountId","revealAfterEmail","emailCapture","emailPlaceholder","consentLabel","requireConsent","submitLabel","successHeading","successBody","timerMinutes","upsellHandle"],"additionalProperties":false},"PopupCouponMode":{"type":"string","enum":["none","code","unique"]},"PopupDesign":{"type":"object","properties":{"layout":{"default":"modal","$ref":"#/components/schemas/PopupLayout"},"position":{"default":"center","type":"string","enum":["center","bottom-right","bottom-left","top","bottom"]},"surface":{"default":"store","type":"string","enum":["store","light","dark"]},"accent":{"default":null,"anyOf":[{"type":"string","pattern":"^#[0-9a-f]{6}$"},{"type":"null"}]},"radius":{"default":16,"type":"integer","minimum":0,"maximum":28},"motion":{"default":"rise","$ref":"#/components/schemas/PopupMotion"},"width":{"default":"md","type":"string","enum":["sm","md","lg"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"backdrop":{"default":45,"type":"integer","minimum":0,"maximum":80},"showClose":{"default":true,"type":"boolean"}},"required":["layout","position","surface","accent","radius","motion","width","imageUrl","backdrop","showClose"],"additionalProperties":false},"PopupDetail":{"type":"object","properties":{"popup":{"$ref":"#/components/schemas/Popup"},"series":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"key":{"$ref":"#/components/schemas/PopupVariantKey"},"impressions":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversions":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["date","key","impressions","conversions"],"additionalProperties":false}},"leads":{"type":"array","items":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"variant":{"$ref":"#/components/schemas/PopupVariantKey"},"consent":{"type":"boolean"},"code":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["email","variant","consent","code","createdAt"],"additionalProperties":false}},"leadCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["popup","series","leads","leadCount"],"additionalProperties":false},"PopupFrequency":{"type":"object","properties":{"showAgainAfterDays":{"default":7,"type":"integer","minimum":0,"maximum":365},"maxShows":{"default":3,"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]},"stopAfterConversion":{"default":true,"type":"boolean"}},"required":["showAgainAfterDays","maxShows","stopAfterConversion"],"additionalProperties":false},"PopupId":{"type":"string","pattern":"^pop_[0-9a-hjkmnp-tv-z]{20}$"},"PopupKind":{"type":"string","enum":["coupon","email","exit","upsell","announcement"]},"PopupLayout":{"type":"string","enum":["modal","split","corner","bar","sheet"]},"PopupLeadResult":{"type":"object","properties":{"code":{"type":["string","null"]},"repeat":{"type":"boolean"}},"required":["code","repeat"],"additionalProperties":false},"PopupMotion":{"type":"string","enum":["rise","scale","slide","fade"]},"PopupPage":{"type":"string","enum":["home","product","collection","list-collections","cart","page","search","reviews","other"]},"PopupStatus":{"type":"string","enum":["draft","live","paused","archived"]},"PopupTargeting":{"type":"object","properties":{"pages":{"default":[],"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/PopupPage"}},"productHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"collectionHandles":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":140}},"urlContains":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"urlExcludes":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"devices":{"default":"all","type":"string","enum":["all","desktop","mobile"]},"visitors":{"default":"all","type":"string","enum":["all","new","returning"]},"buyers":{"default":"all","type":"string","enum":["all","buyers","non_buyers"]},"cart":{"default":"any","type":"string","enum":["any","empty","has_items"]},"utmSource":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmMedium":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}},"utmCampaign":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":100}}},"required":["pages","productHandles","collectionHandles","urlContains","urlExcludes","devices","visitors","buyers","cart","utmSource","utmMedium","utmCampaign"],"additionalProperties":false},"PopupTrigger":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/PopupTriggerKind"},"delaySeconds":{"default":8,"type":"integer","minimum":0,"maximum":300},"scrollPercent":{"default":50,"type":"integer","minimum":5,"maximum":100},"pageViews":{"default":2,"type":"integer","minimum":1,"maximum":20},"exitOnMobile":{"default":true,"type":"boolean"}},"required":["kind","delaySeconds","scrollPercent","pageViews","exitOnMobile"],"additionalProperties":false},"PopupTriggerKind":{"type":"string","enum":["delay","scroll","exit","add_to_cart","page_views"]},"PopupVariant":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/PopupVariantKey"},"name":{"type":"string","minLength":1,"maxLength":40},"weight":{"type":"integer","minimum":0,"maximum":100},"content":{"$ref":"#/components/schemas/PopupContent"},"design":{"$ref":"#/components/schemas/PopupDesign"}},"required":["key","name","weight","content","design"],"additionalProperties":false},"PopupVariantKey":{"type":"string","enum":["a","b","c"]},"PopupVariantStats":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/PopupVariantKey"},"impressions":{"type":"integer","minimum":0,"maximum":9007199254740991},"closes":{"type":"integer","minimum":0,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversions":{"type":"integer","minimum":0,"maximum":9007199254740991},"emails":{"type":"integer","minimum":0,"maximum":9007199254740991},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["key","impressions","closes","clicks","conversions","emails","orders","revenueMinor"],"additionalProperties":false},"PresetIcon":{"type":"string","enum":["key","shield","user","code","discord","download","calendar","box","bolt","star"]},"PresetKey":{"type":"string","pattern":"^(?:[a-z][a-z_]{2,30}|custom_[a-z0-9]{8})$"},"PresetOption":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"description":{"default":"","type":"string","maxLength":300},"deliveryNote":{"default":"","type":"string","maxLength":2000}},"required":["name","priceMinor","compareAtMinor","description","deliveryNote"],"additionalProperties":false},"PreviewAudienceSegmentResponse":{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sample":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}},"required":["email","name"],"additionalProperties":false}}},"required":["count","total","sample"],"additionalProperties":false},"PreviewCollectionRulesResponse":{"type":"object","properties":{"productIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}}},"required":["productIds"],"additionalProperties":false},"PreviewInvoiceResponse":{"type":"object","properties":{"filename":{"type":"string"},"base64":{"type":"string"}},"required":["filename","base64"],"additionalProperties":false},"PricingMode":{"type":"string","enum":["fixed","pay_what_you_want","free"]},"PrivacyRequestKind":{"type":"string","enum":["access","delete","correct","opt_out"]},"PrivacyRequestsSettings":{"type":"object","properties":{"title":{"default":"Privacy requests","type":"string","minLength":1,"maxLength":60},"intro":{"default":"Ask for a copy of the data we keep about you, or ask us to correct or delete it. We reply by email within 30 days.","type":"string","minLength":1,"maxLength":300},"kinds":{"default":["access","delete","correct","opt_out"],"minItems":1,"maxItems":4,"type":"array","items":{"$ref":"#/components/schemas/PrivacyRequestKind"}},"footerLink":{"default":true,"type":"boolean"}},"required":["title","intro","kinds","footerLink"],"additionalProperties":false},"Problem":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"detail":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["type","title","status","detail","fields"],"additionalProperties":false},"ProcessorEstimate":{"type":"object","properties":{"feeBps":{"$ref":"#/components/schemas/Bps"},"fixedMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"}},"required":["feeBps","fixedMinor"],"additionalProperties":false},"Product":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"type":"string","minLength":1,"maxLength":140},"type":{"$ref":"#/components/schemas/ProductType"},"status":{"$ref":"#/components/schemas/ProductStatus"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"description":{"type":"string","maxLength":20000},"delivers":{"type":"string","maxLength":200},"coverUrl":{"type":["string","null"]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitsSold":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"visibility":{"default":"public","$ref":"#/components/schemas/ProductVisibility"},"pricingMode":{"default":"fixed","$ref":"#/components/schemas/PricingMode"},"variantCount":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"priceMaxMinor":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"tags":{"default":[],"type":"array","items":{"type":"string"}},"publishAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"planLockedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","storeId","name","slug","type","status","priceMinor","compareAtMinor","currency","description","delivers","coverUrl","stock","lowStockThreshold","unitsSold","revenueMinor","createdAt","updatedAt","visibility","pricingMode","variantCount","priceMaxMinor","tags","publishAt","planLockedAt"],"additionalProperties":false},"ProductAnalytics":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"buckets":{"type":"array","items":{"$ref":"#/components/schemas/BucketKey"}},"products":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"imageUrl":{"default":null,"type":["string","null"]},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"units":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"previousRevenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"refunds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundRateBps":{"$ref":"#/components/schemas/Bps"},"rating":{"type":["number","null"]},"reviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shareBps":{"$ref":"#/components/schemas/Bps"},"daily":{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}},"required":["productId","name","type","imageUrl","orders","units","revenueMinor","previousRevenueMinor","refunds","refundRateBps","rating","reviews","shareBps","daily"],"additionalProperties":false}},"byType":{"type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ProductType"},"units":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["type","units","revenueMinor"],"additionalProperties":false}}},"required":["range","from","to","period","currency","buckets","products","byType"],"additionalProperties":false},"ProductAttributes":{"type":"object","properties":{"game":{"default":null,"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"platforms":{"default":[],"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/GamePlatform"}},"region":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ProductLiveStatus"},{"type":"null"}]},"statusNote":{"default":"","type":"string","maxLength":140},"statusUpdatedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"instantDelivery":{"default":false,"type":"boolean"},"presetKey":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"features":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"featureGroups":{"default":[],"maxItems":24,"type":"array","items":{"$ref":"#/components/schemas/FeatureGroup"}},"requirements":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["game","platforms","region","status","statusNote","statusUpdatedAt","instantDelivery","presetKey","features","featureGroups","requirements"],"additionalProperties":false},"ProductAutoRenewView":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/AutoRenewProductSettings"},"eligible":{"type":"boolean"},"reason":{"type":["string","null"]},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"every":{"type":"string"}},"required":["name","every"],"additionalProperties":false}},"renewingMethods":{"type":"array","items":{"type":"string"}},"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"retrying":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["settings","eligible","reason","options","renewingMethods","active","retrying"],"additionalProperties":false},"ProductBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"product"},"productId":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"title":{"type":"string","maxLength":160},"subtitle":{"default":"","type":"string","maxLength":200},"price":{"default":"","type":"string","maxLength":60},"compareAt":{"default":"","type":"string","maxLength":60},"imageUrl":{"default":"","type":"string","maxLength":800},"url":{"type":"string","maxLength":800},"buttonLabel":{"default":"Buy now","type":"string","maxLength":60},"badge":{"default":"","type":"string","maxLength":40},"layout":{"default":"card","type":"string","enum":["card","row"]}},"required":["id","type","productId","title","subtitle","price","compareAt","imageUrl","url","buttonLabel","badge","layout"],"additionalProperties":false},"ProductBroadcast":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductBroadcastId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"changelog":{"type":"string"},"channels":{"$ref":"#/components/schemas/BroadcastChannels"},"filters":{"$ref":"#/components/schemas/BroadcastFilters"},"status":{"$ref":"#/components/schemas/BroadcastStatus"},"counts":{"$ref":"#/components/schemas/BroadcastCounts"},"file":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"filename":{"type":"string"}},"required":["name","version","filename"],"additionalProperties":false},{"type":"null"}]},"showInLibrary":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","productId","productName","title","version","changelog","channels","filters","status","counts","file","showInLibrary","createdBy","createdAt","finishedAt"],"additionalProperties":false},"ProductBroadcastDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductBroadcastId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"changelog":{"type":"string"},"channels":{"$ref":"#/components/schemas/BroadcastChannels"},"filters":{"$ref":"#/components/schemas/BroadcastFilters"},"status":{"$ref":"#/components/schemas/BroadcastStatus"},"counts":{"$ref":"#/components/schemas/BroadcastCounts"},"file":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"filename":{"type":"string"}},"required":["name","version","filename"],"additionalProperties":false},{"type":"null"}]},"showInLibrary":{"type":"boolean"},"createdBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"doc":{"$ref":"#/components/schemas/EmailDocument"},"dmText":{"type":"string"},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastRecipient"}},"recipientsMatched":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","productId","productName","title","version","changelog","channels","filters","status","counts","file","showInLibrary","createdBy","createdAt","finishedAt","doc","dmText","recipients","recipientsMatched"],"additionalProperties":false},"ProductBroadcastId":{"type":"string","pattern":"^pbc_[0-9a-hjkmnp-tv-z]{20}$"},"ProductConversionReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totals":{"type":"object","properties":{"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cartAdds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewToOrderBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["views","viewers","cartAdds","orders","revenueMinor","viewToOrderBps"],"additionalProperties":false},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductConversionRow"}},"byType":{"type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ProductType"},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewToOrderBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","views","orders","revenueMinor","viewToOrderBps"],"additionalProperties":false}},"searches":{"type":"array","items":{"type":"object","properties":{"term":{"type":"string"},"searches":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"productViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["term","searches","productViews"],"additionalProperties":false}}},"required":["period","currency","totals","products","byType","searches"],"additionalProperties":false},"ProductConversionRow":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cartAdds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"units":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewToCartBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"viewToOrderBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cartToOrderBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"previousOrders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["productId","name","type","views","viewers","cartAdds","orders","units","revenueMinor","viewToCartBps","viewToOrderBps","cartToOrderBps","previousViews","previousOrders"],"additionalProperties":false},"ProductCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"draft":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"archived":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lowStock":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"keysAndSerials":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"memberships":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"services":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bundles":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","active","draft","archived","lowStock","files","keysAndSerials","memberships","services","bundles"],"additionalProperties":false},"ProductDelivery":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/FileDeliverySettings"},"keys":{"$ref":"#/components/schemas/KeyDeliverySettings"},"discord":{"$ref":"#/components/schemas/DiscordDeliverySettings"},"subscription":{"$ref":"#/components/schemas/SubscriptionSettings"},"service":{"$ref":"#/components/schemas/ServiceSettings"},"postPurchaseMessage":{"type":"string","maxLength":5000},"redirectUrl":{"anyOf":[{"$ref":"#/components/schemas/HttpsUrl"},{"type":"null"}]},"dynamic":{"default":{"enabled":false,"url":null,"secretVersion":1},"$ref":"#/components/schemas/DynamicDeliverySettings"},"warranty":{"default":{"days":null,"terms":""},"$ref":"#/components/schemas/WarrantySettings"}},"required":["file","keys","discord","subscription","service","postPurchaseMessage","redirectUrl","dynamic","warranty"],"additionalProperties":false},"ProductFile":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductFileId"},"name":{"type":"string","minLength":1,"maxLength":120},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"versions":{"type":"array","items":{"$ref":"#/components/schemas/ProductFileVersion"}},"downloads":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","position","versions","downloads"],"additionalProperties":false},"ProductFileId":{"type":"string","pattern":"^fil_[0-9a-hjkmnp-tv-z]{20}$"},"ProductFileVersion":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FileVersionId"},"version":{"type":"string","minLength":1,"maxLength":40},"filename":{"type":"string"},"contentType":{"type":"string"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"sha256":{"type":["string","null"]},"changelog":{"type":"string","maxLength":5000},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","version","filename","contentType","bytes","sha256","changelog","createdAt"],"additionalProperties":false},"ProductFraud":{"type":"object","properties":{"blockVpn":{"type":"boolean"},"requireVerifiedEmail":{"type":"boolean"}},"required":["blockVpn","requireVerifiedEmail"],"additionalProperties":false},"ProductFull":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"type":"string","minLength":1,"maxLength":140},"type":{"$ref":"#/components/schemas/ProductType"},"status":{"$ref":"#/components/schemas/ProductStatus"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"description":{"type":"string","maxLength":20000},"delivers":{"type":"string","maxLength":200},"coverUrl":{"type":["string","null"]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitsSold":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"visibility":{"$ref":"#/components/schemas/ProductVisibility"},"pricingMode":{"$ref":"#/components/schemas/PricingMode"},"variantCount":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"priceMaxMinor":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"tags":{"maxItems":30,"type":"array","items":{"type":"string"}},"publishAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"planLockedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"descriptionHtml":{"type":"string"},"shortDescription":{"type":"string","maxLength":300},"featured":{"type":"boolean"},"pwywMinMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"pwywSuggestedMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"taxCategory":{"$ref":"#/components/schemas/TaxCategory"},"taxCategoryReview":{"$ref":"#/components/schemas/TaxCategoryReview"},"minPerOrder":{"type":"integer","minimum":1,"maximum":9007199254740991},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"maxPerCustomer":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"stockMode":{"$ref":"#/components/schemas/StockMode"},"outOfStockBehavior":{"$ref":"#/components/schemas/OutOfStockBehavior"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariant"}},"media":{"type":"array","items":{"$ref":"#/components/schemas/ProductMedia"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/ProductFile"}},"keyStats":{"anyOf":[{"$ref":"#/components/schemas/KeyPoolStats"},{"type":"null"}]},"delivery":{"$ref":"#/components/schemas/ProductDelivery"},"checkoutFields":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutField"}},"seo":{"$ref":"#/components/schemas/ProductSeo"},"previousSlugs":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"$ref":"#/components/schemas/CollectionId"}},"categoryIds":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CategoryId"}},"upsellIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"crossSellIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"bundleProductIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"bundleParts":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/BundlePart"}},"bundlePricing":{"default":{"kind":"fixed"},"$ref":"#/components/schemas/BundlePricing"},"quantityTiers":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/QuantityTier"}},"tiersWithCoupons":{"default":true,"type":"boolean"},"paymentRules":{"default":{"disabledMethods":[],"multipliers":[]},"$ref":"#/components/schemas/PaymentRules"},"affiliateCommissionBps":{"anyOf":[{"$ref":"#/components/schemas/Bps"},{"type":"null"}]},"fraud":{"$ref":"#/components/schemas/ProductFraud"},"templateSuffix":{"type":["string","null"]},"deletedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"attributes":{"default":{"game":null,"platforms":[],"region":null,"status":null,"statusNote":"","statusUpdatedAt":null,"instantDelivery":false,"presetKey":null,"features":[],"featureGroups":[],"requirements":[]},"$ref":"#/components/schemas/ProductAttributes"}},"required":["id","storeId","name","slug","type","status","priceMinor","compareAtMinor","currency","description","delivers","coverUrl","stock","lowStockThreshold","unitsSold","revenueMinor","createdAt","updatedAt","visibility","pricingMode","variantCount","priceMaxMinor","tags","publishAt","planLockedAt","descriptionHtml","shortDescription","featured","pwywMinMinor","pwywSuggestedMinor","taxCategory","minPerOrder","maxPerOrder","maxPerCustomer","stockMode","outOfStockBehavior","variants","media","files","keyStats","delivery","checkoutFields","seo","previousSlugs","collectionIds","categoryIds","upsellIds","crossSellIds","bundleProductIds","bundleParts","bundlePricing","quantityTiers","tiersWithCoupons","paymentRules","affiliateCommissionBps","fraud","templateSuffix","deletedAt","attributes"],"additionalProperties":false},"ProductId":{"type":"string","pattern":"^prd_[0-9a-hjkmnp-tv-z]{20}$"},"ProductImportResult":{"type":"object","properties":{"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"categoriesCreated":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"rows":{"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/ProductImportRow"}},"errors":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"column":{"type":"string"},"message":{"type":"string"}},"required":["line","column","message"],"additionalProperties":false}},"dryRun":{"type":"boolean"}},"required":["created","updated","skipped","categoriesCreated","rows","errors","dryRun"],"additionalProperties":false},"ProductImportRow":{"type":"object","properties":{"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"slug":{"type":"string"},"action":{"type":"string","enum":["create","update","skip"]},"message":{"type":"string"}},"required":["line","slug","action","message"],"additionalProperties":false},"ProductLastEdit":{"type":"object","properties":{"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"editedBy":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"you":{"type":"boolean"},"viaAi":{"type":"boolean"}},"required":["name","you","viaAi"],"additionalProperties":false},{"type":"null"}]},"editedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"salesSince":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["updatedAt","editedBy","editedAt","salesSince"],"additionalProperties":false},"ProductLicensing":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"settings":{"$ref":"#/components/schemas/LicenseSettings"},"publishableKey":{"anyOf":[{"$ref":"#/components/schemas/PublishableLicenseKey"},{"type":"null"}]},"publicKey":{"type":["string","null"]},"publicKeyId":{"type":["string","null"]},"keysRotatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"plans":{"type":"array","items":{"$ref":"#/components/schemas/LicensePlanOut"}},"linkedComponents":{"type":"array","items":{"$ref":"#/components/schemas/LinkedComponent"}},"pausedNow":{"anyOf":[{"$ref":"#/components/schemas/SalesPause"},{"type":"null"}]},"recentPauses":{"type":"array","items":{"$ref":"#/components/schemas/SalesPause"}},"stats":{"type":"object","properties":{"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"notStarted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revoked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"devices":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"validations24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["active","expired","notStarted","revoked","devices","validations24h"],"additionalProperties":false}},"required":["productId","settings","publishableKey","publicKey","publicKeyId","keysRotatedAt","plans","linkedComponents","pausedNow","recentPauses","stats"],"additionalProperties":false},"ProductLiveStatus":{"type":"string","enum":["undetected","updated","testing","updating","detected","down"]},"ProductMedia":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/MediaId"},"url":{"type":"string"},"alt":{"type":"string","maxLength":200},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"contentType":{"type":"string"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"default":"image","$ref":"#/components/schemas/ProductMediaKind"},"posterUrl":{"default":null,"type":["string","null"]},"externalId":{"default":null,"type":["string","null"]}},"required":["id","url","alt","width","height","contentType","bytes","position","kind","posterUrl","externalId"],"additionalProperties":false},"ProductMediaKind":{"type":"string","enum":["image","video","youtube","vimeo"]},"ProductMoved":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["productId","index","total"],"additionalProperties":false},"ProductPick":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"price":{"type":"string"},"url":{"type":"string"},"imageUrl":{"type":"string"}},"required":["id","name","price","url","imageUrl"],"additionalProperties":false},"ProductPreset":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"description":{"type":"string","maxLength":200},"icon":{"$ref":"#/components/schemas/PresetIcon"},"type":{"$ref":"#/components/schemas/ProductType"},"titleTemplate":{"type":"string","minLength":1,"maxLength":120},"shortDescription":{"type":"string","maxLength":300},"descriptionMd":{"type":"string","maxLength":5000},"tags":{"maxItems":12,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"options":{"maxItems":12,"type":"array","items":{"$ref":"#/components/schemas/PresetOption"}},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"platforms":{"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/GamePlatform"}},"region":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"status":{"anyOf":[{"$ref":"#/components/schemas/ProductLiveStatus"},{"type":"null"}]},"instantDelivery":{"type":"boolean"},"keyInstructions":{"type":"string","maxLength":2000},"postPurchaseMessage":{"type":"string","maxLength":5000},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"needsGame":{"type":"boolean"},"downloadLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":100000},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]},"discordRoleName":{"type":"string","maxLength":100},"key":{"$ref":"#/components/schemas/PresetKey"},"builtin":{"type":"boolean"},"edited":{"type":"boolean"},"isDefault":{"type":"boolean"},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["name","description","icon","type","titleTemplate","shortDescription","descriptionMd","tags","options","priceMinor","platforms","region","status","instantDelivery","keyInstructions","postPurchaseMessage","maxPerOrder","needsGame","downloadLimit","stock","turnaroundDays","discordRoleName","key","builtin","edited","isDefault","productCount","updatedAt"],"additionalProperties":false},"ProductReplacementPolicy":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"policy":{"$ref":"#/components/schemas/ReplacementPolicy"},"warrantyDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"stats":{"type":"object","properties":{"pending":{"type":"integer","minimum":0,"maximum":9007199254740991},"approved30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"rejected30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"poolAvailable":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["pending","approved30d","rejected30d","poolAvailable"],"additionalProperties":false}},"required":["productId","policy","warrantyDays","stats"],"additionalProperties":false},"ProductSaved":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"type":"string","minLength":1,"maxLength":140},"type":{"$ref":"#/components/schemas/ProductType"},"status":{"$ref":"#/components/schemas/ProductStatus"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"description":{"type":"string","maxLength":20000},"delivers":{"type":"string","maxLength":200},"coverUrl":{"type":["string","null"]},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"lowStockThreshold":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitsSold":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"visibility":{"$ref":"#/components/schemas/ProductVisibility"},"pricingMode":{"$ref":"#/components/schemas/PricingMode"},"variantCount":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"priceMaxMinor":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"tags":{"maxItems":30,"type":"array","items":{"type":"string"}},"publishAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"planLockedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"descriptionHtml":{"type":"string"},"shortDescription":{"type":"string","maxLength":300},"featured":{"type":"boolean"},"pwywMinMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"pwywSuggestedMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"taxCategory":{"$ref":"#/components/schemas/TaxCategory"},"taxCategoryReview":{"$ref":"#/components/schemas/TaxCategoryReview"},"minPerOrder":{"type":"integer","minimum":1,"maximum":9007199254740991},"maxPerOrder":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"maxPerCustomer":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"stockMode":{"$ref":"#/components/schemas/StockMode"},"outOfStockBehavior":{"$ref":"#/components/schemas/OutOfStockBehavior"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariant"}},"media":{"type":"array","items":{"$ref":"#/components/schemas/ProductMedia"}},"files":{"type":"array","items":{"$ref":"#/components/schemas/ProductFile"}},"keyStats":{"anyOf":[{"$ref":"#/components/schemas/KeyPoolStats"},{"type":"null"}]},"delivery":{"$ref":"#/components/schemas/ProductDelivery"},"checkoutFields":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutField"}},"seo":{"$ref":"#/components/schemas/ProductSeo"},"previousSlugs":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"$ref":"#/components/schemas/CollectionId"}},"categoryIds":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CategoryId"}},"upsellIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"crossSellIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"bundleProductIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"bundleParts":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/BundlePart"}},"bundlePricing":{"default":{"kind":"fixed"},"$ref":"#/components/schemas/BundlePricing"},"quantityTiers":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/QuantityTier"}},"tiersWithCoupons":{"default":true,"type":"boolean"},"paymentRules":{"default":{"disabledMethods":[],"multipliers":[]},"$ref":"#/components/schemas/PaymentRules"},"affiliateCommissionBps":{"anyOf":[{"$ref":"#/components/schemas/Bps"},{"type":"null"}]},"fraud":{"$ref":"#/components/schemas/ProductFraud"},"templateSuffix":{"type":["string","null"]},"deletedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"attributes":{"default":{"game":null,"platforms":[],"region":null,"status":null,"statusNote":"","statusUpdatedAt":null,"instantDelivery":false,"presetKey":null,"features":[],"featureGroups":[],"requirements":[]},"$ref":"#/components/schemas/ProductAttributes"},"keyImport":{"default":{"added":0,"alreadyInPool":0},"type":"object","properties":{"added":{"type":"integer","minimum":0,"maximum":9007199254740991},"alreadyInPool":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["added","alreadyInPool"],"additionalProperties":false}},"required":["id","storeId","name","slug","type","status","priceMinor","compareAtMinor","currency","description","delivers","coverUrl","stock","lowStockThreshold","unitsSold","revenueMinor","createdAt","updatedAt","visibility","pricingMode","variantCount","priceMaxMinor","tags","publishAt","planLockedAt","descriptionHtml","shortDescription","featured","pwywMinMinor","pwywSuggestedMinor","taxCategory","minPerOrder","maxPerOrder","maxPerCustomer","stockMode","outOfStockBehavior","variants","media","files","keyStats","delivery","checkoutFields","seo","previousSlugs","collectionIds","categoryIds","upsellIds","crossSellIds","bundleProductIds","bundleParts","bundlePricing","quantityTiers","tiersWithCoupons","paymentRules","affiliateCommissionBps","fraud","templateSuffix","deletedAt","attributes","keyImport"],"additionalProperties":false},"ProductSeo":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"ogImage":{"type":"string","enum":["cover","custom"]},"ogImageUrl":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["title","description","ogImage","ogImageUrl"],"additionalProperties":false},"ProductStatus":{"type":"string","enum":["active","draft","archived"]},"ProductStatusRow":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"slug":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"game":{"type":["string","null"]},"status":{"anyOf":[{"$ref":"#/components/schemas/ProductLiveStatus"},{"type":"null"}]},"statusNote":{"type":"string"},"statusUpdatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"productStatus":{"type":"string","enum":["active","draft","archived"]}},"required":["productId","name","slug","type","game","status","statusNote","statusUpdatedAt","productStatus"],"additionalProperties":false},"ProductStatusView":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"status":{"anyOf":[{"$ref":"#/components/schemas/ProductLiveStatus"},{"type":"null"}]},"label":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"},"severity":{"$ref":"#/components/schemas/StatusSeverity"}},"required":["name","color","severity"],"additionalProperties":false},{"type":"null"}]},"source":{"type":"string","enum":["component","product"]},"componentId":{"anyOf":[{"$ref":"#/components/schemas/StatusComponentId"},{"type":"null"}]},"note":{"type":"string"},"noteSource":{"type":"string","enum":["incident","seller"]},"incidentId":{"anyOf":[{"$ref":"#/components/schemas/StatusIncidentId"},{"type":"null"}]},"since":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"paused":{"anyOf":[{"type":"object","properties":{"label":{"type":"string"},"color":{"type":"string"},"since":{"$ref":"#/components/schemas/Timestamp"}},"required":["label","color","since"],"additionalProperties":false},{"type":"null"}]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["productId","status","label","source","componentId","note","noteSource","incidentId","since","paused","updatedAt"],"additionalProperties":false},"ProductSubscriber":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SubscriptionId"},"email":{"type":"string"},"state":{"$ref":"#/components/schemas/SubscriberState"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"currentPeriodEnd":{"$ref":"#/components/schemas/Timestamp"},"renewals":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"endedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","email","state","orderId","orderNumber","currentPeriodEnd","renewals","createdAt","endedAt"],"additionalProperties":false},"ProductType":{"type":"string","enum":["file","license_key","serial","subscription","discord_role","service","bundle"]},"ProductVariant":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/VariantId"},"name":{"type":"string","minLength":1,"maxLength":80},"description":{"type":"string","maxLength":300},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"enabled":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"keysAvailable":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"lowStockThreshold":{"default":null,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"deliveryNote":{"type":"string","maxLength":2000},"fileIds":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/ProductFileId"}},"discordRoleId":{"anyOf":[{"$ref":"#/components/schemas/DiscordObjectId"},{"type":"null"}]},"unitsSold":{"type":"integer","minimum":0,"maximum":9007199254740991},"paymentRules":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PaymentRules"},{"type":"null"}]}},"required":["id","name","description","priceMinor","compareAtMinor","position","enabled","stock","keysAvailable","lowStockThreshold","deliveryNote","fileIds","discordRoleId","unitsSold","paymentRules"],"additionalProperties":false},"ProductVisibility":{"type":"string","enum":["public","unlisted","private"]},"ProductWatermark":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"settings":{"$ref":"#/components/schemas/WatermarkSettings"},"marked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastMarkedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"filename":{"type":"string"},"kind":{"anyOf":[{"$ref":"#/components/schemas/WatermarkKind"},{"type":"null"}]}},"required":["name","filename","kind"],"additionalProperties":false}}},"required":["productId","settings","marked","lastMarkedAt","files"],"additionalProperties":false},"Profile":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"pendingEmail":{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},"twoFactor":{"type":"object","properties":{"enabled":{"type":"boolean"},"enabledAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"recoveryCodesLeft":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["enabled","enabledAt","recoveryCodesLeft"],"additionalProperties":false},"passwordChangedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/SessionInfo"}},"hasPassword":{"default":true,"type":"boolean"},"google":{"default":null,"anyOf":[{"$ref":"#/components/schemas/GoogleLink"},{"type":"null"}]}},"required":["user","pendingEmail","twoFactor","passwordChangedAt","sessions","hasPassword","google"],"additionalProperties":false},"PromoBarPublic":{"type":"object","properties":{"message":{"default":"Use {code} for {reward}","type":"string","minLength":1,"maxLength":140},"position":{"default":"top","type":"string","enum":["top","bottom"]},"tone":{"default":"accent","type":"string","enum":["accent","dark","warn"]},"dismissible":{"default":true,"type":"boolean"},"showCopy":{"default":true,"type":"boolean"},"applyLink":{"default":true,"type":"boolean"},"code":{"type":"string","maxLength":40},"reward":{"type":"string","maxLength":60},"endsAt":{"type":["string","null"]}},"required":["message","position","tone","dismissible","showCopy","applyLink","code","reward","endsAt"],"additionalProperties":false},"Promotion":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"percentOffBps":{"type":"integer","minimum":100,"maximum":9000},"target":{"$ref":"#/components/schemas/PromotionTarget"},"collectionIds":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/CollectionId"}},"categoryIds":{"default":[],"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/CategoryId"}},"productIds":{"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"startsAt":{"$ref":"#/components/schemas/Timestamp"},"endsAt":{"$ref":"#/components/schemas/Timestamp"},"stacking":{"$ref":"#/components/schemas/PromotionStacking"},"banner":{"$ref":"#/components/schemas/PromotionBanner"},"enabled":{"type":"boolean"},"id":{"$ref":"#/components/schemas/PromotionId"},"state":{"$ref":"#/components/schemas/PromotionState"},"productCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"savingsMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","percentOffBps","target","collectionIds","categoryIds","productIds","startsAt","endsAt","stacking","banner","enabled","id","state","productCount","orders","revenueMinor","savingsMinor","currency","createdAt","updatedAt"],"additionalProperties":false},"PromotionBanner":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"text":{"default":"{percent} off for a limited time","type":"string","maxLength":120},"tone":{"default":"accent","$ref":"#/components/schemas/BannerTone"},"countdown":{"default":true,"type":"boolean"},"link":{"default":"","type":"string","maxLength":300,"pattern":"^(?:|\\/[^\\s]*)$"}},"required":["enabled","text","tone","countdown","link"],"additionalProperties":false},"PromotionCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"running":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ended":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"draft":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","running","scheduled","ended","draft"],"additionalProperties":false},"PromotionId":{"type":"string","pattern":"^prm_[0-9a-hjkmnp-tv-z]{20}$"},"PromotionStacking":{"type":"string","enum":["stack","exclusive"]},"PromotionState":{"type":"string","enum":["draft","scheduled","running","ended","paused"]},"PromotionTarget":{"type":"string","enum":["all","collections","products","categories"]},"ProofUploadTicket":{"type":"object","properties":{"attachmentId":{"$ref":"#/components/schemas/TicketAttachmentId"},"claim":{"type":"string"},"url":{"type":"string"},"method":{"type":"string","const":"PUT"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"maxBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["attachmentId","claim","url","method","headers","maxBytes"],"additionalProperties":false},"ProviderHealth":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/GatewayProvider"},"phase":{"$ref":"#/components/schemas/BreakerPhase"},"failures":{"type":"integer","minimum":0,"maximum":9007199254740991},"openUntil":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastFailureAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastFailureKind":{"anyOf":[{"$ref":"#/components/schemas/PaymentFailureKind"},{"type":"null"}]},"lastSuccessAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["provider","phase","failures","openUntil","lastFailureAt","lastFailureKind","lastSuccessAt"],"additionalProperties":false},"PublicIncident":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusIncidentId"},"kind":{"$ref":"#/components/schemas/IncidentKind"},"title":{"type":"string"},"state":{"$ref":"#/components/schemas/IncidentState"},"components":{"type":"array","items":{"type":"string"}},"label":{"anyOf":[{"$ref":"#/components/schemas/PublicStatusLabel"},{"type":"null"}]},"scheduledStart":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"scheduledEnd":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"resolvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"updates":{"type":"array","items":{"$ref":"#/components/schemas/IncidentUpdate"}}},"required":["id","kind","title","state","components","label","scheduledStart","scheduledEnd","startedAt","resolvedAt","updates"],"additionalProperties":false},"PublicStatusComponent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusComponentId"},"name":{"type":"string"},"description":{"type":"string"},"group":{"type":"string"},"note":{"type":"string"},"productId":{"anyOf":[{"$ref":"#/components/schemas/ProductId"},{"type":"null"}]},"productHandle":{"type":["string","null"]},"label":{"$ref":"#/components/schemas/PublicStatusLabel"},"since":{"$ref":"#/components/schemas/Timestamp"},"uptimePct":{"type":["number","null"]},"history":{"type":"array","items":{"$ref":"#/components/schemas/UptimeDay"}},"salesPaused":{"default":false,"type":"boolean"}},"required":["id","name","description","group","note","productId","productHandle","label","since","uptimePct","history","salesPaused"],"additionalProperties":false},"PublicStatusLabel":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusLabelId"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"$ref":"#/components/schemas/StatusIcon"},"color":{"$ref":"#/components/schemas/HexColor"},"severity":{"$ref":"#/components/schemas/StatusSeverity"}},"required":["id","name","description","icon","color","severity"],"additionalProperties":false},"PublicStatusPage":{"type":"object","properties":{"page":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"historyDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"showUptime":{"type":"boolean"},"allowSubscribers":{"type":"boolean"},"theme":{"$ref":"#/components/schemas/StatusPageTheme"},"isDefault":{"type":"boolean"},"embedOrigins":{"type":"array","items":{"type":"string"}}},"required":["slug","name","description","historyDays","showUptime","allowSubscribers","theme","isDefault","embedOrigins"],"additionalProperties":false},"store":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"logoUrl":{"type":["string","null"]},"brandColor":{"type":"string"},"timeZone":{"default":"UTC","type":"string"}},"required":["name","url","logoUrl","brandColor","timeZone"],"additionalProperties":false},"overall":{"type":"object","properties":{"severity":{"$ref":"#/components/schemas/StatusSeverity"},"label":{"type":"string"},"color":{"$ref":"#/components/schemas/HexColor"}},"required":["severity","label","color"],"additionalProperties":false},"labels":{"type":"array","items":{"$ref":"#/components/schemas/PublicStatusLabel"}},"components":{"type":"array","items":{"$ref":"#/components/schemas/PublicStatusComponent"}},"active":{"type":"array","items":{"$ref":"#/components/schemas/PublicIncident"}},"upcoming":{"type":"array","items":{"$ref":"#/components/schemas/PublicIncident"}},"history":{"type":"array","items":{"$ref":"#/components/schemas/PublicIncident"}},"pages":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}},"required":["slug","name"],"additionalProperties":false}},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["page","store","overall","labels","components","active","upcoming","history","pages","updatedAt"],"additionalProperties":false},"PublicStatusSummary":{"type":"object","properties":{"overall":{"type":"object","properties":{"severity":{"$ref":"#/components/schemas/StatusSeverity"},"label":{"type":"string"},"color":{"$ref":"#/components/schemas/HexColor"}},"required":["severity","label","color"],"additionalProperties":false},"components":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusComponentId"},"name":{"type":"string"},"group":{"type":"string"},"page":{"type":"string"},"productId":{"anyOf":[{"$ref":"#/components/schemas/ProductId"},{"type":"null"}]},"productHandle":{"type":["string","null"]},"label":{"$ref":"#/components/schemas/PublicStatusLabel"},"since":{"$ref":"#/components/schemas/Timestamp"},"note":{"type":"string"},"salesPaused":{"default":false,"type":"boolean"}},"required":["id","name","group","page","productId","productHandle","label","since","note","salesPaused"],"additionalProperties":false}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/PublicStatusLabel"}},"activeIncidents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["overall","components","labels","activeIncidents","updatedAt"],"additionalProperties":false},"PublishThemeResponse":{"type":"object","properties":{"version":{"$ref":"#/components/schemas/ThemeVersionSummary"},"theme":{"$ref":"#/components/schemas/ThemeSummary"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}}},"required":["version","theme","warnings"],"additionalProperties":false},"PublishableLicenseKey":{"type":"string","pattern":"^pk_[0-9a-hjkmnp-tv-z]{32}$"},"PurchaseAlertsSettings":{"type":"object","properties":{"delaySeconds":{"default":6},"intervalSeconds":{"default":18},"maxPerVisit":{"default":4},"position":{"default":"bottom-left","type":"string","enum":["bottom-left","bottom-right"]},"showCountry":{"default":true,"type":"boolean"},"showCover":{"default":true,"type":"boolean"}},"required":["delaySeconds","intervalSeconds","maxPerVisit","position","showCountry","showCover"],"additionalProperties":false},"PushDevice":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PushSubscriptionId"},"label":{"type":"string"},"service":{"type":"string"},"fingerprint":{"type":"string","pattern":"^[0-9a-f]{16}$"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastSentAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"failures":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","label","service","fingerprint","createdAt","lastSentAt","failures"],"additionalProperties":false},"PushKind":{"type":"string","enum":["sale","payment_waiting","payment_review","dispute","payout","low_stock","fraud_review","ticket_new","ticket_reply"]},"PushPreferences":{"type":"object","properties":{"kinds":{"type":"object","properties":{"sale":{"type":"boolean"},"dispute":{"type":"boolean"},"payout":{"type":"boolean"},"low_stock":{"type":"boolean"},"fraud_review":{"type":"boolean"},"ticket_new":{"default":true,"type":"boolean"},"ticket_reply":{"type":"boolean"},"payment_waiting":{"default":true,"type":"boolean"},"payment_review":{"default":true,"type":"boolean"}},"required":["sale","dispute","payout","low_stock","fraud_review","ticket_new","ticket_reply","payment_waiting","payment_review"],"additionalProperties":false},"quietHours":{"$ref":"#/components/schemas/QuietHours"}},"required":["kinds","quietHours"],"additionalProperties":false},"PushSettings":{"type":"object","properties":{"publicKey":{"type":["string","null"]},"simulated":{"type":"boolean"},"preferences":{"$ref":"#/components/schemas/PushPreferences"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/PushDevice"}},"blockedKinds":{"type":"array","items":{"$ref":"#/components/schemas/PushKind"}}},"required":["publicKey","simulated","preferences","devices","blockedKinds"],"additionalProperties":false},"PushSubscriptionId":{"type":"string","pattern":"^psh_[0-9a-hjkmnp-tv-z]{20}$"},"PushTestResult":{"type":"object","properties":{"sent":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"removed":{"type":"integer","minimum":0,"maximum":9007199254740991},"detail":{"type":"string"}},"required":["sent","failed","removed","detail"],"additionalProperties":false},"QuantityTier":{"type":"object","properties":{"minQuantity":{"type":"integer","minimum":2,"maximum":10000},"discountBps":{"type":"integer","minimum":1,"maximum":9500}},"required":["minQuantity","discountBps"],"additionalProperties":false},"QuietClock":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"QuietHours":{"type":"object","properties":{"enabled":{"type":"boolean"},"start":{"$ref":"#/components/schemas/QuietClock"},"end":{"$ref":"#/components/schemas/QuietClock"},"timeZone":{"$ref":"#/components/schemas/TimeZoneName"}},"required":["enabled","start","end","timeZone"],"additionalProperties":false},"RatingSummary":{"type":"object","properties":{"average":{"type":"number","minimum":0,"maximum":5},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"distribution":{"minItems":5,"maxItems":5,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}},"responseRateBps":{"$ref":"#/components/schemas/Bps"},"requestsSent90d":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["average","count","distribution","responseRateBps","requestsSent90d"],"additionalProperties":false},"RealtimeReport":{"type":"object","properties":{"at":{"$ref":"#/components/schemas/Timestamp"},"activeNow":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"activeLast30":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"perMinute":{"type":"array","items":{"type":"object","properties":{"minute":{"$ref":"#/components/schemas/Timestamp"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageviews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["minute","visitors","pageviews"],"additionalProperties":false}},"pages":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","visitors"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Channel"},"source":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["channel","source","visitors"],"additionalProperties":false}},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["country","visitors"],"additionalProperties":false}},"devices":{"type":"array","items":{"type":"object","properties":{"device":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["device","visitors"],"additionalProperties":false}},"events":{"type":"array","items":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AnalyticsEventName"},"path":{"type":"string"},"country":{"type":"string"},"device":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"},"valueMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["name","path","country","device","at","valueMinor"],"additionalProperties":false}},"botHitsLastHour":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["at","activeNow","activeLast30","perMinute","pages","sources","countries","devices","events","botHitsLastHour","currency"],"additionalProperties":false},"ReassignTemplateResponse":{"type":"object","properties":{"updated":{"type":"integer","minimum":0,"maximum":9007199254740991},"productIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"collectionIds":{"type":"array","items":{"$ref":"#/components/schemas/CollectionId"}},"pageIds":{"type":"array","items":{"$ref":"#/components/schemas/PageId"}}},"required":["updated","productIds","collectionIds","pageIds"],"additionalProperties":false},"RebaseTemplateReleaseResponse":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/TemplateReleaseDetail"},"conflicts":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"line":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"message":{"type":"string"}},"required":["path","line","message"],"additionalProperties":false}}},"required":["detail","conflicts"],"additionalProperties":false},"RebuildSearchIndexResponse":{"type":"object","properties":{"products":{"type":"integer","minimum":0,"maximum":9007199254740991},"collections":{"type":"integer","minimum":0,"maximum":9007199254740991},"pages":{"type":"integer","minimum":0,"maximum":9007199254740991},"terms":{"type":"integer","minimum":0,"maximum":9007199254740991},"builtAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"buildMs":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["products","collections","pages","terms","builtAt","buildMs"],"additionalProperties":false},"RecentPurchase":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productHandle":{"type":"string","maxLength":140},"productTitle":{"type":"string","maxLength":200},"buyer":{"type":"string","minLength":1,"maxLength":12},"country":{"anyOf":[{"$ref":"#/components/schemas/CountryCode"},{"type":"null"}]},"minutesAgo":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["productId","productHandle","productTitle","buyer","country","minutesAgo"],"additionalProperties":false},"RecentlyViewedSettings":{"type":"object","properties":{"heading":{"default":"Recently viewed","type":"string","minLength":1,"maxLength":60},"maxItems":{"default":6,"type":"integer","minimum":2,"maximum":12},"pages":{"default":"product_and_cart","type":"string","enum":["product","product_and_cart","all"]}},"required":["heading","maxItems","pages"],"additionalProperties":false},"RecordingChunkAccepted":{"type":"object","properties":{"stored":{"type":"boolean"},"stop":{"type":"boolean"},"next":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["stored","stop","next"],"additionalProperties":false},"RecordingExclusion":{"type":"object","properties":{"excluded":{"type":"boolean"},"reason":{"type":["string","null"]},"at":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["excluded","reason","at"],"additionalProperties":false},"RecordingPlan":{"type":"object","properties":{"maxBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"maxEvents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"maxMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"flushMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["maxBytes","maxEvents","maxMinutes","flushMs"],"additionalProperties":false},"RecordingState":{"type":"string","enum":["none","recording","available","expired"]},"RecoveryCodes":{"type":"object","properties":{"recoveryCodes":{"type":"array","items":{"type":"string"}}},"required":["recoveryCodes"],"additionalProperties":false},"RedditPixelSettings":{"type":"object","properties":{"pixelId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^t2_[a-z0-9]{4,24}$"}]},"ecommerce":{"default":true,"type":"boolean"}},"required":["pixelId","ecommerce"],"additionalProperties":false},"ReferralMonth":{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"state":{"type":"string","enum":["added","coming"]},"on":{"$ref":"#/components/schemas/IsoDate"}},"required":["month","amountMinor","state","on"],"additionalProperties":false},"ReferralOverview":{"type":"object","properties":{"link":{"type":"string"},"code":{"$ref":"#/components/schemas/StoreHandle"},"terms":{"$ref":"#/components/schemas/ReferralTerms"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"earnedMinor":{"$ref":"#/components/schemas/MinorUnits"},"comingMinor":{"$ref":"#/components/schemas/MinorUnits"},"stores":{"type":"array","items":{"$ref":"#/components/schemas/ReferredStore"}},"months":{"type":"array","items":{"$ref":"#/components/schemas/ReferralMonth"}}},"required":["link","code","terms","currency","earnedMinor","comingMinor","stores","months"],"additionalProperties":false},"ReferralSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"shareBps":{"maximum":5000,"$ref":"#/components/schemas/Bps"},"months":{"type":"integer","minimum":1,"maximum":60},"holdDays":{"type":"integer","minimum":0,"maximum":120},"linkDays":{"type":"integer","minimum":1,"maximum":365}},"required":["enabled","shareBps","months","holdDays","linkDays"],"additionalProperties":false},"ReferralTerms":{"type":"object","properties":{"enabled":{"type":"boolean"},"shareBps":{"maximum":5000,"$ref":"#/components/schemas/Bps"},"months":{"type":"integer","minimum":1,"maximum":60},"holdDays":{"type":"integer","minimum":0,"maximum":120},"linkDays":{"type":"integer","minimum":1,"maximum":365}},"required":["enabled","shareBps","months","holdDays","linkDays"],"additionalProperties":false},"ReferredStore":{"type":"object","properties":{"name":{"type":"string"},"joinedAt":{"$ref":"#/components/schemas/Timestamp"},"endsAt":{"$ref":"#/components/schemas/Timestamp"},"status":{"$ref":"#/components/schemas/ReferredStoreStatus"}},"required":["name","joinedAt","endsAt","status"],"additionalProperties":false},"ReferredStoreStatus":{"type":"string","enum":["joined","earning","ended","removed"]},"RefundOffer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RefundOfferId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"amountMinor":{"minimum":1,"$ref":"#/components/schemas/MinorUnits"},"bonusMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/RefundOfferStatus"},"source":{"$ref":"#/components/schemas/RefundOfferSource"},"reason":{"type":"string"},"createdBy":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","orderId","orderNumber","amountMinor","bonusMinor","currency","status","source","reason","createdBy","createdAt","decidedAt","expiresAt"],"additionalProperties":false},"RefundOfferId":{"type":"string","pattern":"^rfo_[0-9a-hjkmnp-tv-z]{20}$"},"RefundOfferSource":{"type":"string","enum":["seller","claim"]},"RefundOfferStatus":{"type":"string","enum":["pending","credit","original","cancelled","expired"]},"RegionNoticeSettings":{"type":"object","properties":{"message":{"default":"This key is for {region}. You seem to be in {country}. Check that it activates where you play before you buy.","type":"string","minLength":1,"maxLength":220},"placement":{"default":"product_and_cart","type":"string","enum":["product","product_and_cart"]},"regions":{"default":[],"maxItems":12,"type":"array","items":{"type":"object","properties":{"a":{"type":"string","minLength":1,"maxLength":40},"b":{"type":"string","maxLength":600,"pattern":"^\\s*[A-Za-z]{2}(?:\\s*[,;\\s]\\s*[A-Za-z]{2})*\\s*$"}},"required":["a","b"],"additionalProperties":false}}},"required":["message","placement","regions"],"additionalProperties":false},"RegisterByInviteResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"store":{"$ref":"#/components/schemas/StoreSummary"}},"required":["user","store"],"additionalProperties":false},"RemoveKeysResponse":{"type":"object","properties":{"removed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stock":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["removed","stock"],"additionalProperties":false},"RenameThemeTemplateResponse":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/ThemeTemplate"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}},"reassigned":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["template","revision","issues","reassigned"],"additionalProperties":false},"RenderEmailPreviewResponse":{"type":"object","properties":{"subject":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["subject","html","text","issues"],"additionalProperties":false},"RenewalChargeId":{"type":"string","pattern":"^rch_[0-9a-hjkmnp-tv-z]{20}$"},"RenewalChargeView":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RenewalChargeId"},"periodEnd":{"$ref":"#/components/schemas/Timestamp"},"attempt":{"type":"integer","minimum":1,"maximum":9007199254740991},"outcome":{"$ref":"#/components/schemas/RenewalOutcome"},"amountMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}]},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"message":{"type":["string","null"]},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","periodEnd","attempt","outcome","amountMinor","currency","orderId","orderNumber","message","at"],"additionalProperties":false},"RenewalOutcome":{"type":"string","enum":["pending","succeeded","declined","expired_card","authentication_required","error","no_stock","refunded","fallback"]},"ReorderCollectionsResponse":{"type":"object","properties":{"collections":{"type":"array","items":{"$ref":"#/components/schemas/StoreCollection"}}},"required":["collections"],"additionalProperties":false},"ReorderFraudRulesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FraudRule"}}},"required":["items"],"additionalProperties":false},"ReorderOfferRulesResponse":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/OfferRule"}}},"required":["rules"],"additionalProperties":false},"ReplacementApproval":{"type":"string","enum":["auto","review"]},"ReplacementBlock":{"type":"string","enum":["off","not_delivered","refunded","held","chargeback","revoked","window","limit","pending"]},"ReplacementFile":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketAttachmentId"},"filename":{"type":"string"},"url":{"type":"string"},"isImage":{"type":"boolean"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","filename","url","isImage","bytes"],"additionalProperties":false},"ReplacementPolicy":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"windowDays":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"maxReplacements":{"default":1,"type":"integer","minimum":1,"maximum":20},"requireReason":{"default":true,"type":"boolean"},"requireProofText":{"default":false,"type":"boolean"},"requireProofUpload":{"default":false,"type":"boolean"},"approval":{"default":"review","$ref":"#/components/schemas/ReplacementApproval"}},"required":["enabled","windowDays","maxReplacements","requireReason","requireProofText","requireProofUpload","approval"],"additionalProperties":false},"ReplacementQueue":{"type":"object","properties":{"counts":{"type":"object","properties":{"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["pending","approved","rejected","all"],"additionalProperties":false},"requests":{"type":"array","items":{"$ref":"#/components/schemas/ReplacementRow"}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"approval":{"$ref":"#/components/schemas/ReplacementApproval"}},"required":["id","name","approval"],"additionalProperties":false}}},"required":["counts","requests","products"],"additionalProperties":false},"ReplacementReason":{"type":"string","enum":["not_working","already_used","banned","wrong_region","other"]},"ReplacementRequestId":{"type":"string","pattern":"^krq_[0-9a-hjkmnp-tv-z]{20}$"},"ReplacementRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ReplacementRequestId"},"status":{"$ref":"#/components/schemas/ReplacementStatus"},"auto":{"type":"boolean"},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"variantName":{"type":["string","null"]},"buyerEmail":{"type":"string"},"oldKeyId":{"$ref":"#/components/schemas/LicenseKeyId"},"oldKeyMasked":{"type":"string"},"newKeyId":{"anyOf":[{"$ref":"#/components/schemas/LicenseKeyId"},{"type":"null"}]},"newKeyMasked":{"type":["string","null"]},"reason":{"anyOf":[{"$ref":"#/components/schemas/ReplacementReason"},{"type":"null"}]},"details":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/ReplacementFile"}},"disputeId":{"anyOf":[{"$ref":"#/components/schemas/DisputeId"},{"type":"null"}]},"poolAvailable":{"type":"integer","minimum":0,"maximum":9007199254740991},"used":{"type":"integer","minimum":0,"maximum":9007199254740991},"max":{"type":"integer","minimum":1,"maximum":9007199254740991},"windowEndsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"decidedBy":{"type":["string","null"]},"note":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","status","auto","orderId","orderNumber","productId","productName","variantName","buyerEmail","oldKeyId","oldKeyMasked","newKeyId","newKeyMasked","reason","details","files","disputeId","poolAvailable","used","max","windowEndsAt","decidedBy","note","createdAt","decidedAt"],"additionalProperties":false},"ReplacementStatus":{"type":"string","enum":["pending","approved","rejected","cancelled"]},"ReplayAccess":{"type":"object","properties":{"allowed":{"type":"boolean"},"needsCode":{"type":"boolean"},"unlockedUntil":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["allowed","needsCode","unlockedUntil"],"additionalProperties":false},"ReplayChunk":{"type":"object","properties":{"seq":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"data":{"type":"string"}},"required":["seq","data"],"additionalProperties":false},"ReplayChunkMeta":{"type":"object","properties":{"seq":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"events":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"firstAt":{"$ref":"#/components/schemas/Timestamp"},"lastAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["seq","bytes","events","firstAt","lastAt"],"additionalProperties":false},"ReplayManifest":{"type":"object","properties":{"session":{"$ref":"#/components/schemas/ActivitySession"},"user":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"}},"required":["id","name","email"],"additionalProperties":false},"chunks":{"type":"array","items":{"$ref":"#/components/schemas/ReplayChunkMeta"}},"pages":{"type":"array","items":{"$ref":"#/components/schemas/ActivityStep"}},"clicks":{"type":"array","items":{"type":"object","properties":{"at":{"$ref":"#/components/schemas/Timestamp"},"route":{"$ref":"#/components/schemas/DashboardRoute"},"selector":{"$ref":"#/components/schemas/ElementSelector"}},"required":["at","route","selector"],"additionalProperties":false}},"access":{"$ref":"#/components/schemas/ReplayAccess"}},"required":["session","user","chunks","pages","clicks","access"],"additionalProperties":false},"ReportCadence":{"type":"string","enum":["daily","weekly","monthly"]},"ReportKind":{"type":"string","enum":["overview","traffic","pages","geography","bots","ads","funnel","financial"]},"ReportResult":{"type":"object","properties":{"id":{"type":"string"},"dimension":{"anyOf":[{"$ref":"#/components/schemas/SessionDimension"},{"type":"null"}]},"pivot":{"anyOf":[{"$ref":"#/components/schemas/SessionDimension"},{"type":"null"}]},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/Metric"}},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ReportRow"}},"rowCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sort":{"$ref":"#/components/schemas/ReportSort"},"sortDir":{"$ref":"#/components/schemas/SortDirection"},"search":{"type":["string","null"]},"totals":{"type":"array","items":{"type":"number"}},"previousTotals":{"anyOf":[{"type":"array","items":{"type":"number"}},{"type":"null"}]},"series":{"anyOf":[{"$ref":"#/components/schemas/ReportSeries"},{"type":"null"}]},"source":{"type":"string","enum":["rollup","sessions"]}},"required":["id","dimension","pivot","metrics","rows","rowCount","sort","sortDir","search","totals","previousTotals","series","source"],"additionalProperties":false},"ReportRow":{"type":"object","properties":{"key":{"type":"string"},"pivot":{"type":["string","null"]},"values":{"type":"array","items":{"type":"number"}},"previous":{"anyOf":[{"type":"array","items":{"type":"number"}},{"type":"null"}]}},"required":["key","pivot","values","previous"],"additionalProperties":false},"ReportSeries":{"type":"object","properties":{"buckets":{"type":"array","items":{"$ref":"#/components/schemas/BucketKey"}},"values":{"type":"array","items":{"type":"array","items":{"type":"number"}}},"previous":{"anyOf":[{"type":"array","items":{"type":"array","items":{"type":"number"}}},{"type":"null"}]}},"required":["buckets","values","previous"],"additionalProperties":false},"ReportShare":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ReportShareId"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/ReportKind"},"funnelId":{"anyOf":[{"$ref":"#/components/schemas/FunnelId"},{"type":"null"}]},"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"anyOf":[{"$ref":"#/components/schemas/IsoDate"},{"type":"null"}]},"to":{"anyOf":[{"$ref":"#/components/schemas/IsoDate"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"revokedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastViewedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"url":{"type":"string"}},"required":["id","name","kind","funnelId","range","from","to","createdAt","expiresAt","revokedAt","views","lastViewedAt","url"],"additionalProperties":false},"ReportShareId":{"type":"string","pattern":"^shr_[0-9a-hjkmnp-tv-z]{20}$"},"ReportSort":{"type":"string","enum":["visitors","sessions","new_visitors","pageviews","bounce_rate","avg_duration","pages_per_session","engaged_sessions","cart_adds","checkouts","conversions","conversion_rate","orders","revenue","revenue_per_visitor","aov","dimension"]},"RescueAllowance":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":9007199254740991},"used":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["limit","used","nextAt"],"additionalProperties":false},"RescueApiPullResult":{"type":"object","properties":{"import":{"$ref":"#/components/schemas/RescueImport"},"simulated":{"type":"boolean"},"pulled":{"type":"array","items":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/RescueEntity"},"rows":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["entity","rows"],"additionalProperties":false}},"notes":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","maxLength":300}}},"required":["import","simulated","pulled","notes"],"additionalProperties":false},"RescueChange":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/RescueEntity"},"action":{"type":"string","enum":["create","skip","attach"]},"title":{"type":"string"},"detail":{"type":"string"}},"required":["entity","action","title","detail"],"additionalProperties":false},"RescueDryRun":{"type":"object","properties":{"counts":{"type":"array","items":{"$ref":"#/components/schemas/RescueEntityCount"}},"changes":{"type":"array","items":{"$ref":"#/components/schemas/RescueChange"}},"moreChanges":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"$ref":"#/components/schemas/RescueIssue"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/RescueIssue"}},"ranAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["counts","changes","moreChanges","errors","warnings","ranAt"],"additionalProperties":false},"RescueEntity":{"type":"string","enum":["products","keys","customers","coupons","orders","discord_roles","store","pages","categories","reviews","blocklist","affiliates","checkout_fields","deals"]},"RescueEntityCount":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/RescueEntity"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"create":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skip":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"merged":{"default":0,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["entity","total","create","skip","merged","invalid"],"additionalProperties":false},"RescueFile":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RescueFileId"},"fileName":{"type":"string"},"source":{"type":"string","enum":["file","api"]},"format":{"type":"string","enum":["csv","json"]},"entity":{"anyOf":[{"$ref":"#/components/schemas/RescueEntity"},{"type":"null"}]},"columns":{"type":"array","items":{"type":"string"}},"mapping":{"$ref":"#/components/schemas/RescueMapping"},"rowCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sampleRows":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","fileName","source","format","entity","columns","mapping","rowCount","sampleRows","createdAt"],"additionalProperties":false},"RescueFileId":{"type":"string","pattern":"^rsf_[0-9a-hjkmnp-tv-z]{20}$"},"RescueImport":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RescueImportId"},"platform":{"$ref":"#/components/schemas/RescuePlatform"},"status":{"$ref":"#/components/schemas/RescueStatus"},"options":{"$ref":"#/components/schemas/RescueOptions"},"files":{"type":"array","items":{"$ref":"#/components/schemas/RescueFile"}},"dryRun":{"anyOf":[{"$ref":"#/components/schemas/RescueDryRun"},{"type":"null"}]},"progress":{"type":"array","items":{"$ref":"#/components/schemas/RescueProgress"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/RescueIssue"}},"rollbackNotes":{"type":"array","items":{"type":"string"}},"queueAhead":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"createdBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"startedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"rolledBackAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","platform","status","options","files","dryRun","progress","errors","rollbackNotes","queueAhead","createdBy","createdAt","startedAt","finishedAt","rolledBackAt"],"additionalProperties":false},"RescueImportId":{"type":"string","pattern":"^rsc_[0-9a-hjkmnp-tv-z]{20}$"},"RescueImportSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RescueImportId"},"platform":{"$ref":"#/components/schemas/RescuePlatform"},"status":{"$ref":"#/components/schemas/RescueStatus"},"createdBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"rolledBackAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"progress":{"type":"array","items":{"$ref":"#/components/schemas/RescueProgress"}}},"required":["id","platform","status","createdBy","createdAt","finishedAt","rolledBackAt","progress"],"additionalProperties":false},"RescueIssue":{"type":"object","properties":{"file":{"type":["string","null"]},"row":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"field":{"type":["string","null"]},"message":{"type":"string"}},"required":["file","row","field","message"],"additionalProperties":false},"RescueMapping":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"RescueOptions":{"type":"object","properties":{"mergeDurations":{"default":true,"type":"boolean"},"productsAsDrafts":{"default":false,"type":"boolean"},"importOrders":{"default":true,"type":"boolean"}},"required":["mergeDurations","productsAsDrafts","importOrders"],"additionalProperties":false},"RescuePlatform":{"type":"string","enum":["sellix","billgang","sellauth","shoppy","sellhub","myvouches"]},"RescueProgress":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/RescueEntity"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"done":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undone":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["entity","total","done","created","skipped","failed","undone"],"additionalProperties":false},"RescueStatus":{"type":"string","enum":["draft","ready","queued","running","completed","failed","rolling_back","rolled_back"]},"ResellCounts":{"type":"object","properties":{"received":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"awaitingYou":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["received","sent","awaitingYou"],"additionalProperties":false},"ResellDiscountBps":{"type":"integer","minimum":100,"maximum":10000},"ResellListing":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellListingId"},"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"live":{"type":"boolean"}},"required":["id","productId","name","priceMinor","live"],"additionalProperties":false},"ResellListingId":{"type":"string","pattern":"^rpl_[0-9a-hjkmnp-tv-z]{20}$"},"ResellPartnership":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellPartnershipId"},"side":{"$ref":"#/components/schemas/ResellSide"},"status":{"$ref":"#/components/schemas/ResellPartnershipStatus"},"partner":{"$ref":"#/components/schemas/ResellStore"},"discountBps":{"$ref":"#/components/schemas/ResellDiscountBps"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"message":{"type":"string"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ResellPartnershipProduct"}},"unitsSupplied":{"type":"integer","minimum":0,"maximum":9007199254740991},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"owedMinor":{"$ref":"#/components/schemas/MinorUnits"},"settlement":{"$ref":"#/components/schemas/ResellSettlement"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"decidedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"endedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"endedBy":{"anyOf":[{"$ref":"#/components/schemas/ResellParty"},{"type":"null"}]}},"required":["id","side","status","partner","discountBps","currency","message","products","unitsSupplied","paidMinor","owedMinor","settlement","createdAt","decidedAt","endedAt","endedBy"],"additionalProperties":false},"ResellPartnershipId":{"type":"string","pattern":"^rsp_[0-9a-hjkmnp-tv-z]{20}$"},"ResellPartnershipProduct":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"listPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"available":{"type":"integer","minimum":0,"maximum":9007199254740991},"wholesalePriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"unitsSupplied":{"type":"integer","minimum":0,"maximum":9007199254740991},"listing":{"anyOf":[{"$ref":"#/components/schemas/ResellListing"},{"type":"null"}]}},"required":["id","name","type","listPriceMinor","available","wholesalePriceMinor","unitsSupplied","listing"],"additionalProperties":false},"ResellPartnershipStatus":{"type":"string","enum":["pending","accepted","rejected","cancelled","ended"]},"ResellParty":{"type":"string","enum":["supplier","reseller"]},"ResellSettlement":{"type":"string","enum":["ledger","books"]},"ResellSide":{"type":"string","enum":["received","sent"]},"ResellStore":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"type":"string"}},"required":["id","name","handle"],"additionalProperties":false},"ResellableProduct":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"listPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"available":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","type","listPriceMinor","available"],"additionalProperties":false},"ResellerApiCall":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerApiCallId"},"keyHint":{"type":"string"},"method":{"type":"string"},"route":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ip":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","keyHint","method","route","status","ip","createdAt"],"additionalProperties":false},"ResellerApiCallId":{"type":"string","pattern":"^ral_[0-9a-hjkmnp-tv-z]{20}$"},"ResellerApiKey":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerApiKeyId"},"name":{"type":"string"},"hint":{"type":"string"},"scopes":{"type":"array","items":{"$ref":"#/components/schemas/ResellerApiScope"}},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastUsedIp":{"type":["string","null"]},"revokedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","name","hint","scopes","createdAt","lastUsedAt","lastUsedIp","revokedAt"],"additionalProperties":false},"ResellerApiKeyId":{"type":"string","pattern":"^rak_[0-9a-hjkmnp-tv-z]{20}$"},"ResellerApiOverview":{"type":"object","properties":{"keys":{"type":"array","items":{"$ref":"#/components/schemas/ResellerApiKey"}},"webhook":{"anyOf":[{"$ref":"#/components/schemas/ResellerWebhook"},{"type":"null"}]},"calls":{"type":"array","items":{"$ref":"#/components/schemas/ResellerApiCall"}},"deliveries":{"type":"array","items":{"$ref":"#/components/schemas/ResellerWebhookDelivery"}},"calls24h":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["keys","webhook","calls","deliveries","calls24h"],"additionalProperties":false},"ResellerApiScope":{"type":"string","enum":["catalog:read","orders:read","orders:write","keys:read","webhooks:write"]},"ResellerApplyResponse":{"type":"object","properties":{"status":{"type":"string","enum":["pending","approved"]}},"required":["status"],"additionalProperties":false},"ResellerCounts":{"type":"object","properties":{"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"suspended":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["approved","pending","suspended","rejected","all"],"additionalProperties":false},"ResellerId":{"type":"string","pattern":"^rsl_[0-9a-hjkmnp-tv-z]{20}$"},"ResellerOrder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerOrderId"},"resellerId":{"$ref":"#/components/schemas/ResellerId"},"resellerName":{"type":"string"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991},"unitPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"listUnitPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/ResellerOrderStatus"},"payUrl":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"keysDelivered":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","resellerId","resellerName","productId","productName","quantity","unitPriceMinor","listUnitPriceMinor","totalMinor","currency","status","payUrl","orderId","orderNumber","keysDelivered","createdAt"],"additionalProperties":false},"ResellerOrderId":{"type":"string","pattern":"^rso_[0-9a-hjkmnp-tv-z]{20}$"},"ResellerOrderStatus":{"type":"string","enum":["awaiting_payment","paid","fulfilled","cancelled"]},"ResellerRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"company":{"type":"string"},"website":{"type":"string"},"message":{"type":"string"},"status":{"$ref":"#/components/schemas/ResellerStatus"},"tierId":{"anyOf":[{"$ref":"#/components/schemas/ResellerTierId"},{"type":"null"}]},"tierName":{"type":["string","null"]},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"units":{"type":"integer","minimum":0,"maximum":9007199254740991},"spentMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"approvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","name","email","company","website","message","status","tierId","tierName","orders","units","spentMinor","currency","createdAt","approvedAt"],"additionalProperties":false},"ResellerSettings":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"pitch":{"default":"Buy license keys in bulk at wholesale prices and resell them to your own customers.","type":"string","maxLength":2000}},"required":["enabled","pitch"],"additionalProperties":false},"ResellerStatus":{"type":"string","enum":["pending","approved","rejected","suspended"]},"ResellerTier":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerTierId"},"name":{"type":"string","minLength":1,"maxLength":40},"discountBps":{"type":"integer","minimum":100,"maximum":9000},"minQuantity":{"type":"integer","minimum":1,"maximum":10000},"resellers":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","name","discountBps","minQuantity","resellers"],"additionalProperties":false},"ResellerTierId":{"type":"string","pattern":"^rtr_[0-9a-hjkmnp-tv-z]{20}$"},"ResellerWebhook":{"type":"object","properties":{"url":{"type":"string"},"enabled":{"type":"boolean"},"secretHint":{"type":"string"},"events":{"type":"array","items":{"$ref":"#/components/schemas/ResellerWebhookEvent"}},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["url","enabled","secretHint","events","updatedAt"],"additionalProperties":false},"ResellerWebhookDelivery":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerWebhookDeliveryId"},"event":{"anyOf":[{"$ref":"#/components/schemas/ResellerWebhookEvent"},{"type":"string","const":"ping"}]},"status":{"type":"string","enum":["pending","delivered","failed"]},"attempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"responseStatus":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","event","status","attempts","responseStatus","createdAt"],"additionalProperties":false},"ResellerWebhookDeliveryId":{"type":"string","pattern":"^rwd_[0-9a-hjkmnp-tv-z]{20}$"},"ResellerWebhookEvent":{"type":"string","enum":["wholesale_order.created","wholesale_order.paid","wholesale_order.fulfilled","wholesale_order.cancelled"]},"ResellerWebhookSaved":{"type":"object","properties":{"webhook":{"$ref":"#/components/schemas/ResellerWebhook"},"secret":{"type":["string","null"]}},"required":["webhook","secret"],"additionalProperties":false},"ResendDeliveryResult":{"type":"object","properties":{"sentTo":{"type":"string"},"emails":{"type":"array","items":{"type":"string","enum":["receipt","license_key","download_ready"]}},"keys":{"type":"integer","minimum":0,"maximum":9007199254740991},"downloads":{"type":"integer","minimum":0,"maximum":9007199254740991},"remaining":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sentTo","emails","keys","downloads","remaining"],"additionalProperties":false},"ResendEmailVerificationResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true}},"required":["ok"],"additionalProperties":false},"ResendInviteResponse":{"type":"object","properties":{"invite":{"$ref":"#/components/schemas/TeamInvite"},"acceptUrl":{"type":"string"}},"required":["invite","acceptUrl"],"additionalProperties":false},"ResendWebhookEventResponse":{"type":"object","properties":{"deliveries":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["deliveries"],"additionalProperties":false},"ResetPasswordResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"challenge":{"type":["string","null"]}},"required":["user","challenge"],"additionalProperties":false},"RestoreThemeVersionResponse":{"type":"object","properties":{"draft":{"$ref":"#/components/schemas/ThemeDraft"},"version":{"anyOf":[{"$ref":"#/components/schemas/ThemeVersionSummary"},{"type":"null"}]}},"required":["draft","version"],"additionalProperties":false},"RetryDays":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"integer","minimum":1,"maximum":30}},"RevealLicenseKeyResponse":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false},"RevealWebhookSecretResponse":{"type":"object","properties":{"secret":{"type":"string","pattern":"^whsec_[A-Za-z0-9+/=]{32,}$"}},"required":["secret"],"additionalProperties":false},"ReviewCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"needsReply":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lowRatings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"flagged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hidden":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","pending","needsReply","lowRatings","flagged","hidden"],"additionalProperties":false},"ReviewForm":{"type":"object","properties":{"storeName":{"type":"string"},"orderNumber":{"type":"string"},"buyerName":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"review":{"anyOf":[{"type":"object","properties":{"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string"},"body":{"type":"string"},"status":{"$ref":"#/components/schemas/ReviewStatus"}},"required":["rating","title","body","status"],"additionalProperties":false},{"type":"null"}]}},"required":["position","productId","name","type","review"],"additionalProperties":false}}},"required":["storeName","orderNumber","buyerName","items"],"additionalProperties":false},"ReviewId":{"type":"string","pattern":"^rev_[0-9a-hjkmnp-tv-z]{20}$"},"ReviewModeration":{"type":"string","enum":["auto_publish","manual"]},"ReviewReward":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"type":{"default":"percent","$ref":"#/components/schemas/ReviewRewardType"},"value":{"default":1000,"type":"integer","minimum":1,"maximum":10000000},"minRating":{"default":4,"type":"integer","minimum":1,"maximum":5},"expiryDays":{"default":30,"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["enabled","type","value","minRating","expiryDays"],"additionalProperties":false},"ReviewRewardType":{"type":"string","enum":["percent","fixed"]},"ReviewSettings":{"type":"object","properties":{"autoRequest":{"default":true,"type":"boolean"},"requestDelayDays":{"default":3,"type":"integer","minimum":0,"maximum":60},"moderation":{"default":"auto_publish","$ref":"#/components/schemas/ReviewModeration"},"autoPublishMinRating":{"default":4,"type":"integer","minimum":1,"maximum":5},"reward":{"$ref":"#/components/schemas/ReviewReward"}},"required":["autoRequest","requestDelayDays","moderation","autoPublishMinRating","reward"],"additionalProperties":false},"ReviewStatus":{"type":"string","enum":["pending","approved","hidden"]},"ReviewsCarouselSettings":{"type":"object","properties":{"heading":{"default":"What buyers say","type":"string","maxLength":80},"minRating":{"default":4,"type":"integer","minimum":1,"maximum":5},"pages":{"default":"home","type":"string","enum":["home","home_and_products","all"]},"autoplaySeconds":{"default":6,"type":"integer","minimum":0,"maximum":30}},"required":["heading","minRating","pages","autoplaySeconds"],"additionalProperties":false},"RevokeCommunityVerifiedResponse":{"type":"object","properties":{"revoked":{"type":"boolean"}},"required":["revoked"],"additionalProperties":false},"RoleId":{"type":"string","pattern":"^role_[0-9a-hjkmnp-tv-z]{20}$"},"RoleKey":{"anyOf":[{"type":"string","enum":["admin","staff","support","finance"]},{"$ref":"#/components/schemas/RoleId"}]},"RotateOAuthSecretResponse":{"type":"object","properties":{"app":{"$ref":"#/components/schemas/OAuthApp"},"clientSecret":{"type":"string","pattern":"^sfcs_[A-Za-z0-9_-]{43}$"}},"required":["app","clientSecret"],"additionalProperties":false},"RotateWebhookSecretResponse":{"type":"object","properties":{"endpoint":{"$ref":"#/components/schemas/WebhookEndpoint"},"secret":{"type":"string","pattern":"^whsec_[A-Za-z0-9+/=]{32,}$"}},"required":["endpoint","secret"],"additionalProperties":false},"RuleAction":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"allow"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"block"},"message":{"default":null,"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}},"required":["type","message"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"review"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"require_email_verification"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"require_3ds"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"limit_quantity"},"max":{"type":"integer","minimum":1,"maximum":10000}},"required":["type","max"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"flag"},"label":{"type":"string","minLength":1,"maxLength":40}},"required":["type","label"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"score"},"points":{"type":"integer","minimum":-100,"maximum":100}},"required":["type","points"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"restrict_methods"}},"required":["type"],"additionalProperties":false}]},"RuleCondition":{"type":"object","properties":{"signal":{"$ref":"#/components/schemas/SignalKey"},"op":{"$ref":"#/components/schemas/ConditionOperator"},"value":{"default":null,"$ref":"#/components/schemas/ConditionValue"},"value2":{"default":null,"type":["number","null"]}},"required":["signal","op","value","value2"],"additionalProperties":false},"RuleMode":{"type":"string","enum":["live","shadow"]},"RuleStage":{"type":"string","enum":["checkout","payment"]},"RuleTrace":{"type":"object","properties":{"ruleId":{"type":"string"},"name":{"type":"string"},"mode":{"$ref":"#/components/schemas/RuleMode"},"matched":{"type":"boolean"},"applied":{"type":"boolean"},"skipped":{"anyOf":[{"type":"string","enum":["disabled","stage","stopped","decided"]},{"type":"null"}]},"actions":{"type":"array","items":{"$ref":"#/components/schemas/RuleAction"}},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/ConditionTrace"}}},"required":["ruleId","name","mode","matched","applied","skipped","actions","conditions"],"additionalProperties":false},"SalesAnalytics":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totals":{"type":"object","properties":{"grossMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"discountsMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"netMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"taxMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"feesMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"sellerNetMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"orders":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"unitsSold":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"averageOrderMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"refundsMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"refunds":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"disputesMinor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"disputes":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false}},"required":["grossMinor","discountsMinor","netMinor","taxMinor","feesMinor","sellerNetMinor","orders","unitsSold","averageOrderMinor","refundsMinor","refunds","disputesMinor","disputes"],"additionalProperties":false},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"hour":{"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"units":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"grossMinor":{"$ref":"#/components/schemas/MinorUnits"},"netMinor":{"$ref":"#/components/schemas/MinorUnits"},"refundsMinor":{"$ref":"#/components/schemas/MinorUnits"},"feesMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["date","hour","orders","units","grossMinor","netMinor","refundsMinor","feesMinor"],"additionalProperties":false}},"byStatus":{"type":"array","items":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/OrderStatus"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["status","orders","totalMinor"],"additionalProperties":false}},"byMethod":{"type":"array","items":{"type":"object","properties":{"method":{"$ref":"#/components/schemas/PaymentMethod"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["method","orders","netMinor"],"additionalProperties":false}},"byHour":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["hour","orders"],"additionalProperties":false}}},"required":["range","from","to","period","currency","totals","daily","byStatus","byMethod","byHour"],"additionalProperties":false},"SalesPause":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SalesPauseId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"labelName":{"type":"string"},"labelColor":{"type":"string"},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"endedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"compensatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"compensatedKeys":{"type":"integer","minimum":0,"maximum":9007199254740991},"compensatedSeconds":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","productId","productName","labelName","labelColor","startedAt","endedAt","compensatedAt","compensatedKeys","compensatedSeconds"],"additionalProperties":false},"SalesPauseId":{"type":"string","pattern":"^spz_[0-9a-hjkmnp-tv-z]{20}$"},"SandboxFailResponse":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"kind":{"$ref":"#/components/schemas/PaymentFailureKind"}},"required":["sessionId","kind"],"additionalProperties":false},"SandboxPayResponse":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"orderId":{"$ref":"#/components/schemas/OrderId"}},"required":["sessionId","orderId"],"additionalProperties":false},"SaveCryptoSettingsResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/CryptoSettings"},"wallets":{"$ref":"#/components/schemas/CryptoWalletStatus"},"live":{"type":"array","items":{"$ref":"#/components/schemas/CryptoRail"}},"platformEnabled":{"type":"boolean"},"paymentModel":{"type":"string","enum":["merchant_of_record","seller_gateway"]},"chainSource":{"type":"string","enum":["live","simulated"]},"commissionBps":{"type":"integer","minimum":0,"maximum":9007199254740991},"switchedToOwn":{"default":false,"type":"boolean"}},"required":["settings","wallets","live","platformEnabled","paymentModel","chainSource","commissionBps","switchedToOwn"],"additionalProperties":false},"SaveEmailDocumentResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["ok","updatedAt"],"additionalProperties":false},"SavePluginFixturesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PluginFixture"}}},"required":["items"],"additionalProperties":false},"SaveTemplateReleaseDetailsResponse":{"type":"object","properties":{"release":{"$ref":"#/components/schemas/TemplateReleaseSummary"},"listing":{"$ref":"#/components/schemas/TemplateListing"}},"required":["release","listing"],"additionalProperties":false},"SaveTemplateReleaseFilesResponse":{"type":"object","properties":{"release":{"$ref":"#/components/schemas/TemplateReleaseSummary"},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}}},"required":["release","issues"],"additionalProperties":false},"SavedFunnel":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/FunnelId"},"name":{"type":"string"},"description":{"type":"string"},"templateId":{"type":["string","null"]},"definition":{"$ref":"#/components/schemas/FunnelDefinition"},"pinned":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","description","templateId","definition","pinned","createdAt","updatedAt"],"additionalProperties":false},"SavedMethodKind":{"type":"string","enum":["card","paypal"]},"SavedPaymentMethod":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SavedPaymentMethodId"},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"kind":{"$ref":"#/components/schemas/SavedMethodKind"},"brand":{"type":"string","maxLength":30},"last4":{"anyOf":[{"type":"string","pattern":"^\\d{4}$"},{"type":"null"}]},"expMonth":{"anyOf":[{"type":"integer","minimum":1,"maximum":12},{"type":"null"}]},"expYear":{"anyOf":[{"type":"integer","minimum":2000,"maximum":2200},{"type":"null"}]},"label":{"type":"string","maxLength":120},"expired":{"type":"boolean"}},"required":["id","provider","kind","brand","last4","expMonth","expYear","label","expired"],"additionalProperties":false},"SavedPaymentMethodId":{"type":"string","pattern":"^spm_[0-9a-hjkmnp-tv-z]{20}$"},"SavedTemplate":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SavedTemplateId"},"name":{"type":"string"},"description":{"type":"string"},"doc":{"$ref":"#/components/schemas/EmailDocument"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","description","doc","updatedAt"],"additionalProperties":false},"SavedTemplateId":{"type":"string","pattern":"^etpl_[0-9a-hjkmnp-tv-z]{20}$"},"ScamNoticeSettings":{"type":"object","properties":{"title":{"default":"Stay safe from scams","type":"string","minLength":1,"maxLength":60},"message":{"default":"We never message you first on Discord or Telegram, and we never ask for your password or a payment outside this site. Buy only here.","type":"string","minLength":1,"maxLength":300},"links":{"default":[],"maxItems":5,"type":"array","items":{"type":"object","properties":{"a":{"type":"string","minLength":1,"maxLength":40},"b":{"type":"string","maxLength":500}},"required":["a","b"],"additionalProperties":false}},"placement":{"default":"footer","type":"string","enum":["footer","product_and_footer"]}},"required":["title","message","links","placement"],"additionalProperties":false},"ScheduleName":{"type":"string","enum":["payouts","expire_checkouts","requeue_deliveries","prune_data","upload_gc","analytics_rollup","analytics_partitions","analytics_alerts","analytics_reports","trust_maintenance","comms_dispatch","comms_maintenance","licensing","usp_discord","push_cleanup","crypto_watch","h4_community","prune_errors","own_gateway_fees","plan_comps","payment_models","description_html","read_models","ai_welcome_grants","ai_data_retention","shopfast_community","activity_retention","stripe_methods","pay_limits","invoices","referral_rewards","plan_limits"]},"ScheduledPlanChange":{"type":"object","properties":{"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"kind":{"type":"string","enum":["downgrade","cancel","after_trial"]},"at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"monthlyPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"type":"string"},"willHappen":{"type":"boolean"}},"required":["planId","planName","kind","at","monthlyPriceMinor","currency","willHappen"],"additionalProperties":false},"ScheduledReport":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"kind":{"$ref":"#/components/schemas/ReportKind"},"funnelId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/FunnelId"},{"type":"null"}]},"cadence":{"$ref":"#/components/schemas/ReportCadence"},"weekday":{"default":1,"type":"integer","minimum":0,"maximum":6},"hour":{"default":8,"type":"integer","minimum":0,"maximum":23},"recipients":{"minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Email"}},"format":{"default":"summary","type":"string","enum":["summary","csv"]},"enabled":{"default":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/ScheduledReportId"},"lastSentAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"nextAt":{"$ref":"#/components/schemas/Timestamp"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","kind","funnelId","cadence","weekday","hour","recipients","format","enabled","id","lastSentAt","nextAt","createdAt"],"additionalProperties":false},"ScheduledReportId":{"type":"string","pattern":"^srp_[0-9a-hjkmnp-tv-z]{20}$"},"SearchAnalytics":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/SearchAnalyticsRange"},"from":{"type":"string"},"to":{"type":"string"},"totals":{"type":"object","properties":{"searches":{"type":"integer","minimum":0,"maximum":9007199254740991},"searchers":{"type":"integer","minimum":0,"maximum":9007199254740991},"zeroResults":{"type":"integer","minimum":0,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991},"ctr":{"type":"number","minimum":0,"maximum":1},"purchases":{"type":"integer","minimum":0,"maximum":9007199254740991},"conversion":{"type":"number","minimum":0,"maximum":1}},"required":["searches","searchers","zeroResults","clicks","ctr","purchases","conversion"],"additionalProperties":false},"series":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"searches":{"type":"integer","minimum":0,"maximum":9007199254740991},"zeroResults":{"type":"integer","minimum":0,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["day","searches","zeroResults","clicks"],"additionalProperties":false}},"topTerms":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/SearchTermRow"}},"zeroTerms":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"query":{"type":"string"},"searches":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastAt":{"$ref":"#/components/schemas/Timestamp"},"suggestion":{"type":["string","null"]}},"required":["query","searches","lastAt","suggestion"],"additionalProperties":false}},"topClicked":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"handle":{"type":"string"},"title":{"type":"string"},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["handle","title","clicks"],"additionalProperties":false}}},"required":["range","from","to","totals","series","topTerms","zeroTerms","topClicked"],"additionalProperties":false},"SearchAnalyticsRange":{"type":"string","enum":["7d","30d","90d"]},"SearchCategoryScope":{"type":"object","properties":{"handle":{"type":"string"},"title":{"type":"string"},"path":{"maxItems":8,"type":"array","items":{"type":"object","properties":{"handle":{"type":"string"},"title":{"type":"string"}},"required":["handle","title"],"additionalProperties":false}}},"required":["handle","title","path"],"additionalProperties":false},"SearchFacetSchema":{"type":"object","properties":{"key":{"type":"string","enum":["category","status","game","platform","duration","type","price","rating","stock"]},"label":{"type":"string"},"kind":{"type":"string","enum":["list","toggle","range"]},"values":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"selected":{"type":"boolean"},"tone":{"anyOf":[{"type":"string","enum":["good","warn","bad"]},{"type":"null"}]},"depth":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"parent":{"default":null,"type":["string","null"]}},"required":["value","label","count","selected","tone","depth","parent"],"additionalProperties":false}}},"required":["key","label","kind","values"],"additionalProperties":false},"SearchFilters":{"type":"object","properties":{"category":{"default":[],"maxItems":10,"type":"array","items":{"type":"string","maxLength":80}},"game":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":80}},"platform":{"default":[],"maxItems":16,"type":"array","items":{"$ref":"#/components/schemas/GamePlatform"}},"type":{"default":[],"maxItems":7,"type":"array","items":{"$ref":"#/components/schemas/ProductType"}},"duration":{"default":[],"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/DurationKey"}},"status":{"default":[],"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/ProductLiveStatus"}},"inStock":{"default":false,"type":"boolean"},"rating":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}]},"priceMin":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"priceMax":{"default":null,"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["category","game","platform","type","duration","status","inStock","rating","priceMin","priceMax"],"additionalProperties":false},"SearchHighlight":{"maxItems":20,"type":"array","items":{"type":"array","prefixItems":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"integer","minimum":0,"maximum":9007199254740991}],"items":false,"minItems":2,"maxItems":2}},"SearchLinkHit":{"type":"object","properties":{"kind":{"type":"string","enum":["collection","page","category"]},"handle":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"highlight":{"$ref":"#/components/schemas/SearchHighlight"},"productCount":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"parents":{"default":[],"maxItems":8,"type":"array","items":{"type":"string"}}},"required":["kind","handle","title","url","highlight","productCount","parents"],"additionalProperties":false},"SearchProductHit":{"type":"object","properties":{"id":{"type":"string"},"handle":{"type":"string"},"title":{"type":"string"},"highlight":{"$ref":"#/components/schemas/SearchHighlight"},"type":{"$ref":"#/components/schemas/ProductType"},"typeLabel":{"type":"string"},"game":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"priceMaxMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"hasDurations":{"type":"boolean"},"available":{"type":"boolean"},"preorder":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"lowStock":{"type":"boolean"},"status":{"anyOf":[{"$ref":"#/components/schemas/ProductLiveStatus"},{"type":"null"}]},"statusLabel":{"type":["string","null"]},"statusTone":{"anyOf":[{"type":"string","enum":["good","warn","bad"]},{"type":"null"}]},"paused":{"type":"boolean"},"rating":{"anyOf":[{"type":"number","minimum":0,"maximum":5},{"type":"null"}]},"ratingCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"score":{"type":"number"}},"required":["id","handle","title","highlight","type","typeLabel","game","imageUrl","priceMinor","priceMaxMinor","compareAtMinor","currency","hasDurations","available","preorder","stock","lowStock","status","statusLabel","statusTone","paused","rating","ratingCount","score"],"additionalProperties":false},"SearchQueryInfo":{"type":"object","properties":{"q":{"type":"string"},"normalized":{"type":"string"},"corrected":{"anyOf":[{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"additionalProperties":false},{"type":"null"}]},"didYouMean":{"type":["string","null"]},"relaxed":{"type":"boolean"},"redirect":{"type":["string","null"]},"terms":{"maxItems":64,"type":"array","items":{"type":"string"}}},"required":["q","normalized","corrected","didYouMean","relaxed","redirect","terms"],"additionalProperties":false},"SearchRule":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SearchRuleId"},"kind":{"$ref":"#/components/schemas/SearchRuleKind"},"query":{"type":"string"},"normalized":{"type":"string"},"productIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"url":{"type":["string","null"]},"enabled":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","query","normalized","productIds","url","enabled","createdAt","updatedAt"],"additionalProperties":false},"SearchRuleId":{"type":"string","pattern":"^srl_[0-9a-hjkmnp-tv-z]{20}$"},"SearchRuleKind":{"type":"string","enum":["pin","redirect"]},"SearchSettings":{"type":"object","properties":{"synonyms":{"type":"array","items":{"$ref":"#/components/schemas/SearchSynonym"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/SearchRule"}},"defaults":{"type":"array","items":{"type":"object","properties":{"terms":{"type":"array","items":{"type":"string"}},"oneWay":{"type":"boolean"}},"required":["terms","oneWay"],"additionalProperties":false}},"index":{"$ref":"#/components/schemas/RebuildSearchIndexResponse"}},"required":["synonyms","rules","defaults","index"],"additionalProperties":false},"SearchSort":{"type":"string","enum":["relevance","best_selling","price_asc","price_desc","newest","rating"]},"SearchState":{"type":"object","properties":{"q":{"type":"string","maxLength":100},"sort":{"anyOf":[{"$ref":"#/components/schemas/SearchSort"},{"type":"null"}]},"filters":{"$ref":"#/components/schemas/SearchFilters"},"page":{"type":"integer","minimum":1,"maximum":500}},"required":["q","sort","filters","page"],"additionalProperties":false},"SearchSynonym":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SearchSynonymId"},"terms":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"string"}},"oneWay":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","terms","oneWay","createdAt","updatedAt"],"additionalProperties":false},"SearchSynonymId":{"type":"string","pattern":"^ssy_[0-9a-hjkmnp-tv-z]{20}$"},"SearchTermRow":{"type":"object","properties":{"query":{"type":"string"},"searches":{"type":"integer","minimum":0,"maximum":9007199254740991},"avgResults":{"type":"number","minimum":0},"clicks":{"type":"integer","minimum":0,"maximum":9007199254740991},"ctr":{"type":"number","minimum":0,"maximum":1},"purchases":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["query","searches","avgResults","clicks","ctr","purchases","lastAt"],"additionalProperties":false},"SectionLibraryEntry":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"layoutType":{"anyOf":[{"$ref":"#/components/schemas/LibraryLayoutType"},{"type":"null"}]},"keywords":{"type":"array","items":{"type":"string"}},"skeletonShape":{"type":["string","null"]},"templates":{"type":"array","items":{"type":"string"}},"groups":{"type":"array","items":{"type":"string"}},"limit":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"sample":{"type":"string","enum":["catalog","none"]},"fromLibrary":{"type":"boolean"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/SectionLibraryVariant"}}},"required":["type","name","description","category","layoutType","keywords","skeletonShape","templates","groups","limit","sample","fromLibrary","variants"],"additionalProperties":false},"SectionLibraryVariant":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"layout":{"anyOf":[{"$ref":"#/components/schemas/LibraryLayoutType"},{"type":"null"}]},"style":{"type":["string","null"]},"keywords":{"type":"array","items":{"type":"string"}},"settings":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}},"blocks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"settings":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}}},"required":["type","settings"],"additionalProperties":false}},"previewTemplate":{"type":"string"}},"required":["id","name","description","layout","style","keywords","settings","blocks","previewTemplate"],"additionalProperties":false},"SecurityOverview":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/FraudSettings"},"blocklist":{"type":"array","items":{"$ref":"#/components/schemas/BlocklistEntry"}},"recentChecks":{"type":"array","items":{"$ref":"#/components/schemas/FraudCheck"}},"stats":{"type":"object","properties":{"checks30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reviewed30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"blocked30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["checks30d","reviewed30d","blocked30d"],"additionalProperties":false}},"required":["settings","blocklist","recentChecks","stats"],"additionalProperties":false},"Segment":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SegmentId"},"name":{"type":"string"},"description":{"type":"string"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/SessionFilter"}},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","description","filters","createdAt","updatedAt"],"additionalProperties":false},"SegmentCondition":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/SegmentField"},"op":{"$ref":"#/components/schemas/SegmentOp"},"value":{"anyOf":[{"type":"number"},{"type":"string","maxLength":80}]},"days":{"type":"integer","minimum":1,"maximum":730},"event":{"type":"string","maxLength":60}},"required":["field","op","value"],"additionalProperties":false},"SegmentField":{"type":"string","enum":["orders_count","total_spent","last_order_days","first_order_days","avg_order","bought_product","not_bought_product","tag","not_tag","country","consent_days","opened_days","clicked_days","event_count","source"]},"SegmentId":{"type":"string","pattern":"^asg_[0-9a-hjkmnp-tv-z]{20}$"},"SegmentOp":{"type":"string","enum":["gt","gte","lt","lte","eq","neq","within","not_within","is","is_not"]},"SegmentRules":{"type":"object","properties":{"match":{"type":"string","enum":["all","any"]},"conditions":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/SegmentCondition"}}},"required":["match","conditions"],"additionalProperties":false},"SellerAccountCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"locked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unconfirmed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"twoFactor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"google":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","locked","unconfirmed","twoFactor","google"],"additionalProperties":false},"SellerAccountDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"emailVerifiedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"twoFactor":{"type":"boolean"},"google":{"type":"boolean"},"hasPassword":{"type":"boolean"},"storesOwned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"storesMember":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mainStore":{"default":null,"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"type":"string"}},"required":["id","name","handle"],"additionalProperties":false},{"type":"null"}]},"lastSeenAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lockedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"passwordChangedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"pendingEmail":{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},"lock":{"anyOf":[{"type":"object","properties":{"at":{"$ref":"#/components/schemas/Timestamp"},"reason":{"type":"string"},"by":{"type":"string"}},"required":["at","reason","by"],"additionalProperties":false},{"type":"null"}]},"totp":{"anyOf":[{"type":"object","properties":{"enabledAt":{"$ref":"#/components/schemas/Timestamp"},"recoveryCodesLeft":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["enabledAt","recoveryCodesLeft"],"additionalProperties":false},{"type":"null"}]},"googleAccount":{"anyOf":[{"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"linkedAt":{"$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["email","linkedAt","lastUsedAt"],"additionalProperties":false},{"type":"null"}]},"sessions":{"type":"object","properties":{"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastSeenAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"devices":{"type":"array","items":{"$ref":"#/components/schemas/SellerAccountDevice"}}},"required":["active","lastSeenAt","devices"],"additionalProperties":false},"apiKeys":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stores":{"type":"array","items":{"$ref":"#/components/schemas/SellerAccountStore"}},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/SellerAccountTicket"}},"notes":{"type":"array","items":{"$ref":"#/components/schemas/StaffNote"}},"audit":{"type":"array","items":{"$ref":"#/components/schemas/AuditEntry"}}},"required":["id","email","name","createdAt","emailVerifiedAt","twoFactor","google","hasPassword","storesOwned","storesMember","mainStore","lastSeenAt","lockedAt","passwordChangedAt","pendingEmail","lock","totp","googleAccount","sessions","apiKeys","stores","tickets","notes","audit"],"additionalProperties":false},"SellerAccountDevice":{"type":"object","properties":{"id":{"type":"string"},"browser":{"type":"string"},"os":{"type":"string"},"ip":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","browser","os","ip","createdAt","lastSeenAt"],"additionalProperties":false},"SellerAccountResult":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/SellerAccountDetail"},"emailed":{"type":"array","items":{"type":"string"}}},"required":["account","emailed"],"additionalProperties":false},"SellerAccountRow":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"emailVerifiedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"twoFactor":{"type":"boolean"},"google":{"type":"boolean"},"hasPassword":{"type":"boolean"},"storesOwned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"storesMember":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mainStore":{"default":null,"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"type":"string"}},"required":["id","name","handle"],"additionalProperties":false},{"type":"null"}]},"lastSeenAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lockedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","email","name","createdAt","emailVerifiedAt","twoFactor","google","hasPassword","storesOwned","storesMember","mainStore","lastSeenAt","lockedAt"],"additionalProperties":false},"SellerAccountStore":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"type":"string"},"role":{"$ref":"#/components/schemas/MemberRoleKind"},"roleName":{"type":"string"},"status":{"type":"string","enum":["active","suspended"]},"joinedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","handle","role","roleName","status","joinedAt"],"additionalProperties":false},"SellerAccountTicket":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DeskTicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastMessageAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","number","subject","status","createdAt","lastMessageAt"],"additionalProperties":false},"SellerAnnouncement":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AnnouncementId"},"title":{"type":"string"},"body":{"type":"string"},"href":{"type":["string","null"]},"publishedAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","title","body","href","publishedAt","expiresAt"],"additionalProperties":false},"SellerAutoRenewList":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/SellerAutoRenewSubscription"}}},"required":["subscriptions"],"additionalProperties":false},"SellerAutoRenewSubscription":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/SubscriptionId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"email":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"orderId":{"$ref":"#/components/schemas/OrderId"},"orderNumber":{"type":"string"},"every":{"type":"string"},"status":{"type":"string","enum":["active","past_due","cancelling","ended"]},"currentPeriodEnd":{"$ref":"#/components/schemas/Timestamp"},"renewals":{"type":"integer","minimum":0,"maximum":9007199254740991},"autoRenew":{"$ref":"#/components/schemas/AutoRenewState"},"nextChargeAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"amountMinor":{"anyOf":[{"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}]},"method":{"anyOf":[{"$ref":"#/components/schemas/SavedPaymentMethod"},{"type":"null"}]},"consentText":{"type":["string","null"]},"consentAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"failedAttempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"charges":{"type":"array","items":{"$ref":"#/components/schemas/RenewalChargeView"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionEventView"}}},"required":["id","productId","productName","email","customerId","orderId","orderNumber","every","status","currentPeriodEnd","renewals","autoRenew","nextChargeAt","amountMinor","currency","method","consentText","consentAt","failedAttempts","charges","events"],"additionalProperties":false},"SellerLink":{"type":"string","maxLength":500,"pattern":"^(?:\\/[^\\s]*|https:\\/\\/[^\\s]+)$"},"SellerPayStatus":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/PayAccessMode"},"state":{"$ref":"#/components/schemas/PayAccessState"},"usable":{"type":"boolean"},"headline":{"type":"string"},"application":{"anyOf":[{"$ref":"#/components/schemas/PayApplication"},{"type":"null"}]},"limits":{"$ref":"#/components/schemas/PayLimits"},"usedMinor":{"$ref":"#/components/schemas/MinorUnits"},"effectiveReserveBps":{"$ref":"#/components/schemas/Bps"},"payoutHold":{"type":"object","properties":{"held":{"type":"boolean"},"reason":{"type":["string","null"]},"since":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["held","reason","since"],"additionalProperties":false},"fallback":{"$ref":"#/components/schemas/PayFallback"},"canApply":{"type":"boolean"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["mode","state","usable","headline","application","limits","usedMinor","effectiveReserveBps","payoutHold","fallback","canApply","currency"],"additionalProperties":false},"SellerPlanComp":{"type":"object","properties":{"planName":{"type":"string"},"endsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["planName","endsAt"],"additionalProperties":false},"SellerPlanVoucher":{"type":"object","properties":{"code":{"type":"string"},"planName":{"type":"string"},"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"freeUntil":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["code","planName","months","freeUntil"],"additionalProperties":false},"SellerReview":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ReviewId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"customerEmail":{"type":["string","null"]},"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string"},"body":{"type":"string"},"author":{"type":"string"},"status":{"$ref":"#/components/schemas/ReviewStatus"},"verified":{"type":"boolean"},"flagged":{"type":"boolean"},"flagReason":{"type":["string","null"]},"reply":{"type":["string","null"]},"repliedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"reward":{"anyOf":[{"$ref":"#/components/schemas/IssuedReviewReward"},{"type":"null"}]},"source":{"default":null,"type":["string","null"]},"sourceLabel":{"default":null,"type":["string","null"]},"imageUrl":{"default":null,"type":["string","null"]}},"required":["id","productId","productName","orderId","orderNumber","customerId","customerEmail","rating","title","body","author","status","verified","flagged","flagReason","reply","repliedAt","createdAt","reward","source","sourceLabel","imageUrl"],"additionalProperties":false},"SellerStoreReview":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreReviewId"},"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string"},"body":{"type":"string"},"author":{"type":"string"},"source":{"type":["string","null"]},"sourceLabel":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"pinned":{"type":"boolean"},"published":{"type":"boolean"},"reply":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"importedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","rating","title","body","author","source","sourceLabel","imageUrl","pinned","published","reply","createdAt","importedAt"],"additionalProperties":false},"SemVer":{"type":"string","pattern":"^(?:0|[1-9]\\d{0,3})\\.(?:0|[1-9]\\d{0,3})\\.(?:0|[1-9]\\d{0,3})$"},"SendReviewRequestResponse":{"type":"object","properties":{"sentTo":{"type":"string"}},"required":["sentTo"],"additionalProperties":false},"SendScheduledReportResponse":{"type":"object","properties":{"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["sent"],"additionalProperties":false},"SendTestEmailResponse":{"type":"object","properties":{"to":{"type":"string"},"subject":{"type":"string"}},"required":["to","subject"],"additionalProperties":false},"SendWindow":{"type":"object","properties":{"enabled":{"type":"boolean"},"startHour":{"type":"integer","minimum":0,"maximum":23},"endHour":{"type":"integer","minimum":1,"maximum":24},"days":{"maxItems":7,"type":"array","items":{"type":"integer","minimum":0,"maximum":6}}},"required":["enabled","startHour","endHour","days"],"additionalProperties":false},"SeoOverview":{"type":"object","properties":{"seo":{"$ref":"#/components/schemas/StoreSeo"},"origin":{"type":"string"},"links":{"type":"object","properties":{"robots":{"type":"string"},"sitemap":{"type":"string"},"googleFeed":{"type":"string"},"metaFeed":{"type":"string"}},"required":["robots","sitemap","googleFeed","metaFeed"],"additionalProperties":false},"fallback":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}},"required":["title","description"],"additionalProperties":false},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["seo","origin","links","fallback","updatedAt"],"additionalProperties":false},"ServiceSettings":{"type":"object","properties":{"instructions":{"type":"string","maxLength":5000},"bookingUrl":{"anyOf":[{"$ref":"#/components/schemas/HttpsUrl"},{"type":"null"}]},"turnaroundDays":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"required":["instructions","bookingUrl","turnaroundDays"],"additionalProperties":false},"SessionDimension":{"type":"string","enum":["channel","source","medium","campaign","term","content","source_medium","referrer","landing","exit","country","region","city","device","browser","os","language","screen","visitor_type","consent","affiliate"]},"SessionFilter":{"type":"object","properties":{"dimension":{"$ref":"#/components/schemas/SessionDimension"},"op":{"$ref":"#/components/schemas/FilterOp"},"values":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","maxLength":200}}},"required":["dimension","op","values"],"additionalProperties":false},"SessionInfo":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{16}$"},"current":{"type":"boolean"},"browser":{"type":"string"},"os":{"type":"string"},"ip":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastSeenAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","current","browser","os","ip","createdAt","lastSeenAt"],"additionalProperties":false},"SetDefaultProductPresetResponse":{"type":"object","properties":{"presets":{"type":"array","items":{"$ref":"#/components/schemas/ProductPreset"}}},"required":["presets"],"additionalProperties":false},"SetGiftCardExpiryResponse":{"type":"object","properties":{"giftCard":{"$ref":"#/components/schemas/GiftCard"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardTransaction"}}},"required":["giftCard","transactions"],"additionalProperties":false},"SetProductTemplateResponse":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"templateSuffix":{"anyOf":[{"$ref":"#/components/schemas/TemplateSuffix"},{"type":"null"}]}},"required":["productId","templateSuffix"],"additionalProperties":false},"SettlementSettings":{"type":"object","properties":{"holdDays":{"type":"integer","minimum":0,"maximum":90},"payoutSchedule":{"type":"string","enum":["daily","weekly","monthly"]},"payoutWeekday":{"type":"integer","minimum":0,"maximum":6},"payoutMinimumMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"reserveBps":{"$ref":"#/components/schemas/Bps"},"reserveDays":{"type":"integer","minimum":0,"maximum":180},"highRiskHoldDays":{"default":14,"type":"integer","minimum":0,"maximum":90},"highRiskScore":{"default":70,"type":"integer","minimum":1,"maximum":100}},"required":["holdDays","payoutSchedule","payoutWeekday","payoutMinimumMinor","reserveBps","reserveDays","highRiskHoldDays","highRiskScore"],"additionalProperties":false},"Sha256Hex":{"type":"string","pattern":"^[0-9a-f]{64}$"},"ShareButtonsSettings":{"type":"object","properties":{"label":{"default":"Share","type":"string","maxLength":30},"networks":{"default":["copy","x","reddit","telegram","whatsapp"],"minItems":1,"maxItems":7,"type":"array","items":{"$ref":"#/components/schemas/ShareNetwork"}}},"required":["label","networks"],"additionalProperties":false},"ShareGiftCardResponse":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":false},"ShareNetwork":{"type":"string","enum":["copy","x","reddit","telegram","whatsapp","facebook","email"]},"Shared0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared0"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared0"}}]},"Shared1":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared1"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared1"}}]},"Shared10":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared10"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared10"}}]},"Shared11":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared11"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared11"}}]},"Shared12":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared12"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared12"}}]},"Shared2":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared2"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared2"}}]},"Shared3":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared3"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared3"}}]},"Shared4":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared4"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared4"}}]},"Shared5":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared5"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared5"}}]},"Shared6":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared6"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared6"}}]},"Shared7":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared7"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared7"}}]},"Shared8":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared8"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared8"}}]},"Shared9":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Shared9"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/Shared9"}}]},"SharedReport":{"type":"object","properties":{"storeName":{"type":"string"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/ReportKind"},"generatedAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"query":{"anyOf":[{"$ref":"#/components/schemas/AnalyticsQueryResult"},{"type":"null"}]},"funnel":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"result":{"$ref":"#/components/schemas/FunnelResult"}},"required":["name","result"],"additionalProperties":false},{"type":"null"}]},"pages":{"anyOf":[{"$ref":"#/components/schemas/PagesReport"},{"type":"null"}]},"bots":{"anyOf":[{"$ref":"#/components/schemas/BotsReport"},{"type":"null"}]},"ads":{"anyOf":[{"$ref":"#/components/schemas/AdsReport"},{"type":"null"}]}},"required":["storeName","name","kind","generatedAt","expiresAt","query","funnel","pages","bots","ads"],"additionalProperties":false},"ShieldReason":{"type":"string","enum":["rule","score","review","new_buyer_cap"]},"ShieldStats":{"type":"object","properties":{"days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"enabled":{"type":"boolean"},"steered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paidIrreversible":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paidMinor":{"$ref":"#/components/schemas/MinorUnits"},"abandoned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"chargebacksAvoided":{"type":"number"},"lossAvoidedMinor":{"$ref":"#/components/schemas/MinorUnits"},"byReason":{"type":"array","items":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/ShieldReason"},"steered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["reason","steered","paid"],"additionalProperties":false}},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"steered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","steered","paid"],"additionalProperties":false}},"card":{"type":"object","properties":{"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"disputes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"ratePct":{"type":"number"}},"required":["orders","disputes","ratePct"],"additionalProperties":false},"crypto":{"type":"object","properties":{"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"sharePct":{"type":"number"}},"required":["orders","amountMinor","sharePct"],"additionalProperties":false},"evidencePrepared":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recent":{"type":"array","items":{"type":"object","properties":{"sessionId":{"anyOf":[{"$ref":"#/components/schemas/CheckoutSessionId"},{"type":"null"}]},"reason":{"$ref":"#/components/schemas/ShieldReason"},"score":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"outcome":{"type":"string","enum":["pending","paid","abandoned"]},"method":{"type":["string","null"]},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["sessionId","reason","score","totalMinor","outcome","method","at"],"additionalProperties":false}}},"required":["days","currency","enabled","steered","paidIrreversible","paidMinor","abandoned","chargebacksAvoided","lossAvoidedMinor","byReason","daily","card","crypto","evidencePrepared","recent"],"additionalProperties":false},"ShopifyAuthorizeUrlResponse":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":false},"SignInMethod":{"type":"string","enum":["password","two_factor","google","reset_link","signup"]},"SignalGroup":{"type":"string","enum":["network","email","velocity","geo","history","account","cart","card","behavior","lists","context"]},"SignalKey":{"type":"string","enum":["ip.address","ip.asn","ip.org","ip.vpn","ip.proxy","ip.tor","ip.datacenter","ip.reputation","ip.known","email.address","email.domain","email.disposable","email.free_provider","email.mx_valid","email.risk","velocity.ip_1h","velocity.ip_24h","velocity.email_1h","velocity.email_24h","velocity.device_24h","velocity.card_24h","velocity.emails_per_device_24h","velocity.emails_per_ip_24h","velocity.cards_per_email_7d","geo.billing_country","geo.ip_country","geo.card_country","geo.country_mismatch","geo.card_country_mismatch","history.paid_orders","history.refunds","history.chargebacks","history.blocked_30d","history.first_order","account.signed_in","account.age_days","customer.age_days","cart.total","cart.lines","cart.units","cart.max_quantity","cart.product_types","cart.total_vs_average","cart.high_value_first_order","card.bin","card.brand","card.funding","card.fingerprint","card.radar_risk","card.three_d_secure","behavior.seen","behavior.seconds_on_site","behavior.page_views","behavior.product_views","behavior.cart_adds","behavior.source","behavior.device","list.allowed","list.blocked","list.platform","device.id","discord.id","context.hour","context.weekday","context.user_agent_bot","context.stage","context.test"]},"SignalSnapshot":{"type":"object","propertyNames":{"$ref":"#/components/schemas/SignalKey"},"additionalProperties":{"$ref":"#/components/schemas/SignalValue"}},"SignalSourceInfo":{"type":"object","properties":{"group":{"$ref":"#/components/schemas/SignalGroup"},"label":{"type":"string"},"source":{"type":"string"}},"required":["group","label","source"],"additionalProperties":false},"SignalValue":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"maxItems":50,"type":"array","items":{"type":"string"}},{"type":"null"}]},"SignupResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"store":{"$ref":"#/components/schemas/StoreSummary"}},"required":["user","store"],"additionalProperties":false},"SitemapEntry":{"type":"object","properties":{"path":{"type":"string","maxLength":400},"lastmod":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"image":{"anyOf":[{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"coverUrl":{"type":["string","null"]},"title":{"type":"string"}},"required":["productId","coverUrl","title"],"additionalProperties":false},{"type":"null"}]}},"required":["path","lastmod","image"],"additionalProperties":false},"SitemapFile":{"type":"object","properties":{"name":{"type":"string","maxLength":80},"kind":{"$ref":"#/components/schemas/SitemapKind"},"prefix":{"type":"string","maxLength":2},"after":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"until":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"urls":{"type":"integer","minimum":0,"maximum":9007199254740991},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastmod":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"version":{"type":"string","maxLength":80},"tag":{"type":"string","maxLength":80}},"required":["name","kind","prefix","after","until","urls","bytes","lastmod","version","tag"],"additionalProperties":false},"SitemapKind":{"type":"string","enum":["products","collections","pages","categories"]},"SitemapPage":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/SitemapEntry"}},"next":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["entries","next"],"additionalProperties":false},"SlaState":{"type":"string","enum":["ok","warning","breached","met","none"]},"SlaTargets":{"type":"object","properties":{"low":{"type":"integer","minimum":5,"maximum":43200},"normal":{"type":"integer","minimum":5,"maximum":43200},"high":{"type":"integer","minimum":5,"maximum":43200},"urgent":{"type":"integer","minimum":5,"maximum":43200}},"required":["low","normal","high","urgent"],"additionalProperties":false},"SliceSource":{"type":"string","enum":["collection","category"]},"SocialBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"social"},"align":{"default":"center","type":"string","enum":["left","center","right"]},"links":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"network":{"$ref":"#/components/schemas/SocialNetwork"},"url":{"type":"string","maxLength":800}},"required":["network","url"],"additionalProperties":false}}},"required":["id","type","align","links"],"additionalProperties":false},"SocialNetwork":{"type":"string","enum":["x","instagram","youtube","tiktok","discord","telegram","facebook","twitch","github","website"]},"SocialPlacementSchema":{"type":"string","enum":["footer","header","both"]},"SortDirection":{"type":"string","enum":["asc","desc"]},"SpacerBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"spacer"},"height":{"default":24,"type":"integer","minimum":4,"maximum":96}},"required":["id","type","height"],"additionalProperties":false},"SslStatus":{"type":"string","enum":["pending","active","expired","failed"]},"StackingEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DiscountId"},"kind":{"$ref":"#/components/schemas/DiscountKind"},"code":{"type":["string","null"]},"title":{"type":"string"},"status":{"$ref":"#/components/schemas/DiscountStatus"},"combinable":{"type":"boolean"},"priority":{"type":"integer","minimum":0,"maximum":100},"excludeSaleItems":{"type":"boolean"},"valueLabel":{"type":"string"}},"required":["id","kind","code","title","status","combinable","priority","excludeSaleItems","valueLabel"],"additionalProperties":false},"StackingPolicy":{"type":"object","properties":{"mode":{"default":"best","type":"string","enum":["best","priority"]},"maxStack":{"default":10,"type":"integer","minimum":1,"maximum":10},"codesWithAutomatic":{"default":true,"type":"boolean"}},"required":["mode","maxStack","codesWithAutomatic"],"additionalProperties":false},"StackingSettings":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/StackingPolicy"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/StackingEntry"}},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["policy","discounts","updatedAt"],"additionalProperties":false},"StaffNote":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminNoteId"},"body":{"type":"string"},"authorHandle":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","body","authorHandle","createdAt"],"additionalProperties":false},"StartAgentAttachmentResponse":{"type":"object","properties":{"attachmentId":{"$ref":"#/components/schemas/TicketAttachmentId"},"url":{"type":"string"},"method":{"type":"string","const":"PUT"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"maxBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"claim":{"type":["string","null"]}},"required":["attachmentId","url","method","headers","expiresAt","maxBytes","claim"],"additionalProperties":false},"StartBuyerDiscordLinkResponse":{"type":"object","properties":{"authorizeUrl":{"type":"string"}},"required":["authorizeUrl"],"additionalProperties":false},"StartCheckoutResult":{"type":"object","properties":{"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"accessToken":{"type":"string"},"paid":{"type":"boolean"},"sandbox":{"type":"boolean"},"payUrl":{"type":"string"}},"required":["sessionId","accessToken","paid","sandbox","payUrl"],"additionalProperties":false},"StartDiscordConnectResponse":{"type":"object","properties":{"authorizeUrl":{"type":"string"}},"required":["authorizeUrl"],"additionalProperties":false},"StartDiscordStaffLinkResponse":{"type":"object","properties":{"authorizeUrl":{"type":"string"}},"required":["authorizeUrl"],"additionalProperties":false},"StartDiscordVerifyResponse":{"type":"object","properties":{"sentTo":{"type":"string"}},"required":["sentTo"],"additionalProperties":false},"StartedBlogMedia":{"type":"object","properties":{"mediaId":{"$ref":"#/components/schemas/BlogMediaId"},"url":{"type":"string"},"method":{"type":"string","const":"PUT"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"maxBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["mediaId","url","method","headers","expiresAt","maxBytes"],"additionalProperties":false},"StartedDeskAttachment":{"type":"object","properties":{"attachmentId":{"$ref":"#/components/schemas/DeskAttachmentId"},"url":{"type":"string"},"method":{"type":"string","const":"PUT"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"maxBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["attachmentId","url","method","headers","expiresAt","maxBytes"],"additionalProperties":false},"StatementCheck":{"type":"object","properties":{"name":{"type":"string"},"ok":{"type":"boolean"},"expectedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"actualMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"detail":{"type":"string"}},"required":["name","ok","expectedMinor","actualMinor","detail"],"additionalProperties":false},"StatementLine":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/StatementLineKey"},"label":{"type":"string"},"amountMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"kind":{"type":"string","enum":["income","deduction","subtotal","info"]},"source":{"type":"string","enum":["ledger","orders"]},"detail":{"type":"string"},"count":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["key","label","amountMinor","kind","source","detail","count"],"additionalProperties":false},"StatementLineKey":{"type":"string","enum":["gross_sales","discounts","net_sales","platform_fees","sales_earnings","tax_collected","processor_fees","refunds","refund_fees_returned","refunded_tax","disputes","affiliate_commissions","plan_charges","ai_credits","resell_supply","referral_earnings","other","net_earnings","payouts","payout_fees","balance_change"]},"StatementMonth":{"type":"object","properties":{"month":{"type":"string","pattern":"^\\d{4}-\\d{2}$"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"salesMinor":{"$ref":"#/components/schemas/MinorUnits"},"commissionMinor":{"$ref":"#/components/schemas/MinorUnits"},"payoutFeesMinor":{"$ref":"#/components/schemas/MinorUnits"},"refundedFeesMinor":{"$ref":"#/components/schemas/MinorUnits"},"subscriptionMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["month","orders","salesMinor","commissionMinor","payoutFeesMinor","refundedFeesMinor","subscriptionMinor","totalMinor"],"additionalProperties":false},"StatusBoardSettings":{"type":"object","properties":{"title":{"default":"Product status","type":"string","minLength":1,"maxLength":60},"intro":{"default":"Live status of every product. We update it after each game patch.","type":"string","maxLength":200},"showButton":{"default":true,"type":"boolean"},"buttonPosition":{"default":"bottom-right","type":"string","enum":["bottom-left","bottom-right"]},"showOnProductPages":{"default":true,"type":"boolean"}},"required":["title","intro","showButton","buttonPosition","showOnProductPages"],"additionalProperties":false},"StatusComponent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusComponentId"},"name":{"type":"string"},"description":{"type":"string"},"group":{"type":"string"},"productId":{"anyOf":[{"$ref":"#/components/schemas/ProductId"},{"type":"null"}]},"productName":{"type":["string","null"]},"labelId":{"$ref":"#/components/schemas/StatusLabelId"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"showUptime":{"type":"boolean"},"since":{"$ref":"#/components/schemas/Timestamp"},"note":{"type":"string"}},"required":["id","name","description","group","productId","productName","labelId","position","showUptime","since","note"],"additionalProperties":false},"StatusComponentId":{"type":"string","pattern":"^scm_[0-9a-hjkmnp-tv-z]{20}$"},"StatusIcon":{"type":"string","enum":["check","refresh","wrench","eye","ban","gavel","x","alert","clock","shield","bolt","pause","flask","lock","cloud","dot"]},"StatusIncident":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusIncidentId"},"kind":{"$ref":"#/components/schemas/IncidentKind"},"title":{"type":"string"},"state":{"$ref":"#/components/schemas/IncidentState"},"componentIds":{"type":"array","items":{"$ref":"#/components/schemas/StatusComponentId"}},"labelId":{"anyOf":[{"$ref":"#/components/schemas/StatusLabelId"},{"type":"null"}]},"scheduledStart":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"scheduledEnd":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"resolvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"updates":{"type":"array","items":{"$ref":"#/components/schemas/IncidentUpdate"}}},"required":["id","kind","title","state","componentIds","labelId","scheduledStart","scheduledEnd","startedAt","resolvedAt","updates"],"additionalProperties":false},"StatusIncidentId":{"type":"string","pattern":"^sinc_[0-9a-hjkmnp-tv-z]{20}$"},"StatusLabel":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusLabelId"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"$ref":"#/components/schemas/StatusIcon"},"color":{"$ref":"#/components/schemas/HexColor"},"severity":{"$ref":"#/components/schemas/StatusSeverity"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"countsAsUp":{"type":"boolean"}},"required":["id","name","description","icon","color","severity","position","countsAsUp"],"additionalProperties":false},"StatusLabelId":{"type":"string","pattern":"^slb_[0-9a-hjkmnp-tv-z]{20}$"},"StatusPage":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusPageId"},"slug":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"isDefault":{"type":"boolean"},"published":{"type":"boolean"},"historyDays":{"anyOf":[{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":90}]},"showUptime":{"type":"boolean"},"allowSubscribers":{"type":"boolean"},"theme":{"$ref":"#/components/schemas/StatusPageTheme"},"embedOrigins":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","slug","name","description","isDefault","published","historyDays","showUptime","allowSubscribers","theme","embedOrigins","url","updatedAt"],"additionalProperties":false},"StatusPageId":{"type":"string","pattern":"^spg_[0-9a-hjkmnp-tv-z]{20}$"},"StatusPageTheme":{"type":"object","properties":{"accent":{"anyOf":[{"$ref":"#/components/schemas/HexColor"},{"type":"null"}]},"layout":{"type":"string","enum":["list","grid"]},"appearance":{"type":"string","enum":["auto","dark","light"]},"showGroups":{"type":"boolean"}},"required":["accent","layout","appearance","showGroups"],"additionalProperties":false},"StatusSeverity":{"type":"string","enum":["operational","degraded","maintenance","outage"]},"StatusSubscribeResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true},"confirm":{"type":"boolean"}},"required":["ok","confirm"],"additionalProperties":false},"StatusSubscriber":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StatusSubscriberId"},"kind":{"$ref":"#/components/schemas/SubscriberKind"},"target":{"type":"string"},"confirmed":{"type":"boolean"},"componentIds":{"type":"array","items":{"$ref":"#/components/schemas/StatusComponentId"}},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","target","confirmed","componentIds","createdAt"],"additionalProperties":false},"StatusSubscriberId":{"type":"string","pattern":"^ssub_[0-9a-hjkmnp-tv-z]{20}$"},"StatusSubscriptionResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true},"pageName":{"type":"string"},"pageSlug":{"type":"string"}},"required":["ok","pageName","pageSlug"],"additionalProperties":false},"StatusUpdateId":{"type":"string","pattern":"^supd_[0-9a-hjkmnp-tv-z]{20}$"},"StepField":{"type":"string","enum":["path","product","product_type","target","search","prop"]},"StepFilter":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/StepField"},"op":{"$ref":"#/components/schemas/FilterOp"},"value":{"type":"string","maxLength":200},"prop":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},{"type":"null"}]}},"required":["field","op","value","prop"],"additionalProperties":false},"StepStatus":{"type":"string","enum":["pending","running","succeeded","failed","skipped"]},"StepUpStatus":{"type":"object","properties":{"available":{"type":"boolean"},"needsCode":{"default":true,"type":"boolean"},"rememberedUntil":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["available","needsCode","rememberedUntil"],"additionalProperties":false},"StockAdjustReason":{"type":"string","enum":["restock","correction","damaged","returned","sale","keys_added","keys_removed","import"]},"StockAdjustment":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StockAdjustmentId"},"productId":{"$ref":"#/components/schemas/ProductId"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"productName":{"type":"string"},"variantName":{"type":["string","null"]},"delta":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stockAfter":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"reason":{"$ref":"#/components/schemas/StockAdjustReason"},"note":{"type":"string"},"actor":{"type":"object","properties":{"userId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"name":{"type":"string"}},"required":["userId","name"],"additionalProperties":false},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","productId","variantId","productName","variantName","delta","stockAfter","reason","note","actor","createdAt"],"additionalProperties":false},"StockAdjustmentId":{"type":"string","pattern":"^adj_[0-9a-hjkmnp-tv-z]{20}$"},"StockAlertRow":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"title":{"type":"string"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]},"variant":{"type":["string","null"]},"waiting":{"type":"integer","minimum":0,"maximum":9007199254740991},"notified":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastSignupAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["productId","title","variantId","variant","waiting","notified","lastSignupAt"],"additionalProperties":false},"StockAlertSummary":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/StockAlertRow"}},"waiting":{"type":"integer","minimum":0,"maximum":9007199254740991},"notified":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["rows","waiting","notified"],"additionalProperties":false},"StockHealth":{"type":"string","enum":["healthy","low","out","unlimited"]},"StockMode":{"type":"string","enum":["unlimited","limited","key_pool","serial_pool"]},"StockTheme":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"name":{"type":"string"},"version":{"type":"string"},"description":{"type":"string"},"presets":{"type":"array","items":{"$ref":"#/components/schemas/StockThemePreset"}},"releaseId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/TemplateReleaseId"},{"type":"null"}]},"origin":{"default":"builtin","$ref":"#/components/schemas/TemplateOrigin"},"author":{"default":null,"type":["string","null"]},"listing":{"default":null,"anyOf":[{"$ref":"#/components/schemas/TemplateListing"},{"type":"null"}]},"filesHash":{"default":null,"anyOf":[{"type":"string","pattern":"^[0-9a-f]{64}$"},{"type":"null"}]},"isDefault":{"default":false,"type":"boolean"}},"required":["id","name","version","description","presets","releaseId","origin","author","listing","filesHash","isDefault"],"additionalProperties":false},"StockThemePreset":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"swatch":{"maxItems":4,"type":"array","items":{"type":"string","pattern":"^#[0-9a-f]{6}$"}}},"required":["name","description","swatch"],"additionalProperties":false},"StockThemeRelease":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TemplateSlug"},"name":{"type":"string"},"version":{"$ref":"#/components/schemas/SemVer"},"releaseId":{"anyOf":[{"$ref":"#/components/schemas/TemplateReleaseId"},{"type":"null"}]},"listing":{"$ref":"#/components/schemas/TemplateListing"},"files":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["id","name","version","releaseId","listing","files"],"additionalProperties":false},"Store":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":80},"handle":{"$ref":"#/components/schemas/StoreHandle"},"domain":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"features":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/FeatureKey"}},"planState":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorePlanState"},{"type":"null"}]},"category":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StoreCategory"},{"type":"null"}]},"logoUrl":{"default":null,"type":["string","null"]},"timezone":{"default":"UTC","type":"string"},"ownerId":{"$ref":"#/components/schemas/UserId"},"tagline":{"type":"string","maxLength":160},"supportEmail":{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},"country":{"$ref":"#/components/schemas/CountryCode"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","handle","domain","currency","paymentModel","planId","planName","features","planState","category","logoUrl","timezone","ownerId","tagline","supportEmail","country","createdAt"],"additionalProperties":false},"StoreAccess":{"type":"object","properties":{"role":{"$ref":"#/components/schemas/MemberRoleKind"},"roleName":{"type":"string"},"customRoleId":{"anyOf":[{"$ref":"#/components/schemas/RoleId"},{"type":"null"}]},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/StorePermission"}},"twoFactorRequired":{"type":"boolean"},"conditional":{"type":"array","items":{"type":"object","properties":{"permission":{"$ref":"#/components/schemas/StorePermission"},"effect":{"type":"string","enum":["allow","deny"]},"policy":{"type":"string"},"summary":{"type":"string"}},"required":["permission","effect","policy","summary"],"additionalProperties":false}}},"required":["role","roleName","customRoleId","permissions"],"additionalProperties":false},"StoreAuditActor":{"type":"object","properties":{"kind":{"type":"string","enum":["user","api_key"]},"userId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"name":{"type":"string"},"email":{"type":["string","null"]},"apiKeyId":{"anyOf":[{"$ref":"#/components/schemas/ApiKeyId"},{"type":"null"}]},"apiKeyName":{"type":["string","null"]}},"required":["kind","userId","name","email","apiKeyId","apiKeyName"],"additionalProperties":false},"StoreAuditDetails":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string"}},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/AuditScalar"}}},"required":["fields","values"],"additionalProperties":false},"StoreAuditEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreAuditEntryId"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"actor":{"$ref":"#/components/schemas/StoreAuditActor"},"action":{"type":"string"},"area":{"type":"string"},"summary":{"type":"string"},"method":{"type":"string","enum":["POST","PUT","PATCH","DELETE"]},"path":{"type":"string"},"target":{"anyOf":[{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"label":{"type":["string","null"]}},"required":["type","id","label"],"additionalProperties":false},{"type":"null"}]},"details":{"$ref":"#/components/schemas/StoreAuditDetails"},"ip":{"type":"string"},"userAgent":{"type":["string","null"]},"before":{"default":null,"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/AuditScalar"}},{"type":"null"}]},"after":{"default":null,"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/AuditScalar"}},{"type":"null"}]},"alert":{"default":null,"type":["string","null"]},"via":{"default":null,"anyOf":[{"type":"string","enum":["ai","mcp"]},{"type":"null"}]}},"required":["id","createdAt","actor","action","area","summary","method","path","target","details","ip","userAgent","before","after","alert","via"],"additionalProperties":false},"StoreAuditEntryId":{"type":"string","pattern":"^sal_[0-9a-hjkmnp-tv-z]{20}$"},"StoreAuditFacets":{"type":"object","properties":{"actors":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/ApiKeyId"}]},"kind":{"type":"string","enum":["user","api_key"]},"name":{"type":"string"},"detail":{"type":"string"}},"required":["id","kind","name","detail"],"additionalProperties":false}},"actions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"summary":{"type":"string"},"area":{"type":"string"}},"required":["action","summary","area"],"additionalProperties":false}}},"required":["actors","actions"],"additionalProperties":false},"StoreCategory":{"type":"string","enum":["game_keys","game_accounts","software","courses","memberships","gift_cards","digital_art","services","other"]},"StoreCollection":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CollectionId"},"handle":{"$ref":"#/components/schemas/PageHandle"},"title":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":2000},"productIds":{"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"sort":{"$ref":"#/components/schemas/CollectionSort"},"published":{"type":"boolean"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"kind":{"default":"manual","type":"string","enum":["manual","automatic"]},"rules":{"default":[],"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/CollectionRule"}},"match":{"default":"all","type":"string","enum":["all","any"]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"seoTitle":{"default":null,"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"default":null,"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"position":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"matchedProductIds":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"templateSuffix":{"default":null,"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]}},"required":["id","handle","title","description","productIds","sort","published","updatedAt","kind","rules","match","imageUrl","seoTitle","seoDescription","position","matchedProductIds","templateSuffix"],"additionalProperties":false},"StoreControls":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"handle":{"type":"string"},"platformHost":{"type":"string"},"previousHandles":{"type":"array","items":{"type":"object","properties":{"handle":{"type":"string"},"changedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["handle","changedAt"],"additionalProperties":false}},"testMode":{"type":"object","properties":{"on":{"type":"boolean"},"until":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["on","until"],"additionalProperties":false},"members":{"type":"array","items":{"$ref":"#/components/schemas/AdminStoreMember"}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/RoleId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"domains":{"type":"array","items":{"$ref":"#/components/schemas/AdminStoreDomain"}},"search":{"anyOf":[{"type":"object","properties":{"builtAt":{"$ref":"#/components/schemas/Timestamp"},"products":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["builtAt","products"],"additionalProperties":false},{"type":"null"}]},"notes":{"type":"array","items":{"$ref":"#/components/schemas/StaffNote"}}},"required":["storeId","handle","platformHost","previousHandles","testMode","members","roles","domains","search","notes"],"additionalProperties":false},"StoreControlsResult":{"type":"object","properties":{"controls":{"$ref":"#/components/schemas/StoreControls"},"emailed":{"type":"array","items":{"type":"string"}}},"required":["controls","emailed"],"additionalProperties":false},"StoreCreditEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CreditEntryId"},"kind":{"$ref":"#/components/schemas/StoreCreditKind"},"amountMinor":{"$ref":"#/components/schemas/MinorUnits"},"balanceAfterMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"note":{"type":"string"},"actorName":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","amountMinor","balanceAfterMinor","orderId","orderNumber","note","actorName","createdAt"],"additionalProperties":false},"StoreCreditKind":{"type":"string","enum":["adjust","refund","spend","release","refund_bonus"]},"StoreFeatureState":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/FeatureKey"},"label":{"type":"string"},"enabled":{"type":"boolean"},"source":{"type":"string","enum":["all","store","owner","off"]},"storeGrantId":{"anyOf":[{"$ref":"#/components/schemas/FeatureGrantId"},{"type":"null"}]}},"required":["key","label","enabled","source","storeGrantId"],"additionalProperties":false},"StoreFeaturesView":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"features":{"type":"array","items":{"$ref":"#/components/schemas/StoreFeatureState"}}},"required":["storeId","features"],"additionalProperties":false},"StoreFeeOverride":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"override":{"$ref":"#/components/schemas/FeeOverride"},"reason":{"type":"string","minLength":1,"maxLength":280},"updatedBy":{"$ref":"#/components/schemas/AdminUserId"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["storeId","override","reason","updatedBy","updatedAt"],"additionalProperties":false},"StoreFees":{"type":"object","properties":{"plan":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PlanId"},"name":{"type":"string","minLength":1,"maxLength":40},"monthlyPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["id","name","monthlyPriceMinor","currency"],"additionalProperties":false},"fees":{"$ref":"#/components/schemas/FeeSchedule"},"hasOverride":{"type":"boolean"},"allowedModels":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PaymentModel"}},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"settlement":{"type":"object","properties":{"holdDays":{"type":"integer","minimum":0,"maximum":90},"payoutSchedule":{"type":"string","enum":["daily","weekly","monthly"]},"payoutWeekday":{"type":"integer","minimum":0,"maximum":6},"payoutMinimumMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"reserveBps":{"$ref":"#/components/schemas/Bps"}},"required":["holdDays","payoutSchedule","payoutWeekday","payoutMinimumMinor","reserveBps"],"additionalProperties":false},"processorEstimate":{"anyOf":[{"$ref":"#/components/schemas/ProcessorEstimate"},{"type":"null"}]},"canTakePayments":{"type":"boolean"},"pricesIncludeTax":{"type":"boolean"},"taxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"country":{"$ref":"#/components/schemas/CountryCode"}},"required":["plan","fees","hasOverride","allowedModels","paymentModel","settlement","processorEstimate"],"additionalProperties":false},"StoreGeneral":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/Store"},"logoUrl":{"type":["string","null"]},"faviconUrl":{"type":["string","null"]},"brandColor":{"$ref":"#/components/schemas/HexColor"},"status":{"$ref":"#/components/schemas/StorefrontStatus"},"statusMessage":{"type":"string","maxLength":500},"timezone":{"$ref":"#/components/schemas/TimeZone"},"currencyDisplay":{"$ref":"#/components/schemas/CurrencyDisplay"},"legal":{"$ref":"#/components/schemas/LegalDetails"},"previousHandles":{"type":"array","items":{"type":"object","properties":{"handle":{"$ref":"#/components/schemas/StoreHandle"},"changedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["handle","changedAt"],"additionalProperties":false}}},"required":["store","logoUrl","faviconUrl","brandColor","status","statusMessage","timezone","currencyDisplay","legal","previousHandles"],"additionalProperties":false},"StoreHandle":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"},"StoreId":{"type":"string","pattern":"^st_[0-9a-hjkmnp-tv-z]{20}$"},"StorePage":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PageId"},"handle":{"$ref":"#/components/schemas/PageHandle"},"title":{"type":"string","minLength":1,"maxLength":120},"bodyHtml":{"type":"string","maxLength":100000},"seoTitle":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"seoDescription":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"templateSuffix":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},{"type":"null"}]},"published":{"type":"boolean"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","handle","title","bodyHtml","seoTitle","seoDescription","templateSuffix","published","updatedAt"],"additionalProperties":false},"StorePasswordSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"hasPassword":{"type":"boolean"},"message":{"type":"string","maxLength":300},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["enabled","hasPassword","message","updatedAt"],"additionalProperties":false},"StorePermission":{"type":"string","enum":["catalog:read","catalog:write","orders:read","orders:write","customers:read","customers:write","disputes:read","disputes:write","reviews:read","reviews:write","marketing:read","marketing:write","analytics:read","analytics:write","storefront:read","storefront:write","payments:read","payments:write","finance:read","finance:write","team:read","team:write","settings:read","settings:write","discord:read","discord:write","fraud:read","fraud:write","developers:read","developers:write","audit:read","audit:write","support:read","support:write","ai:read","ai:write"]},"StorePlanState":{"type":"object","properties":{"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"activePlanName":{"type":"string"},"limits":{"$ref":"#/components/schemas/PlanLimits"},"trial":{"anyOf":[{"$ref":"#/components/schemas/StorePlanTrial"},{"type":"null"}]},"hasOverride":{"type":"boolean"},"upgradeTo":{"type":"object","propertyNames":{"$ref":"#/components/schemas/PlanLimitKey"},"additionalProperties":{"type":["string","null"]},"required":["products","ordersPerMonth","teamMembers","customDomains","removeBranding","developerTools","themeCode","shopfastPay"]}},"required":["planId","planName","activePlanName","limits","trial","hasOverride","upgradeTo"],"additionalProperties":false},"StorePlanTrial":{"type":"object","properties":{"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"endsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["planId","planName","endsAt"],"additionalProperties":false},"StoreReviewCounts":{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"published":{"type":"integer","minimum":0,"maximum":9007199254740991},"hidden":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","published","hidden"],"additionalProperties":false},"StoreReviewId":{"type":"string","pattern":"^srv_[0-9a-hjkmnp-tv-z]{20}$"},"StoreSeo":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":70},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":320},{"type":"null"}]},"socialImageUrl":{"anyOf":[{"type":"string","maxLength":2000,"format":"uri"},{"type":"null"}]},"allowIndexing":{"type":"boolean"},"blockAiCrawlers":{"type":"boolean"}},"required":["title","description","socialImageUrl","allowIndexing","blockAiCrawlers"],"additionalProperties":false},"StoreSocial":{"type":"object","properties":{"placement":{"default":"footer","$ref":"#/components/schemas/SocialPlacementSchema"},"links":{"maxItems":18,"type":"array","items":{"$ref":"#/components/schemas/StoreSocialLink"}}},"required":["placement","links"],"additionalProperties":false},"StoreSocialLink":{},"StoreSocialSettings":{"type":"object","properties":{"social":{"$ref":"#/components/schemas/StoreSocial"},"saved":{"type":"boolean"},"liveTheme":{"default":null,"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"complete":{"type":"boolean"}},"required":["name","complete"],"additionalProperties":false},{"type":"null"}]}},"required":["social","saved","liveTheme"],"additionalProperties":false},"StoreStats":{"type":"object","properties":{"ordersDelivered":{"type":"integer","minimum":0,"maximum":9007199254740991},"reviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"ratingAverage":{"anyOf":[{"type":"number","minimum":1,"maximum":5},{"type":"null"}]},"sinceYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["ordersDelivered","reviewCount","ratingAverage","sinceYear"],"additionalProperties":false},"StoreStatsSettings":{"type":"object","properties":{"heading":{"default":"","type":"string","maxLength":60},"showOrders":{"default":true,"type":"boolean"},"showRating":{"default":true,"type":"boolean"},"showSince":{"default":true,"type":"boolean"},"minOrders":{"default":50,"type":"integer","minimum":0,"maximum":100000},"placement":{"default":"home_and_product","type":"string","enum":["home","home_and_product","footer"]}},"required":["heading","showOrders","showRating","showSince","minOrders","placement"],"additionalProperties":false},"StoreSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":80},"handle":{"$ref":"#/components/schemas/StoreHandle"},"domain":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"features":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/FeatureKey"}},"planState":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorePlanState"},{"type":"null"}]},"category":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StoreCategory"},{"type":"null"}]},"logoUrl":{"default":null,"type":["string","null"]},"timezone":{"default":"UTC","type":"string"}},"required":["id","name","handle","domain","currency","paymentModel","planId","planName","features","planState","category","logoUrl","timezone"],"additionalProperties":false},"StoredImageVariants":{"type":"object","properties":{"key":{"type":"string","maxLength":300},"version":{"type":"integer","minimum":1,"maximum":9007199254740991},"width":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"specs":{"maxItems":64,"type":"array","items":{"type":"string","maxLength":40}}},"required":["key","version","width","height","specs"],"additionalProperties":false},"StorefrontAddOn":{"type":"object","properties":{"handle":{"type":"string"},"title":{"type":"string"},"headline":{"type":"string"},"body":{"type":"string"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"regularPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]}},"required":["handle","title","headline","body","priceMinor","regularPriceMinor","variantId"],"additionalProperties":false},"StorefrontAnalyticsConfig":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/ConsentMode"},"respectGpc":{"type":"boolean"},"excludedPaths":{"type":"array","items":{"type":"string"}}},"required":["mode","respectGpc","excludedPaths"],"additionalProperties":false},"StorefrontAppEntry":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","const":"purchase_alerts"},"settings":{"$ref":"#/components/schemas/PurchaseAlertsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"countdown_banner"},"settings":{"$ref":"#/components/schemas/CountdownBannerSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"trust_badges"},"settings":{"$ref":"#/components/schemas/TrustBadgesSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"status_board"},"settings":{"$ref":"#/components/schemas/StatusBoardSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"live_chat"},"settings":{"$ref":"#/components/schemas/LiveChatSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"discord_widget"},"settings":{"$ref":"#/components/schemas/DiscordWidgetSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"google_analytics"},"settings":{"$ref":"#/components/schemas/GoogleAnalyticsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"meta_pixel"},"settings":{"$ref":"#/components/schemas/MetaPixelSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"tiktok_pixel"},"settings":{"$ref":"#/components/schemas/TikTokPixelSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"cookie_consent"},"settings":{"$ref":"#/components/schemas/CookieConsentSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"age_gate"},"settings":{"$ref":"#/components/schemas/AgeGateSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"currency_display"},"settings":{"$ref":"#/components/schemas/CurrencyDisplaySettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"reviews_carousel"},"settings":{"$ref":"#/components/schemas/ReviewsCarouselSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"faq_bot"},"settings":{"$ref":"#/components/schemas/FaqBotSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"content_protection"},"settings":{"$ref":"#/components/schemas/ContentProtectionSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"maintenance_page"},"settings":{"type":"object","properties":{"heading":{"default":"We will be right back","type":"string","minLength":1,"maxLength":80},"message":{"default":"The store is getting an update. Check back in a little while.","type":"string","maxLength":400},"backAt":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"startsAt":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"endsAt":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}]},"bypassHash":{"type":["string","null"]}},"required":["heading","message","backAt","startsAt","endsAt","bypassHash"],"additionalProperties":false}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"back_in_stock"},"settings":{"$ref":"#/components/schemas/BackInStockSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"recently_viewed"},"settings":{"$ref":"#/components/schemas/RecentlyViewedSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"wishlist"},"settings":{"$ref":"#/components/schemas/WishlistSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"bought_together"},"settings":{"$ref":"#/components/schemas/BoughtTogetherSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"tab_reminder"},"settings":{"$ref":"#/components/schemas/TabReminderSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"promo_bar"},"settings":{"$ref":"#/components/schemas/PromoBarPublic"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"payment_icons"},"settings":{"$ref":"#/components/schemas/PaymentIconsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"delivery_notice"},"settings":{"$ref":"#/components/schemas/DeliveryNoticeSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"store_stats"},"settings":{"$ref":"#/components/schemas/StoreStatsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"activation_guide"},"settings":{"$ref":"#/components/schemas/ActivationGuideSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"trustpilot"},"settings":{"$ref":"#/components/schemas/TrustpilotSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"scam_notice"},"settings":{"$ref":"#/components/schemas/ScamNoticeSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"chat_buttons"},"settings":{"$ref":"#/components/schemas/ChatButtonsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"share_buttons"},"settings":{"$ref":"#/components/schemas/ShareButtonsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"affiliate_invite"},"settings":{"$ref":"#/components/schemas/AffiliateInviteSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"x_pixel"},"settings":{"$ref":"#/components/schemas/XPixelSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"reddit_pixel"},"settings":{"$ref":"#/components/schemas/RedditPixelSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"google_ads"},"settings":{"$ref":"#/components/schemas/GoogleAdsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"cookieless_analytics"},"settings":{"$ref":"#/components/schemas/CookielessAnalyticsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"region_notice"},"settings":{"$ref":"#/components/schemas/RegionNoticeSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"privacy_requests"},"settings":{"$ref":"#/components/schemas/PrivacyRequestsSettings"}},"required":["id","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","const":"away_notice"},"settings":{"$ref":"#/components/schemas/AwayNoticeSettings"}},"required":["id","settings"],"additionalProperties":false}]},"StorefrontApps":{"type":"object","properties":{"apps":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontAppEntry"}},"popups":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontPopup"}},"consentFromApp":{"default":false,"type":"boolean"}},"required":["apps","popups","consentFromApp"],"additionalProperties":false},"StorefrontBoughtTogetherResponse":{"type":"object","properties":{"productIds":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}}},"required":["productIds"],"additionalProperties":false},"StorefrontCatalog":{"type":"object","properties":{"promotions":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/LivePromotion"}},"store":{"$ref":"#/components/schemas/StorefrontStore"},"products":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontProduct"}},"collections":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontCollection"}},"pages":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontPage"}},"categories":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontCategoryList"}},"etag":{"type":"string"},"generatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["promotions","store","products","collections","pages","categories","etag","generatedAt"],"additionalProperties":false},"StorefrontCategoriesResponse":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontCategory"}}},"required":["categories"],"additionalProperties":false},"StorefrontCategory":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CategoryId"},"parentId":{"anyOf":[{"$ref":"#/components/schemas/CategoryId"},{"type":"null"}]},"handle":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"imageUrl":{"type":["string","null"]},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"depth":{"type":"integer","minimum":0,"maximum":9007199254740991},"sort":{"$ref":"#/components/schemas/CategorySort"},"seoTitle":{"default":null,"type":["string","null"]},"seoDescription":{"default":null,"type":["string","null"]},"productsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"previousHandles":{"default":[],"type":"array","items":{"type":"string"}},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","parentId","handle","title","description","imageUrl","position","depth","sort","seoTitle","seoDescription","productsCount","previousHandles","updatedAt"],"additionalProperties":false},"StorefrontCategoryList":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CategoryId"},"parentId":{"anyOf":[{"$ref":"#/components/schemas/CategoryId"},{"type":"null"}]},"handle":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"imageUrl":{"type":["string","null"]},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"depth":{"type":"integer","minimum":0,"maximum":9007199254740991},"sort":{"$ref":"#/components/schemas/CategorySort"},"seoTitle":{"default":null,"type":["string","null"]},"seoDescription":{"default":null,"type":["string","null"]},"productsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"previousHandles":{"default":[],"type":"array","items":{"type":"string"}},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"productHandles":{"type":"array","items":{"type":"string"}}},"required":["id","parentId","handle","title","description","imageUrl","position","depth","sort","seoTitle","seoDescription","productsCount","previousHandles","updatedAt","productHandles"],"additionalProperties":false},"StorefrontCategoryPage":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/StorefrontCategory"},"ancestors":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontCategory"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontCategory"}},"sort":{"$ref":"#/components/schemas/StorefrontSort"},"start":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"products":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontProduct"}},"nextCursor":{"type":["string","null"]},"generatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["category","ancestors","children","sort","start","total","products","nextCursor","generatedAt"],"additionalProperties":false},"StorefrontCheckout":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CheckoutSessionId"},"status":{"type":"string","enum":["open","paid","expired"]},"provider":{"$ref":"#/components/schemas/GatewayProvider"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"subtotalMinor":{"$ref":"#/components/schemas/MinorUnits"},"discountMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxRateBps":{"$ref":"#/components/schemas/Bps"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxIncluded":{"default":false,"type":"boolean"},"tipMinor":{"default":0,"$ref":"#/components/schemas/MinorUnits"},"buyerEmailMasked":{"type":"string"},"buyerCountry":{"$ref":"#/components/schemas/CountryCode"},"sandbox":{"type":"boolean"},"payUrl":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"savesMethod":{"type":"boolean"},"order":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"steps":{"type":"array","items":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/FulfillmentKind"},"status":{"$ref":"#/components/schemas/StepStatus"},"detail":{"type":"string"}},"required":["kind","status","detail"],"additionalProperties":false}}},"required":["id","number","status","paidAt","steps"],"additionalProperties":false},{"type":"null"}]},"returnUrl":{"default":null,"type":["string","null"]},"cancelUrl":{"default":null,"type":["string","null"]}},"required":["id","status","provider","paymentModel","items","currency","subtotalMinor","discountMinor","taxRateBps","taxMinor","totalMinor","taxIncluded","tipMinor","buyerEmailMasked","buyerCountry","sandbox","payUrl","expiresAt","order","returnUrl","cancelUrl"],"additionalProperties":false},"StorefrontCheckoutSettings":{"type":"object","properties":{"cart":{"$ref":"#/components/schemas/CartSettings"},"checkout":{"$ref":"#/components/schemas/CheckoutSettings"},"storeName":{"type":"string"},"theme":{"$ref":"#/components/schemas/ThemeLook"},"storefrontOrigin":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["cart","checkout","storeName","theme","storefrontOrigin","updatedAt"],"additionalProperties":false},"StorefrontClaimOrderResponse":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"}},"required":["email"],"additionalProperties":false},"StorefrontCollection":{"type":"object","properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/CollectionId"},{"type":"null"}]},"handle":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"productHandles":{"type":"array","items":{"type":"string"}},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"imageUrl":{"default":null,"type":["string","null"]},"seoTitle":{"default":null,"type":["string","null"]},"seoDescription":{"default":null,"type":["string","null"]},"templateSuffix":{"default":null,"type":["string","null"]}},"required":["id","handle","title","description","productHandles","updatedAt","imageUrl","seoTitle","seoDescription","templateSuffix"],"additionalProperties":false},"StorefrontCollectionMeta":{"type":"object","properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/CollectionId"},{"type":"null"}]},"handle":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"imageUrl":{"default":null,"type":["string","null"]},"seoTitle":{"default":null,"type":["string","null"]},"seoDescription":{"default":null,"type":["string","null"]},"templateSuffix":{"default":null,"type":["string","null"]},"productsCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","handle","title","description","updatedAt","imageUrl","seoTitle","seoDescription","templateSuffix","productsCount"],"additionalProperties":false},"StorefrontImage":{"type":"object","properties":{"url":{"type":"string"},"alt":{"type":"string"},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["url","alt","width","height"],"additionalProperties":false},"StorefrontIntegrations":{"type":"object","properties":{"googleAnalyticsId":{"anyOf":[{"$ref":"#/components/schemas/GoogleAnalyticsId"},{"type":"null"}]},"metaPixelId":{"anyOf":[{"$ref":"#/components/schemas/MetaPixelId"},{"type":"null"}]},"clarityId":{"anyOf":[{"$ref":"#/components/schemas/ClarityId"},{"type":"null"}]},"crispWebsiteId":{"anyOf":[{"$ref":"#/components/schemas/CrispWebsiteId"},{"type":"null"}]},"tawk":{"anyOf":[{"$ref":"#/components/schemas/TawkIds"},{"type":"null"}]},"consentRequired":{"type":"boolean"},"trustpilotBcc":{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},"gtmContainerId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/GtmContainerId"},{"type":"null"}]},"gtmOnCheckout":{"default":false,"type":"boolean"}},"required":["googleAnalyticsId","metaPixelId","clarityId","crispWebsiteId","tawk","consentRequired","trustpilotBcc","gtmContainerId","gtmOnCheckout"],"additionalProperties":false},"StorefrontKey":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StorefrontKeyId"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/StorefrontKeyKind"},"token":{"type":["string","null"]},"hint":{"type":"string"},"allowedOrigins":{"type":"array","items":{"type":"string"}},"createdBy":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"revokedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","name","kind","token","hint","allowedOrigins","createdBy","createdAt","lastUsedAt","revokedAt"],"additionalProperties":false},"StorefrontKeyId":{"type":"string","pattern":"^sfk_[0-9a-hjkmnp-tv-z]{20}$"},"StorefrontKeyKind":{"type":"string","enum":["publishable","private"]},"StorefrontLatestReview":{"type":"object","properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/ReviewId"},{"$ref":"#/components/schemas/StoreReviewId"}]},"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string","maxLength":120},"body":{"type":"string","maxLength":2000},"author":{"type":"string","maxLength":60},"verified":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"reply":{"default":null,"type":["string","null"]},"repliedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"source":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"sourceLabel":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"handle":{"type":"string"},"title":{"type":"string"}},"required":["handle","title"],"additionalProperties":false},{"type":"null"}]},"pinned":{"default":false,"type":"boolean"}},"required":["id","rating","title","body","author","verified","createdAt","reply","repliedAt","source","sourceLabel","imageUrl","product","pinned"],"additionalProperties":false},"StorefrontMedia":{"type":"object","properties":{"url":{"type":"string"},"alt":{"type":"string"},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"kind":{"$ref":"#/components/schemas/ProductMediaKind"},"posterUrl":{"type":["string","null"]},"externalId":{"type":["string","null"]}},"required":["url","alt","width","height","kind","posterUrl","externalId"],"additionalProperties":false},"StorefrontOffer":{"type":"object","properties":{"kind":{"type":"string","enum":["upsell","cross_sell"]},"placement":{"$ref":"#/components/schemas/OfferPlacement"},"handle":{"type":"string"},"title":{"type":"string"},"headline":{"type":"string"},"body":{"type":"string"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"regularPriceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"variantId":{"anyOf":[{"$ref":"#/components/schemas/VariantId"},{"type":"null"}]}},"required":["kind","placement","handle","title","headline","body","priceMinor","regularPriceMinor","variantId"],"additionalProperties":false},"StorefrontPage":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PageId"},"handle":{"type":"string"},"title":{"type":"string"},"bodyHtml":{"type":"string"},"seoTitle":{"type":["string","null"]},"seoDescription":{"type":["string","null"]},"templateSuffix":{"type":["string","null"]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","handle","title","bodyHtml","seoTitle","seoDescription","templateSuffix","updatedAt"],"additionalProperties":false},"StorefrontPasswordGate":{"type":"object","properties":{"enabled":{"type":"boolean"},"message":{"type":"string","maxLength":300},"version":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["enabled","message","version"],"additionalProperties":false},"StorefrontPopup":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PopupId"},"kind":{"$ref":"#/components/schemas/PopupKind"},"priority":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"trigger":{"$ref":"#/components/schemas/PopupTrigger"},"targeting":{"$ref":"#/components/schemas/PopupTargeting"},"frequency":{"$ref":"#/components/schemas/PopupFrequency"},"startsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"endsAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"variants":{"type":"array","items":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/PopupVariantKey"},"weight":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"design":{"$ref":"#/components/schemas/PopupDesign"},"content":{"type":"object","properties":{"eyebrow":{"default":"","type":"string","maxLength":40},"heading":{"type":"string","minLength":1,"maxLength":80},"body":{"default":"","type":"string","maxLength":300},"ctaLabel":{"default":"Shop now","type":"string","maxLength":30},"ctaLink":{"default":"/collections/all","type":"string","maxLength":300},"dismissLabel":{"default":"No thanks","type":"string","maxLength":30},"couponMode":{"default":"none","$ref":"#/components/schemas/PopupCouponMode"},"revealAfterEmail":{"default":false,"type":"boolean"},"emailCapture":{"default":false,"type":"boolean"},"emailPlaceholder":{"default":"you@example.com","type":"string","maxLength":60},"consentLabel":{"default":"Send me offers and updates by email. Unsubscribe anytime.","type":"string","maxLength":200},"requireConsent":{"default":false,"type":"boolean"},"submitLabel":{"default":"Get my code","type":"string","maxLength":30},"successHeading":{"default":"You are in","type":"string","maxLength":80},"successBody":{"default":"Use your code at checkout.","type":"string","maxLength":300},"timerMinutes":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":1440},{"type":"null"}]},"upsellHandle":{"default":null,"anyOf":[{"type":"string","maxLength":140},{"type":"null"}]},"code":{"type":["string","null"]}},"required":["eyebrow","heading","body","ctaLabel","ctaLink","dismissLabel","couponMode","revealAfterEmail","emailCapture","emailPlaceholder","consentLabel","requireConsent","submitLabel","successHeading","successBody","timerMinutes","upsellHandle","code"],"additionalProperties":false}},"required":["key","weight","design","content"],"additionalProperties":false}}},"required":["id","kind","priority","trigger","targeting","frequency","startsAt","endsAt","variants"],"additionalProperties":false},"StorefrontPreviewResponse":{"type":"object","properties":{"storeId":{"$ref":"#/components/schemas/StoreId"},"themeId":{"$ref":"#/components/schemas/ThemeId"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bundle":{"$ref":"#/components/schemas/StorefrontThemeBundle"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},"required":["storeId","themeId","revision","bundle","expiresAt"],"additionalProperties":false},"StorefrontProduct":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"handle":{"type":"string"},"title":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"description":{"type":"string"},"delivers":{"type":"string"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"available":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"lowStock":{"type":"boolean"},"coverUrl":{"type":["string","null"]},"rating":{"anyOf":[{"type":"object","properties":{"average":{"type":"number","minimum":1,"maximum":5},"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"distribution":{"minItems":5,"maxItems":5,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}}},"required":["average","count","distribution"],"additionalProperties":false},{"type":"null"}]},"reviews":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/StorefrontReview"}},"bundleItems":{"type":"array","items":{"type":"object","properties":{"handle":{"type":"string"},"title":{"type":"string"}},"required":["handle","title"],"additionalProperties":false}},"unitsSold30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"templateSuffix":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"descriptionHtml":{"default":"","type":"string"},"shortDescription":{"default":"","type":"string"},"tags":{"default":[],"type":"array","items":{"type":"string"}},"listed":{"default":true,"type":"boolean"},"featured":{"default":false,"type":"boolean"},"pricingMode":{"default":"fixed","$ref":"#/components/schemas/PricingMode"},"pwyw":{"default":null,"anyOf":[{"type":"object","properties":{"minMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"suggestedMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]}},"required":["minMinor","suggestedMinor"],"additionalProperties":false},{"type":"null"}]},"variants":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontVariant"}},"gallery":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontImage"}},"media":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontMedia"}},"collectionHandles":{"default":[],"type":"array","items":{"type":"string"}},"categoryHandles":{"default":[],"type":"array","items":{"type":"string"}},"upsellHandles":{"default":[],"type":"array","items":{"type":"string"}},"crossSellHandles":{"default":[],"type":"array","items":{"type":"string"}},"addOns":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontAddOn"}},"seo":{"default":{"title":null,"description":null,"ogImageUrl":null},"type":"object","properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]},"ogImageUrl":{"type":["string","null"]}},"required":["title","description","ogImageUrl"],"additionalProperties":false},"previousHandles":{"default":[],"type":"array","items":{"type":"string"}},"minPerOrder":{"default":1,"type":"integer","minimum":1,"maximum":9007199254740991},"maxPerOrder":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"outOfStock":{"default":"show_sold_out","$ref":"#/components/schemas/OutOfStockBehavior"},"preorder":{"default":false,"type":"boolean"},"checkoutFields":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CheckoutField"}},"subscription":{"default":null,"anyOf":[{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/SubscriptionInterval"},"intervalCount":{"type":"integer","minimum":1,"maximum":9007199254740991},"trialDays":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["interval","intervalCount","trialDays"],"additionalProperties":false},{"type":"null"}]},"promotion":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StorefrontProductPromotion"},{"type":"null"}]},"quantityTiers":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/QuantityTier"}},"tiersWithCoupons":{"default":true,"type":"boolean"},"paymentRules":{"default":{"disabledMethods":[],"multipliers":[]},"$ref":"#/components/schemas/PaymentRules"},"offers":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontOffer"}},"attributes":{"default":{"game":null,"platforms":[],"region":null,"status":null,"statusNote":"","statusUpdatedAt":null,"instantDelivery":false,"presetKey":null,"features":[],"featureGroups":[],"requirements":[]},"$ref":"#/components/schemas/ProductAttributes"},"statusLabel":{"default":null,"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"color":{"type":"string"}},"required":["name","color"],"additionalProperties":false},{"type":"null"}]},"salesPaused":{"default":null,"anyOf":[{"type":"object","properties":{"label":{"type":"string"},"color":{"type":"string"},"since":{"$ref":"#/components/schemas/Timestamp"},"note":{"default":"","type":"string"}},"required":["label","color","since","note"],"additionalProperties":false},{"type":"null"}]},"license":{"default":null,"anyOf":[{"type":"object","properties":{"clock":{"type":"string","enum":["purchase","activation"]},"hwid":{"type":"boolean"},"extend":{"type":"boolean"}},"required":["clock","hwid","extend"],"additionalProperties":false},{"type":"null"}]}},"required":["id","handle","title","type","description","delivers","priceMinor","compareAtMinor","currency","available","stock","lowStock","coverUrl","rating","reviews","bundleItems","unitsSold30d","templateSuffix","createdAt","updatedAt","descriptionHtml","shortDescription","tags","listed","featured","pricingMode","pwyw","variants","gallery","media","collectionHandles","categoryHandles","upsellHandles","crossSellHandles","addOns","seo","previousHandles","minPerOrder","maxPerOrder","outOfStock","preorder","checkoutFields","subscription","promotion","quantityTiers","tiersWithCoupons","paymentRules","offers","attributes","statusLabel","salesPaused","license"],"additionalProperties":false},"StorefrontProductPromotion":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/PromotionId"},"name":{"type":"string"},"percentOffBps":{"$ref":"#/components/schemas/Bps"},"endsAt":{"$ref":"#/components/schemas/Timestamp"},"stacking":{"$ref":"#/components/schemas/PromotionStacking"}},"required":["id","name","percentOffBps","endsAt","stacking"],"additionalProperties":false},"StorefrontProductSales":{"type":"object","properties":{"windowHours":{"type":"number","const":24},"products":{"type":"array","items":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"handle":{"type":"string","maxLength":140},"units":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["productId","handle","units"],"additionalProperties":false}}},"required":["windowHours","products"],"additionalProperties":false},"StorefrontRecentPurchases":{"type":"object","properties":{"purchases":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/RecentPurchase"}}},"required":["purchases"],"additionalProperties":false},"StorefrontResolution":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/StorefrontStore"},"themeVersionId":{"anyOf":[{"$ref":"#/components/schemas/ThemeVersionId"},{"type":"null"}]},"stockThemeId":{"type":"string"},"catalogEtag":{"type":"string"},"accentHue":{"type":"number"},"redirectTo":{"type":"string"},"redirectTemporary":{"type":"boolean"}},"required":["store","themeVersionId","stockThemeId","catalogEtag","accentHue"],"additionalProperties":false},"StorefrontReview":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ReviewId"},"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string","maxLength":120},"body":{"type":"string","maxLength":2000},"author":{"type":"string","maxLength":60},"verified":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"reply":{"default":null,"type":["string","null"]},"repliedAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"source":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"sourceLabel":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["id","rating","title","body","author","verified","createdAt","reply","repliedAt","source","sourceLabel","imageUrl"],"additionalProperties":false},"StorefrontReviewsPage":{"type":"object","properties":{"summary":{"type":"object","properties":{"average":{"type":"number","minimum":0,"maximum":5},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"distribution":{"minItems":5,"maxItems":5,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}}},"required":["average","count","distribution"],"additionalProperties":false},"reviews":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/StorefrontStoreReview"}},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"perPage":{"type":"integer","minimum":1,"maximum":50},"pageCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["summary","reviews","page","perPage","pageCount"],"additionalProperties":false},"StorefrontSearchResult":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/SearchQueryInfo"},"state":{"$ref":"#/components/schemas/SearchState"},"sort":{"$ref":"#/components/schemas/SearchSort"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"page":{"type":"integer","minimum":1,"maximum":9007199254740991},"perPage":{"type":"integer","minimum":1,"maximum":48},"pageCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"products":{"maxItems":48,"type":"array","items":{"$ref":"#/components/schemas/SearchProductHit"}},"facets":{"type":"array","items":{"$ref":"#/components/schemas/SearchFacetSchema"}},"priceRange":{"anyOf":[{"type":"object","properties":{"minMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"maxMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["minMinor","maxMinor","currency"],"additionalProperties":false},{"type":"null"}]},"collections":{"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/SearchLinkHit"}},"pages":{"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/SearchLinkHit"}},"categories":{"default":[],"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/SearchLinkHit"}},"category":{"default":null,"anyOf":[{"$ref":"#/components/schemas/SearchCategoryScope"},{"type":"null"}]},"popular":{"maxItems":8,"type":"array","items":{"type":"string"}}},"required":["query","state","sort","total","page","perPage","pageCount","products","facets","priceRange","collections","pages","categories","category","popular"],"additionalProperties":false},"StorefrontShop":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/StorefrontStore"},"promotions":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/LivePromotion"}},"collections":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontCollectionMeta"}},"pages":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontPage"}},"categories":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/StorefrontCategory"}},"stats":{"$ref":"#/components/schemas/StorefrontShopStats"},"latestReviews":{"maxItems":48,"type":"array","items":{"$ref":"#/components/schemas/StorefrontLatestReview"}},"generatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["store","promotions","collections","pages","categories","stats","latestReviews","generatedAt"],"additionalProperties":false},"StorefrontShopStats":{"type":"object","properties":{"productsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitsSold30d":{"type":"integer","minimum":0,"maximum":9007199254740991},"rating":{"type":"number","minimum":0,"maximum":5},"reviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"ratingDistribution":{"default":[0,0,0,0,0],"minItems":5,"maxItems":5,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991}}},"required":["productsCount","unitsSold30d","rating","reviewCount","ratingDistribution"],"additionalProperties":false},"StorefrontSitemapIndex":{"type":"object","properties":{"version":{"type":"string","maxLength":80},"files":{"type":"array","items":{"$ref":"#/components/schemas/SitemapFile"}},"catalogUpdatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"generatedAt":{"$ref":"#/components/schemas/Timestamp"},"buildMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["version","files","catalogUpdatedAt","generatedAt","buildMs"],"additionalProperties":false},"StorefrontSort":{"type":"string","enum":["featured","best-selling","newest","price-ascending","price-descending","title-ascending"]},"StorefrontStatus":{"type":"string","enum":["open","closed","maintenance"]},"StorefrontStockAlertStopResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true},"product":{"type":["string","null"]}},"required":["ok","product"],"additionalProperties":false},"StorefrontStore":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"handle":{"$ref":"#/components/schemas/StoreHandle"},"tagline":{"type":"string"},"supportEmail":{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},"country":{"$ref":"#/components/schemas/CountryCode"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"domain":{"type":"string"},"url":{"type":"string"},"open":{"type":"boolean"},"seo":{"$ref":"#/components/schemas/StoreSeo"},"status":{"default":"open","$ref":"#/components/schemas/StorefrontStatus"},"statusMessage":{"default":"","type":"string","maxLength":500},"brandColor":{"default":"#6e56cf","type":"string"},"logoUrl":{"default":null,"type":["string","null"]},"faviconUrl":{"default":null,"type":["string","null"]},"integrations":{"default":{"googleAnalyticsId":null,"metaPixelId":null,"clarityId":null,"crispWebsiteId":null,"tawk":null,"consentRequired":true,"trustpilotBcc":null,"gtmContainerId":null,"gtmOnCheckout":false},"$ref":"#/components/schemas/StorefrontIntegrations"},"embedOrigins":{"default":[],"type":"array","items":{"type":"string"}},"headlessOrigins":{"default":[],"type":"array","items":{"type":"string"}},"apps":{"default":{"apps":[],"popups":[],"consentFromApp":false},"$ref":"#/components/schemas/StorefrontApps"},"passwordGate":{"default":{"enabled":false,"message":"","version":0},"$ref":"#/components/schemas/StorefrontPasswordGate"},"features":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/FeatureKey"}},"timezone":{"default":"UTC","type":"string","maxLength":64},"poweredByRequired":{"default":false,"type":"boolean"},"social":{"default":null,"anyOf":[{"$ref":"#/components/schemas/StoreSocial"},{"type":"null"}]}},"required":["id","name","handle","tagline","supportEmail","country","currency","domain","url","open","status","statusMessage","brandColor","logoUrl","faviconUrl","integrations","embedOrigins","headlessOrigins","apps","passwordGate","features","timezone","poweredByRequired","social"],"additionalProperties":false},"StorefrontStoreReview":{"type":"object","properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/ReviewId"},{"$ref":"#/components/schemas/StoreReviewId"}]},"rating":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string","maxLength":120},"body":{"type":"string","maxLength":2000},"author":{"type":"string","maxLength":60},"verified":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"reply":{"type":["string","null"]},"repliedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"handle":{"type":"string","maxLength":140},"title":{"type":"string","maxLength":200}},"required":["id","handle","title"],"additionalProperties":false},{"type":"null"}]},"source":{"default":null,"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"sourceLabel":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"imageUrl":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"pinned":{"default":false,"type":"boolean"}},"required":["id","rating","title","body","author","verified","createdAt","reply","repliedAt","product","source","sourceLabel","imageUrl","pinned"],"additionalProperties":false},"StorefrontSuggest":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/SearchQueryInfo"},"products":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/SearchProductHit"}},"collections":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/SearchLinkHit"}},"pages":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/SearchLinkHit"}},"categories":{"default":[],"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/SearchLinkHit"}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"popular":{"maxItems":8,"type":"array","items":{"type":"string"}}},"required":["query","products","collections","pages","categories","total","popular"],"additionalProperties":false},"StorefrontThemeBundle":{"type":"object","properties":{"versionId":{"anyOf":[{"$ref":"#/components/schemas/ThemeVersionId"},{"type":"null"}]},"files":{"$ref":"#/components/schemas/ThemeFilesRecord"},"css":{"type":"string"},"cssHash":{"type":"string"}},"required":["versionId","files","css","cssHash"],"additionalProperties":false},"StorefrontTlsAllowedResponse":{"type":"object","properties":{"allowed":{"type":"boolean"}},"required":["allowed"],"additionalProperties":false},"StorefrontUnlockResult":{"type":"object","properties":{"ok":{"type":"boolean"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["ok","version"],"additionalProperties":false},"StorefrontVariant":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/VariantId"},"title":{"type":"string"},"description":{"type":"string"},"priceMinor":{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},"compareAtMinor":{"anyOf":[{"minimum":0,"$ref":"#/components/schemas/MinorUnits"},{"type":"null"}]},"available":{"type":"boolean"},"stock":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"lowStock":{"type":"boolean"},"paymentRules":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PaymentRules"},{"type":"null"}]}},"required":["id","title","description","priceMinor","compareAtMinor","available","stock","lowStock","paymentRules"],"additionalProperties":false},"StudioMe":{"type":"object","properties":{"developer":{"anyOf":[{"$ref":"#/components/schemas/TemplateDeveloper"},{"type":"null"}]},"invite":{"anyOf":[{"$ref":"#/components/schemas/TemplateInvite"},{"type":"null"}]},"reviewCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["developer","invite","reviewCount"],"additionalProperties":false},"SubmitReviewResponse":{"type":"object","properties":{"reviewId":{"$ref":"#/components/schemas/ReviewId"},"status":{"$ref":"#/components/schemas/ReviewStatus"}},"required":["reviewId","status"],"additionalProperties":false},"SubscriberKind":{"type":"string","enum":["email","discord"]},"SubscriberState":{"type":"string","enum":["active","trialing","past_due","cancelling","ended"]},"SubscriptionEventView":{"type":"object","properties":{"kind":{"type":"string"},"actor":{"type":"string","enum":["buyer","seller","system"]},"summary":{"type":"string"},"at":{"$ref":"#/components/schemas/Timestamp"}},"required":["kind","actor","summary","at"],"additionalProperties":false},"SubscriptionId":{"type":"string","pattern":"^sub_[0-9a-hjkmnp-tv-z]{20}$"},"SubscriptionInterval":{"type":"string","enum":["week","month","year"]},"SubscriptionSettings":{"type":"object","properties":{"interval":{"$ref":"#/components/schemas/SubscriptionInterval"},"intervalCount":{"type":"integer","minimum":1,"maximum":12},"trialDays":{"type":"integer","minimum":0,"maximum":365},"renewalReminderDays":{"type":"integer","minimum":0,"maximum":30},"cancelBehavior":{"$ref":"#/components/schemas/CancelBehavior"},"gracePeriodDays":{"type":"integer","minimum":0,"maximum":30}},"required":["interval","intervalCount","trialDays","renewalReminderDays","cancelBehavior","gracePeriodDays"],"additionalProperties":false},"SubscriptionStatus":{"type":"string","enum":["active","past_due","pending","cancelled"]},"SupportCustomerHit":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/CustomerId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"$ref":"#/components/schemas/StoreHandle"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["customerId","storeId","storeName","storeHandle","email","name","orders","createdAt"],"additionalProperties":false},"SupportLookup":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/SupportLookupKind"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/SupportOrderHit"}},"customers":{"type":"array","items":{"$ref":"#/components/schemas/SupportCustomerHit"}},"truncated":{"type":"boolean"}},"required":["kind","orders","customers","truncated"],"additionalProperties":false},"SupportLookupKind":{"type":"string","enum":["order_number","email","order_id"]},"SupportOrderHit":{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"$ref":"#/components/schemas/StoreHandle"},"buyerEmail":{"$ref":"#/components/schemas/Email"},"buyerName":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"isTest":{"type":"boolean"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["orderId","number","storeId","storeName","storeHandle","buyerEmail","buyerName","status","isTest","totalMinor","currency","createdAt","paidAt"],"additionalProperties":false},"SupportReport":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/Timestamp"},"to":{"$ref":"#/components/schemas/Timestamp"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"firstResponseMedian":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"firstResponseP90":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"resolutionMedian":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"resolutionP90":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"slaMetPct":{"type":["number","null"]},"satisfactionAvg":{"type":["number","null"]},"satisfactionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"satisfactionDist":{"minItems":5,"maxItems":5,"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"daily":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["day","created","solved"],"additionalProperties":false}},"byCategory":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"string"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["category","label","count"],"additionalProperties":false}},"byAgent":{"type":"array","items":{"type":"object","properties":{"userId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"name":{"type":"string"},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"replies":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"firstResponseMedian":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"satisfactionAvg":{"type":["number","null"]}},"required":["userId","name","solved","replies","firstResponseMedian","satisfactionAvg"],"additionalProperties":false}},"byChannel":{"type":"array","items":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/TicketChannel"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["channel","count"],"additionalProperties":false}}},"required":["from","to","created","solved","open","firstResponseMedian","firstResponseP90","resolutionMedian","resolutionP90","slaMetPct","satisfactionAvg","satisfactionCount","satisfactionDist","daily","byCategory","byAgent","byChannel"],"additionalProperties":false},"SupportSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"categories":{"minItems":1,"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/TicketCategory"}},"firstResponse":{"$ref":"#/components/schemas/SlaTargets"},"resolution":{"$ref":"#/components/schemas/SlaTargets"},"restrictToAssigned":{"type":"boolean"},"autoCloseDays":{"type":"integer","minimum":0,"maximum":90},"satisfaction":{"type":"boolean"},"widget":{"$ref":"#/components/schemas/SupportWidget"},"emailReplies":{"type":"boolean"},"attachmentMaxMb":{"type":"integer","minimum":1,"maximum":25},"autoReply":{"type":"string","maxLength":1000}},"required":["enabled","categories","firstResponse","resolution","restrictToAssigned","autoCloseDays","satisfaction","widget","emailReplies","attachmentMaxMb","autoReply"],"additionalProperties":false},"SupportUnreadResponse":{"type":"object","properties":{"unread":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["unread"],"additionalProperties":false},"SupportWidget":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"title":{"default":"Need help?","type":"string","maxLength":60},"greeting":{"default":"Send us a message and we reply by email, usually within a few hours.","type":"string","maxLength":240},"position":{"default":"right","type":"string","enum":["right","left"]},"floating":{"default":true,"type":"boolean"}},"required":["enabled","title","greeting","position","floating"],"additionalProperties":false},"SuppressionReason":{"type":"string","enum":["bounce","complaint","unsubscribe","manual"]},"SurfaceColors":{"type":"object","properties":{"mode":{"default":"theme","type":"string","enum":["theme","custom"]},"background":{"default":"#0f0f17","$ref":"#/components/schemas/HexColor"},"surface":{"default":"#17171f","$ref":"#/components/schemas/HexColor"},"text":{"default":"#f2f2f7","$ref":"#/components/schemas/HexColor"},"muted":{"default":"#9a9aa8","$ref":"#/components/schemas/HexColor"},"accent":{"default":"#7c5cff","$ref":"#/components/schemas/HexColor"},"onAccent":{"default":"#ffffff","$ref":"#/components/schemas/HexColor"}},"required":["mode","background","surface","text","muted","accent","onAccent"],"additionalProperties":false},"SyncAudienceResponse":{"type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["added","updated"],"additionalProperties":false},"TabReminderSettings":{"type":"object","properties":{"message":{"default":"Your cart is waiting","type":"string","minLength":1,"maxLength":40},"onlyWithCart":{"default":true,"type":"boolean"}},"required":["message","onlyWithCart"],"additionalProperties":false},"TawkIds":{"type":"object","properties":{"propertyId":{"type":"string","pattern":"^[0-9a-f]{24}$"},"widgetId":{"type":"string","pattern":"^[0-9a-z]{6,12}$"}},"required":["propertyId","widgetId"],"additionalProperties":false},"TaxBreakdownRow":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/VatCategory"},"rateBps":{"$ref":"#/components/schemas/Bps"},"taxableMinor":{"$ref":"#/components/schemas/MinorUnits"},"taxMinor":{"$ref":"#/components/schemas/MinorUnits"},"exemption":{"type":["string","null"]}},"required":["category","rateBps","taxableMinor","taxMinor","exemption"],"additionalProperties":false},"TaxCategory":{"type":"string","enum":["digital_goods","ebook","software","saas","online_course","membership","service","exempt"]},"TaxCategoryReview":{"type":"string","enum":["not_needed","pending","approved","declined"]},"TaxRate":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/CountryCode"},"rateBps":{"$ref":"#/components/schemas/Bps"},"label":{"type":"string","maxLength":40}},"required":["country","rateBps","label"],"additionalProperties":false},"TaxReport":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"paymentModel":{"type":"string","enum":["merchant_of_record","seller_gateway"]},"remittedBy":{"type":"string","enum":["shopfast","seller"]},"rows":{"type":"array","items":{"$ref":"#/components/schemas/TaxRow"}},"totals":{"type":"array","items":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"taxableSalesMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"taxCollectedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"taxRefundedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netTaxMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["currency","orders","taxableSalesMinor","taxCollectedMinor","taxRefundedMinor","netTaxMinor"],"additionalProperties":false}}},"required":["period","paymentModel","remittedBy","rows","totals"],"additionalProperties":false},"TaxRow":{"type":"object","properties":{"country":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"taxableSalesMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"taxCollectedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"taxRefundedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netTaxMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"effectiveRateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["country","currency","orders","taxableSalesMinor","taxCollectedMinor","taxRefundedMinor","netTaxMinor","effectiveRateBps"],"additionalProperties":false},"TeamAccessOverview":{"type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/components/schemas/AccessPolicy"}},"settings":{"$ref":"#/components/schemas/TeamAccessSettings"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/MemberAttributes"}},"departments":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}},"required":["policies","settings","attributes","departments","tags"],"additionalProperties":false},"TeamAccessSettings":{"type":"object","properties":{"require2faRoles":{"maxItems":60,"type":"array","items":{"$ref":"#/components/schemas/RoleKey"}},"inviteExpiryHours":{"type":"integer","minimum":1,"maximum":720}},"required":["require2faRoles","inviteExpiryHours"],"additionalProperties":false},"TeamInvite":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InviteId"},"email":{"$ref":"#/components/schemas/Email"},"role":{"$ref":"#/components/schemas/AssignableRole"},"customRoleId":{"anyOf":[{"$ref":"#/components/schemas/RoleId"},{"type":"null"}]},"roleName":{"type":"string"},"invitedBy":{"type":"string"},"status":{"$ref":"#/components/schemas/InviteStatus"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"department":{"default":null,"type":["string","null"]},"tags":{"default":[],"type":"array","items":{"type":"string"}},"lastSentAt":{"default":null,"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","email","role","customRoleId","roleName","invitedBy","status","createdAt","expiresAt","department","tags","lastSentAt"],"additionalProperties":false},"TeamMember":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"role":{"$ref":"#/components/schemas/MemberRoleKind"},"customRoleId":{"anyOf":[{"$ref":"#/components/schemas/RoleId"},{"type":"null"}]},"roleName":{"type":"string"},"twoFactor":{"type":"boolean"},"lastActiveAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"joinedAt":{"$ref":"#/components/schemas/Timestamp"},"isYou":{"type":"boolean"},"department":{"default":null,"type":["string","null"]},"tags":{"default":[],"type":"array","items":{"type":"string"}},"requiresTwoFactor":{"default":false,"type":"boolean"},"aiAccess":{"default":false,"type":"boolean"},"aiFromRole":{"default":false,"type":"boolean"}},"required":["userId","name","email","role","customRoleId","roleName","twoFactor","lastActiveAt","joinedAt","isYou","department","tags","requiresTwoFactor","aiAccess","aiFromRole"],"additionalProperties":false},"TeamOverview":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}},"invites":{"type":"array","items":{"$ref":"#/components/schemas/TeamInvite"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/CustomRole"}},"you":{"$ref":"#/components/schemas/StoreAccess"}},"required":["members","invites","roles","you"],"additionalProperties":false},"TelegramChatRef":{"type":"string","pattern":"^(-?\\d{5,20}|@[A-Za-z][A-Za-z0-9_]{4,31})$"},"TelegramCheckoutClaim":{"type":"object","properties":{"cartId":{"type":"string"},"itemCount":{"type":"integer","minimum":1,"maximum":9007199254740991},"username":{"type":"string"}},"required":["cartId","itemCount","username"],"additionalProperties":false},"TelegramCheckoutId":{"type":"string","pattern":"^tgc_[0-9a-hjkmnp-tv-z]{20}$"},"TelegramCheckoutOfCartResponse":{"type":"object","properties":{"username":{"type":["string","null"]}},"required":["username"],"additionalProperties":false},"TelegramCheckoutStatus":{"type":"string","enum":["open","opened","paid","expired"]},"TelegramLogEntry":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TelegramMessageId"},"direction":{"type":"string","enum":["in","out"]},"kind":{"type":"string","enum":["update","reply","delivery"]},"status":{"type":"string","enum":["received","queued","sent","simulated","skipped","failed"]},"username":{"type":["string","null"]},"text":{"type":"string"},"buttons":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":["string","null"]},"data":{"type":["string","null"]}},"required":["text","url","data"],"additionalProperties":false}}},"detail":{"type":"string"},"simulator":{"type":"boolean"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","direction","kind","status","username","text","buttons","detail","simulator","orderId","createdAt"],"additionalProperties":false},"TelegramMessageId":{"type":"string","pattern":"^tgm_[0-9a-hjkmnp-tv-z]{20}$"},"TelegramMode":{"type":"string","enum":["live","simulated"]},"TelegramOrderLinkResponse":{"type":"object","properties":{"link":{"anyOf":[{"type":"object","properties":{"botUsername":{"type":"string"},"url":{"type":"string"},"proven":{"type":"boolean"}},"required":["botUsername","url","proven"],"additionalProperties":false},{"type":"null"}]}},"required":["link"],"additionalProperties":false},"TelegramShopOverview":{"type":"object","properties":{"connected":{"type":"boolean"},"botUsername":{"type":["string","null"]},"mode":{"$ref":"#/components/schemas/TelegramMode"},"webhookUrl":{"type":["string","null"]},"webhookSetAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastUpdateAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"connectedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"settings":{"$ref":"#/components/schemas/TelegramShopSettings"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"stats":{"type":"object","properties":{"checkouts30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paid30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenue30dMinor":{"$ref":"#/components/schemas/MinorUnits"},"buyers30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"deliveries30d":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["checkouts30d","paid30d","revenue30dMinor","buyers30d","deliveries30d"],"additionalProperties":false},"checkouts":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TelegramCheckoutId"},"username":{"type":"string"},"productName":{"type":"string"},"variantName":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/TelegramCheckoutStatus"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"orderId":{"anyOf":[{"$ref":"#/components/schemas/OrderId"},{"type":"null"}]},"orderNumber":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"simulated":{"default":false,"type":"boolean"}},"required":["id","username","productName","variantName","status","priceMinor","orderId","orderNumber","createdAt","simulated"],"additionalProperties":false}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"onSale":{"type":"boolean"}},"required":["id","name","onSale"],"additionalProperties":false}},"log":{"type":"array","items":{"$ref":"#/components/schemas/TelegramLogEntry"}}},"required":["connected","botUsername","mode","webhookUrl","webhookSetAt","lastUpdateAt","connectedAt","settings","currency","stats","checkouts","products","log"],"additionalProperties":false},"TelegramShopSettings":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"deliveryMessages":{"default":true,"type":"boolean"},"hiddenProductIds":{"default":[],"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"welcome":{"default":"","type":"string","maxLength":300}},"required":["enabled","deliveryMessages","hiddenProductIds","welcome"],"additionalProperties":false},"TemplateActorKind":{"type":"string","enum":["developer","admin","system"]},"TemplateDetail":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/TemplateSummary"},"releases":{"type":"array","items":{"$ref":"#/components/schemas/TemplateReleaseSummary"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/TemplateEvent"}}},"required":["template","releases","events"],"additionalProperties":false},"TemplateDeveloper":{"type":"object","properties":{"userId":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/Email"},"kind":{"$ref":"#/components/schemas/TemplateDeveloperKind"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/TemplatePermission"}},"status":{"$ref":"#/components/schemas/TemplateDeveloperStatus"},"joinedAt":{"$ref":"#/components/schemas/Timestamp"},"templates":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["userId","name","email","kind","permissions","status","joinedAt","templates"],"additionalProperties":false},"TemplateDeveloperKind":{"type":"string","enum":["staff","partner"]},"TemplateDeveloperStatus":{"type":"string","enum":["active","suspended"]},"TemplateDiffLine":{"type":"object","properties":{"kind":{"type":"string","enum":["same","add","del"]},"text":{"type":"string","maxLength":2000}},"required":["kind","text"],"additionalProperties":false},"TemplateEvent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TemplateEventId"},"templateId":{"anyOf":[{"$ref":"#/components/schemas/TemplateSlug"},{"type":"null"}]},"releaseId":{"anyOf":[{"$ref":"#/components/schemas/TemplateReleaseId"},{"type":"null"}]},"version":{"type":["string","null"]},"action":{"$ref":"#/components/schemas/TemplateEventAction"},"actor":{"$ref":"#/components/schemas/TemplatePerson"},"summary":{"type":"string","maxLength":500},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","templateId","releaseId","version","action","actor","summary","createdAt"],"additionalProperties":false},"TemplateEventAction":{"type":"string","enum":["template.created","template.hidden","template.shown","template.reordered","template.made_default","release.started","release.files_saved","release.details_saved","release.rebased","release.submitted","release.unsubmitted","release.approved","release.changes_requested","release.withdrawn","release.discarded","release.filed_from_repo","release.imported","developer.invited","developer.joined","developer.updated","developer.suspended","developer.reactivated","invite.revoked"]},"TemplateEventId":{"type":"string","pattern":"^tpe_[0-9a-hjkmnp-tv-z]{20}$"},"TemplateFileDiff":{"type":"object","properties":{"path":{"type":"string"},"change":{"type":"string","enum":["added","removed","changed"]},"additions":{"type":"integer","minimum":0,"maximum":9007199254740991},"deletions":{"type":"integer","minimum":0,"maximum":9007199254740991},"hunks":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"oldStart":{"type":"integer","minimum":0,"maximum":9007199254740991},"oldLines":{"type":"integer","minimum":0,"maximum":9007199254740991},"newStart":{"type":"integer","minimum":0,"maximum":9007199254740991},"newLines":{"type":"integer","minimum":0,"maximum":9007199254740991},"lines":{"maxItems":2000,"type":"array","items":{"$ref":"#/components/schemas/TemplateDiffLine"}}},"required":["oldStart","oldLines","newStart","newLines","lines"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["path","change","additions","deletions","hunks","truncated"],"additionalProperties":false},"TemplateInvite":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TemplateInviteId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/TemplateDeveloperKind"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/TemplatePermission"}},"status":{"$ref":"#/components/schemas/TemplateInviteStatus"},"invitedBy":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","name","kind","permissions","status","invitedBy","createdAt","expiresAt"],"additionalProperties":false},"TemplateInviteId":{"type":"string","pattern":"^tpi_[0-9a-hjkmnp-tv-z]{20}$"},"TemplateInviteStatus":{"type":"string","enum":["pending","accepted","revoked","expired"]},"TemplateListing":{"type":"object","properties":{"order":{"default":100,"type":"integer","minimum":0,"maximum":1000},"tagline":{"default":"","type":"string","maxLength":160},"bestFor":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","minLength":1,"maxLength":40}},"presets":{"default":{},"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"type":"string","maxLength":200}},"template":{"default":null,"anyOf":[{"type":"object","properties":{"concept":{"type":"string","maxLength":200},"styles":{"maxItems":6,"type":"array","items":{"type":"string","maxLength":30}},"industries":{"maxItems":6,"type":"array","items":{"type":"string","maxLength":30}},"fonts":{"type":"object","properties":{"display":{"type":"string","maxLength":40},"body":{"type":"string","maxLength":40},"mono":{"type":"string","maxLength":40}},"required":["display","body","mono"],"additionalProperties":false},"motion":{"type":"string","maxLength":200},"mode":{"type":"string","enum":["dark","light"]}},"required":["concept","styles","industries","fonts","motion","mode"],"additionalProperties":false},{"type":"null"}]}},"required":["order","tagline","bestFor","presets","template"],"additionalProperties":false},"TemplateNoteKind":{"type":"string","enum":["new","improved","fixed"]},"TemplateOrigin":{"type":"string","enum":["builtin","partner"]},"TemplatePath":{"type":"string","pattern":"^templates\\/[a-z0-9-]+(?:\\.[a-z][a-z0-9_-]{0,39})?\\.json$"},"TemplatePermission":{"type":"string","enum":["create","edit_builtin","review"]},"TemplatePerson":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/TemplateActorKind"},"userId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"name":{"type":"string"}},"required":["kind","userId","name"],"additionalProperties":false},"TemplatePreview":{"type":"object","properties":{"releaseId":{"$ref":"#/components/schemas/TemplateReleaseId"},"version":{"$ref":"#/components/schemas/SemVer"},"status":{"$ref":"#/components/schemas/TemplateReleaseStatus"},"page":{"$ref":"#/components/schemas/TemplatePreviewPage"},"html":{"type":"string"}},"required":["releaseId","version","status","page","html"],"additionalProperties":false},"TemplatePreviewPage":{"type":"string","enum":["index","product","collection"]},"TemplateReleaseAbilities":{"type":"object","properties":{"edit":{"type":"boolean"},"submit":{"type":"boolean"},"unsubmit":{"type":"boolean"},"review":{"type":"boolean"},"reviewBlockedBy":{"type":["string","null"]},"withdraw":{"type":"boolean"},"discard":{"type":"boolean"}},"required":["edit","submit","unsubmit","review","reviewBlockedBy","withdraw","discard"],"additionalProperties":false},"TemplateReleaseDetail":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/TemplateSummary"},"release":{"$ref":"#/components/schemas/TemplateReleaseSummary"},"listing":{"$ref":"#/components/schemas/TemplateListing"},"files":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}},"can":{"$ref":"#/components/schemas/TemplateReleaseAbilities"},"behind":{"anyOf":[{"type":"object","properties":{"releaseId":{"$ref":"#/components/schemas/TemplateReleaseId"},"version":{"$ref":"#/components/schemas/SemVer"}},"required":["releaseId","version"],"additionalProperties":false},{"type":"null"}]},"contributors":{"type":"array","items":{"$ref":"#/components/schemas/TemplatePerson"}}},"required":["template","release","listing","files","issues","can","behind","contributors"],"additionalProperties":false},"TemplateReleaseDiff":{"type":"object","properties":{"from":{"anyOf":[{"type":"object","properties":{"releaseId":{"$ref":"#/components/schemas/TemplateReleaseId"},"version":{"$ref":"#/components/schemas/SemVer"}},"required":["releaseId","version"],"additionalProperties":false},{"type":"null"}]},"to":{"type":"object","properties":{"releaseId":{"$ref":"#/components/schemas/TemplateReleaseId"},"version":{"$ref":"#/components/schemas/SemVer"}},"required":["releaseId","version"],"additionalProperties":false},"files":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/TemplateFileDiff"}},"additions":{"type":"integer","minimum":0,"maximum":9007199254740991},"deletions":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["from","to","files","additions","deletions"],"additionalProperties":false},"TemplateReleaseId":{"type":"string","pattern":"^tpr_[0-9a-hjkmnp-tv-z]{20}$"},"TemplateReleaseNotes":{"type":"object","properties":{"title":{"default":"","type":"string","maxLength":120},"items":{"default":[],"maxItems":40,"type":"array","items":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/TemplateNoteKind"},"text":{"type":"string","minLength":1,"maxLength":300},"templates":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":60}}},"required":["kind","text","templates"],"additionalProperties":false}},"addedSections":{"default":[],"maxItems":40,"type":"array","items":{"type":"string","maxLength":40}},"changedSettings":{"default":[],"maxItems":80,"type":"array","items":{"type":"string","maxLength":40}},"visualNotes":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":300}},"thumbnails":{"default":[],"maxItems":6,"type":"array","items":{"type":"string","maxLength":60}}},"required":["title","items","addedSections","changedSettings","visualNotes","thumbnails"],"additionalProperties":false},"TemplateReleaseSource":{"type":"string","enum":["studio","repo"]},"TemplateReleaseStatus":{"type":"string","enum":["draft","in_review","changes_requested","released","withdrawn"]},"TemplateReleaseSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TemplateReleaseId"},"templateId":{"$ref":"#/components/schemas/TemplateSlug"},"version":{"$ref":"#/components/schemas/SemVer"},"status":{"$ref":"#/components/schemas/TemplateReleaseStatus"},"source":{"$ref":"#/components/schemas/TemplateReleaseSource"},"filesRecorded":{"type":"boolean"},"notes":{"$ref":"#/components/schemas/TemplateReleaseNotes"},"base":{"anyOf":[{"type":"object","properties":{"releaseId":{"$ref":"#/components/schemas/TemplateReleaseId"},"version":{"$ref":"#/components/schemas/SemVer"},"filesRecorded":{"default":true,"type":"boolean"}},"required":["releaseId","version","filesRecorded"],"additionalProperties":false},{"type":"null"}]},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"author":{"anyOf":[{"$ref":"#/components/schemas/TemplatePerson"},{"type":"null"}]},"submittedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"reviewedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"reviewedBy":{"anyOf":[{"$ref":"#/components/schemas/TemplatePerson"},{"type":"null"}]},"reviewNote":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"releasedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"withdrawnAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"withdrawnBy":{"anyOf":[{"$ref":"#/components/schemas/TemplatePerson"},{"type":"null"}]},"withdrawReason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"changedFiles":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","templateId","version","status","source","filesRecorded","notes","base","revision","author","submittedAt","reviewedAt","reviewedBy","reviewNote","releasedAt","withdrawnAt","withdrawnBy","withdrawReason","changedFiles","createdAt","updatedAt"],"additionalProperties":false},"TemplateSlug":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,39}$"},"TemplateSuffix":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"TemplateSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TemplateSlug"},"name":{"type":"string"},"origin":{"$ref":"#/components/schemas/TemplateOrigin"},"owner":{"anyOf":[{"$ref":"#/components/schemas/TemplatePerson"},{"type":"null"}]},"hidden":{"type":"boolean"},"galleryPosition":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"isDefault":{"type":"boolean"},"current":{"anyOf":[{"type":"object","properties":{"releaseId":{"$ref":"#/components/schemas/TemplateReleaseId"},"version":{"$ref":"#/components/schemas/SemVer"},"releasedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["releaseId","version","releasedAt"],"additionalProperties":false},{"type":"null"}]},"open":{"anyOf":[{"type":"object","properties":{"releaseId":{"$ref":"#/components/schemas/TemplateReleaseId"},"version":{"$ref":"#/components/schemas/SemVer"},"status":{"$ref":"#/components/schemas/TemplateReleaseStatus"}},"required":["releaseId","version","status"],"additionalProperties":false},{"type":"null"}]},"installs":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"canEdit":{"type":"boolean"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","origin","owner","hidden","galleryPosition","isDefault","current","open","installs","canEdit","updatedAt"],"additionalProperties":false},"TemplateTeam":{"type":"object","properties":{"developers":{"type":"array","items":{"$ref":"#/components/schemas/TemplateDeveloper"}},"invites":{"type":"array","items":{"$ref":"#/components/schemas/TemplateInvite"}}},"required":["developers","invites"],"additionalProperties":false},"TestAppResponse":{"type":"object","properties":{"status":{"type":"string","enum":["sent","failed","simulated"]},"detail":{"type":"string"}},"required":["status","detail"],"additionalProperties":false},"TestBroadcastResponse":{"type":"object","properties":{"sentTo":{"type":"string"}},"required":["sentTo"],"additionalProperties":false},"TestCampaignResponse":{"type":"object","properties":{"sent":{"type":"array","items":{"type":"string"}}},"required":["sent"],"additionalProperties":false},"TestEmailDocumentResponse":{"type":"object","properties":{"to":{"type":"string"},"subject":{"type":"string"}},"required":["to","subject"],"additionalProperties":false},"TestPluginResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/PluginTestResult"}},"diagnostics":{"type":"array","items":{"$ref":"#/components/schemas/PluginDiagnostic"}}},"required":["results","diagnostics"],"additionalProperties":false},"TextBlock":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,24}$"},"type":{"type":"string","const":"text"},"text":{"type":"string","maxLength":6000},"align":{"default":"left","type":"string","enum":["left","center","right"]},"size":{"default":"md","type":"string","enum":["sm","md","lg"]}},"required":["id","type","text","align","size"],"additionalProperties":false},"ThemeAiHistory":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ThemeAiHistoryItem"}}},"required":["items"],"additionalProperties":false},"ThemeAiHistoryItem":{"type":"object","properties":{"turnId":{"$ref":"#/components/schemas/AiTurnId"},"conversationId":{"$ref":"#/components/schemas/AiConversationId"},"prompt":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url","name"],"additionalProperties":false}},"summary":{"type":["string","null"]},"changes":{"type":"integer","minimum":0,"maximum":9007199254740991},"decision":{"anyOf":[{"$ref":"#/components/schemas/AiProposalDecision"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/AiTurnStatus"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["turnId","conversationId","prompt","images","summary","changes","decision","status","createdAt"],"additionalProperties":false},"ThemeAiProposal":{"type":"object","properties":{"summary":{"type":"string","maxLength":400},"ops":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/ThemeOp"}},"explanations":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":300}},"notes":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":300}},"model":{"type":"string"},"proposalId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/AiProposalId"},{"type":"null"}]},"conversationId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/AiConversationId"},{"type":"null"}]},"turnId":{"default":null,"anyOf":[{"$ref":"#/components/schemas/AiTurnId"},{"type":"null"}]}},"required":["summary","ops","explanations","notes","model","proposalId","conversationId","turnId"],"additionalProperties":false},"ThemeAsset":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ThemeAssetId"},"themeId":{"$ref":"#/components/schemas/ThemeId"},"name":{"$ref":"#/components/schemas/ThemeAssetName"},"url":{"type":"string"},"contentType":{"type":"string"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","themeId","name","url","contentType","bytes","width","height","createdAt"],"additionalProperties":false},"ThemeAssetId":{"type":"string","pattern":"^tha_[0-9a-hjkmnp-tv-z]{20}$"},"ThemeAssetName":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,59}\\.(?:png|jpe?g|webp|gif)$"},"ThemeAuthor":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ThemeAuthorKind"},"userId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"name":{"type":["string","null"]}},"required":["kind","userId","name"],"additionalProperties":false},"ThemeAuthorKind":{"type":"string","enum":["seller","ai","code","system","restore"]},"ThemeChangelogEntry":{"type":"object","properties":{"version":{"type":"string"},"date":{"type":"string"},"title":{"type":"string","maxLength":120},"items":{"maxItems":40,"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["new","improved","fixed"]},"text":{"type":"string","maxLength":300},"templates":{"maxItems":20,"type":"array","items":{"type":"string"}}},"required":["kind","text","templates"],"additionalProperties":false}},"addedSections":{"maxItems":40,"type":"array","items":{"type":"string"}},"changedSettings":{"maxItems":80,"type":"array","items":{"type":"string"}},"visualNotes":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":300}},"thumbnails":{"maxItems":6,"type":"array","items":{"type":"object","properties":{"template":{"type":"string"}},"required":["template"],"additionalProperties":false}}},"required":["version","date","title","items","addedSections","changedSettings","visualNotes","thumbnails"],"additionalProperties":false},"ThemeDraft":{"type":"object","properties":{"theme":{"$ref":"#/components/schemas/ThemeSummary"},"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"files":{"$ref":"#/components/schemas/ThemeFilesRecord"},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}}},"required":["theme","revision","files","issues"],"additionalProperties":false},"ThemeFilePathString":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z]+\\/[A-Za-z0-9_.-]+$"},"ThemeFilesRecord":{"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeFilePathString"},"additionalProperties":{"type":"string","maxLength":300000}},"ThemeId":{"type":"string","pattern":"^thm_[0-9a-hjkmnp-tv-z]{20}$"},"ThemeImportPreview":{"type":"object","properties":{"package":{"$ref":"#/components/schemas/ThemeSharePackage"},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}},"expiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"diff":{"default":[],"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"change":{"type":"string","enum":["added","changed","removed","same"]},"linesAdded":{"type":"integer","minimum":0,"maximum":9007199254740991},"linesRemoved":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["path","change","linesAdded","linesRemoved"],"additionalProperties":false}},"verified":{"default":false,"type":"boolean"},"dropped":{"default":[],"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"reason":{"type":"string","maxLength":300}},"required":["path","reason"],"additionalProperties":false}}},"required":["package","issues","expiresAt","diff","verified","dropped"],"additionalProperties":false},"ThemeInstanceId":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,47}$"},"ThemeIssue":{"type":"object","properties":{"path":{"type":"string"},"line":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"column":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"severity":{"type":"string","enum":["error","warning"]},"code":{"type":"string"},"message":{"type":"string"}},"required":["path","line","column","severity","code","message"],"additionalProperties":false},"ThemeLook":{"type":"object","properties":{"background":{"$ref":"#/components/schemas/HexColor"},"surface":{"$ref":"#/components/schemas/HexColor"},"text":{"$ref":"#/components/schemas/HexColor"},"muted":{"$ref":"#/components/schemas/HexColor"},"accent":{"$ref":"#/components/schemas/HexColor"},"onAccent":{"$ref":"#/components/schemas/HexColor"},"radius":{"type":"number","minimum":0,"maximum":40},"fontBody":{"type":"string","maxLength":40},"fontHeading":{"type":"string","maxLength":40},"fontMono":{"type":"string","maxLength":40}},"required":["background","surface","text","muted","accent","onAccent","radius","fontBody","fontHeading","fontMono"],"additionalProperties":false},"ThemeOp":{"oneOf":[{"type":"object","properties":{"op":{"type":"string","const":"set_section_setting"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"key":{"$ref":"#/components/schemas/ThemeSettingId"},"value":{"$ref":"#/components/schemas/ThemeSettingValue"}},"required":["op","file","section","key","value"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_block_setting"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"block":{"$ref":"#/components/schemas/ThemeInstanceId"},"key":{"$ref":"#/components/schemas/ThemeSettingId"},"value":{"$ref":"#/components/schemas/ThemeSettingValue"}},"required":["op","file","section","block","key","value"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"add_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"type":{"$ref":"#/components/schemas/ThemeTypeName"},"position":{"$ref":"#/components/schemas/ThemePosition"},"preset":{"default":null,"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"id":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ThemeInstanceId"},{"type":"null"}]},"settings":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeSettingId"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}}},"required":["op","file","type","position","preset","id","settings"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"remove_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"}},"required":["op","file","section"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"move_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"position":{"$ref":"#/components/schemas/ThemePosition"}},"required":["op","file","section","position"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"duplicate_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"id":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ThemeInstanceId"},{"type":"null"}]}},"required":["op","file","section","id"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_section_disabled"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"disabled":{"type":"boolean"}},"required":["op","file","section","disabled"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"add_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"type":{"$ref":"#/components/schemas/ThemeTypeName"},"position":{"$ref":"#/components/schemas/ThemePosition"},"id":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ThemeInstanceId"},{"type":"null"}]},"settings":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeSettingId"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}}},"required":["op","file","section","type","position","id","settings"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"remove_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"block":{"$ref":"#/components/schemas/ThemeInstanceId"}},"required":["op","file","section","block"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"move_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"block":{"$ref":"#/components/schemas/ThemeInstanceId"},"position":{"$ref":"#/components/schemas/ThemePosition"}},"required":["op","file","section","block","position"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_block_disabled"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"block":{"$ref":"#/components/schemas/ThemeInstanceId"},"disabled":{"type":"boolean"}},"required":["op","file","section","block","disabled"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"duplicate_block"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"section":{"$ref":"#/components/schemas/ThemeInstanceId"},"block":{"$ref":"#/components/schemas/ThemeInstanceId"},"id":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ThemeInstanceId"},{"type":"null"}]}},"required":["op","file","section","block","id"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"insert_section"},"file":{"type":"string","pattern":"^(?:templates\\/[a-z0-9][a-z0-9_.-]{0,80}\\.json|sections\\/[a-z][a-z0-9_-]{0,39}\\.json)$"},"position":{"$ref":"#/components/schemas/ThemePosition"},"id":{"default":null,"anyOf":[{"$ref":"#/components/schemas/ThemeInstanceId"},{"type":"null"}]},"section":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ThemeTypeName"},"settings":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeSettingId"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}},"disabled":{"default":false,"type":"boolean"},"blocks":{"default":[],"maxItems":50,"type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ThemeTypeName"},"settings":{"default":{},"type":"object","propertyNames":{"$ref":"#/components/schemas/ThemeSettingId"},"additionalProperties":{"$ref":"#/components/schemas/ThemeSettingValue"}},"disabled":{"default":false,"type":"boolean"}},"required":["type","settings","disabled"],"additionalProperties":false}}},"required":["type","settings","disabled","blocks"],"additionalProperties":false}},"required":["op","file","position","id","section"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_theme_setting"},"key":{"$ref":"#/components/schemas/ThemeSettingId"},"value":{"$ref":"#/components/schemas/ThemeSettingValue"}},"required":["op","key","value"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"apply_style_preset"},"preset":{"type":"string","minLength":1,"maxLength":60}},"required":["op","preset"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"set_translation"},"locale":{"type":"string","pattern":"^[a-z]{2}(?:-[A-Z]{2})?$"},"key":{"type":"string","pattern":"^[a-z0-9_]{1,60}(?:\\.[a-z0-9_]{1,60}){0,4}$"},"value":{"type":"string","maxLength":2000}},"required":["op","locale","key","value"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"write_file"},"path":{"$ref":"#/components/schemas/ThemeFilePathString"},"content":{"type":"string","maxLength":300000}},"required":["op","path","content"],"additionalProperties":false},{"type":"object","properties":{"op":{"type":"string","const":"delete_file"},"path":{"$ref":"#/components/schemas/ThemeFilePathString"}},"required":["op","path"],"additionalProperties":false}]},"ThemePosition":{"anyOf":[{"type":"object","properties":{"after":{"$ref":"#/components/schemas/ThemeInstanceId"}},"required":["after"],"additionalProperties":false},{"type":"object","properties":{"before":{"$ref":"#/components/schemas/ThemeInstanceId"}},"required":["before"],"additionalProperties":false},{"type":"string","enum":["start","end"]}]},"ThemeRevisionSummary":{"type":"object","properties":{"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"author":{"$ref":"#/components/schemas/ThemeAuthor"},"summary":{"type":"string","maxLength":200},"prompt":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["revision","author","summary","prompt","createdAt"],"additionalProperties":false},"ThemeRole":{"type":"string","enum":["live","unpublished"]},"ThemeSaveResult":{"type":"object","properties":{"revision":{"type":"integer","minimum":0,"maximum":9007199254740991},"changedFiles":{"type":"array","items":{"type":"string"}},"patches":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"ops":{"type":"array","items":{"$ref":"#/components/schemas/JsonPatchOp"}}},"required":["path","ops"],"additionalProperties":false}},"createdIds":{"type":"array","items":{"type":"string"}},"issues":{"type":"array","items":{"$ref":"#/components/schemas/ThemeIssue"}},"hasUnpublishedChanges":{"type":"boolean"}},"required":["revision","changedFiles","patches","createdIds","issues","hasUnpublishedChanges"],"additionalProperties":false},"ThemeSettingId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$"},"ThemeSettingValue":{"anyOf":[{"type":"string","maxLength":20000},{"type":"number"},{"type":"boolean"},{"type":"null"},{"maxItems":50,"type":"array","items":{"type":"string","maxLength":200}}]},"ThemeShare":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/ThemeShareCode"},"scope":{"$ref":"#/components/schemas/ThemeShareScope"},"name":{"type":"string","maxLength":80},"stockId":{"type":"string"},"fileCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"package":{"$ref":"#/components/schemas/ThemeSharePackage"}},"required":["code","scope","name","stockId","fileCount","bytes","createdAt","expiresAt","package"],"additionalProperties":false},"ThemeShareCode":{"type":"string","pattern":"^SF(?:-[2-9A-HJ-NP-Z]{4}){3}$"},"ThemeSharePackage":{"type":"object","properties":{"format":{"type":"string","const":"shopfast-theme@1"},"kind":{"type":"string","enum":["theme","template"]},"name":{"type":"string","minLength":1,"maxLength":80},"stockId":{"type":"string","maxLength":40},"stockVersion":{"type":"string","maxLength":20},"sourceStore":{"type":"string","maxLength":80},"exportedAt":{"$ref":"#/components/schemas/Timestamp"},"files":{"$ref":"#/components/schemas/ThemeFilesRecord"},"signature":{"type":"string","maxLength":200}},"required":["format","kind","name","stockId","stockVersion","sourceStore","exportedAt","files"],"additionalProperties":false},"ThemeShareScope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"theme"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"template"},"path":{"$ref":"#/components/schemas/TemplatePath"}},"required":["kind","path"],"additionalProperties":false}]},"ThemeSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ThemeId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string","minLength":1,"maxLength":60},"role":{"$ref":"#/components/schemas/ThemeRole"},"stock":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}},"required":["id","name","version"],"additionalProperties":false},"preset":{"type":["string","null"]},"draftRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"draftUpdatedAt":{"$ref":"#/components/schemas/Timestamp"},"draftUpdatedBy":{"$ref":"#/components/schemas/ThemeAuthor"},"hasUnpublishedChanges":{"type":"boolean"},"latestVersion":{"anyOf":[{"$ref":"#/components/schemas/ThemeVersionSummary"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"update":{"default":null,"anyOf":[{"type":"object","properties":{"available":{"type":"boolean","const":true},"fromVersion":{"type":"string"},"toVersion":{"type":"string"},"title":{"type":"string"},"draft":{"default":true,"type":"boolean"},"live":{"default":false,"type":"boolean"},"liveFromVersion":{"default":null,"type":["string","null"]}},"required":["available","fromVersion","toVersion","title","draft","live","liveFromVersion"],"additionalProperties":false},{"type":"null"}]},"unrequested":{"default":null,"anyOf":[{"type":"object","properties":{"versionId":{"$ref":"#/components/schemas/ThemeVersionId"},"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"name":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"previous":{"anyOf":[{"type":"object","properties":{"versionId":{"$ref":"#/components/schemas/ThemeVersionId"},"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"name":{"type":"string"}},"required":["versionId","number","name"],"additionalProperties":false},{"type":"null"}]},"draftUntouched":{"type":"boolean"}},"required":["versionId","number","name","createdAt","previous","draftUntouched"],"additionalProperties":false},{"type":"null"}]}},"required":["id","storeId","name","role","stock","preset","draftRevision","draftUpdatedAt","draftUpdatedBy","hasUnpublishedChanges","latestVersion","createdAt","update","unrequested"],"additionalProperties":false},"ThemeTemplate":{"type":"object","properties":{"path":{"type":"string"},"type":{"type":"string"},"suffix":{"anyOf":[{"$ref":"#/components/schemas/TemplateSuffix"},{"type":"null"}]},"sections":{"type":"integer","minimum":0,"maximum":9007199254740991},"valid":{"type":"boolean"},"assignable":{"type":"boolean"},"usage":{"type":"object","properties":{"products":{"type":"integer","minimum":0,"maximum":9007199254740991},"collections":{"type":"integer","minimum":0,"maximum":9007199254740991},"pages":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["products","collections","pages"],"additionalProperties":false}},"required":["path","type","suffix","sections","valid","assignable","usage"],"additionalProperties":false},"ThemeTypeName":{"type":"string","pattern":"^[a-z][a-z0-9_-]{0,39}$"},"ThemeUpdateConflict":{"type":"object","properties":{"path":{"type":"string"},"line":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"message":{"type":"string","maxLength":300},"ours":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"theirs":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"base":{"default":null,"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]}},"required":["path","line","message","ours","theirs","base"],"additionalProperties":false},"ThemeUpdateOutcome":{"type":"string","enum":["updated","added","removed","merged","conflict","kept"]},"ThemeUpdatePreview":{"type":"object","properties":{"themeId":{"$ref":"#/components/schemas/ThemeId"},"stockId":{"type":"string"},"stockName":{"type":"string"},"target":{"default":"draft","$ref":"#/components/schemas/ThemeUpdateTarget"},"fromVersion":{"type":"string"},"toVersion":{"type":"string"},"targets":{"default":null,"anyOf":[{"type":"object","properties":{"draft":{"type":"object","properties":{"fromVersion":{"type":"string"},"available":{"type":"boolean"}},"required":["fromVersion","available"],"additionalProperties":false},"live":{"anyOf":[{"type":"object","properties":{"fromVersion":{"type":"string"},"available":{"type":"boolean"}},"required":["fromVersion","available"],"additionalProperties":false},{"type":"null"}]}},"required":["draft","live"],"additionalProperties":false},{"type":"null"}]},"available":{"type":"boolean"},"base":{"type":"string","enum":["snapshot","install_revision","none"]},"files":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"outcome":{"$ref":"#/components/schemas/ThemeUpdateOutcome"},"conflicts":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["path","outcome","conflicts"],"additionalProperties":false}},"conflicts":{"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/ThemeUpdateConflict"}},"changelog":{"default":[],"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/ThemeChangelogEntry"}},"mergedFiles":{"default":null,"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","null"]}},{"type":"null"}]}},"required":["themeId","stockId","stockName","target","fromVersion","toVersion","targets","available","base","files","conflicts","changelog","mergedFiles"],"additionalProperties":false},"ThemeUpdateTarget":{"type":"string","enum":["draft","live"]},"ThemeVersionId":{"type":"string","pattern":"^thv_[0-9a-hjkmnp-tv-z]{20}$"},"ThemeVersionSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ThemeVersionId"},"themeId":{"$ref":"#/components/schemas/ThemeId"},"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"name":{"type":"string","maxLength":80},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"createdBy":{"$ref":"#/components/schemas/ThemeAuthor"},"isLive":{"type":"boolean"},"changedFiles":{"maxItems":200,"type":"array","items":{"type":"string"}},"cssHash":{"type":"string"},"stockVersion":{"default":null,"type":["string","null"]},"unrequested":{"default":false,"type":"boolean"},"acknowledged":{"default":false,"type":"boolean"}},"required":["id","themeId","number","name","createdAt","createdBy","isLive","changedFiles","cssHash","stockVersion","unrequested","acknowledged"],"additionalProperties":false},"TicketAttachment":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketAttachmentId"},"filename":{"type":"string"},"contentType":{"type":"string"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991},"url":{"type":"string"},"isImage":{"type":"boolean"}},"required":["id","filename","contentType","bytes","url","isImage"],"additionalProperties":false},"TicketAttachmentId":{"type":"string","pattern":"^tatt_[0-9a-hjkmnp-tv-z]{20}$"},"TicketAuthorKind":{"type":"string","enum":["customer","agent","system"]},"TicketCategory":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9_-]{1,32}$"},"label":{"type":"string","minLength":1,"maxLength":60}},"required":["id","label"],"additionalProperties":false},"TicketChannel":{"type":"string","enum":["web","widget","order","email","dashboard","discord"]},"TicketCounts":{"type":"object","properties":{"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mine":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unassigned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"breached":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"solved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["open","mine","unassigned","pending","breached","solved","all"],"additionalProperties":false},"TicketCustomerContext":{"type":"object","properties":{"verified":{"default":true,"type":"boolean"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"name":{"type":"string"},"email":{"type":"string"},"country":{"type":["string","null"]},"since":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"ordersCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spentMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"blocked":{"type":"boolean"},"risk":{"type":"object","properties":{"level":{"type":"string","enum":["low","medium","high","unknown"]},"score":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"lastCheck":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"reasons":{"type":"array","items":{"type":"string"}}},"required":["level","score","lastCheck","reasons"],"additionalProperties":false},"orders":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"status":{"type":"string"},"totalMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedMinor":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"items":{"type":"array","items":{"type":"string"}},"keys":{"type":"array","items":{"type":"object","properties":{"product":{"type":"string"},"masked":{"type":"string"}},"required":["product","masked"],"additionalProperties":false}},"linked":{"type":"boolean"}},"required":["id","number","status","totalMinor","refundedMinor","createdAt","items","keys","linked"],"additionalProperties":false}},"otherTickets":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","number","subject","status","createdAt"],"additionalProperties":false}},"disputes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["verified","customerId","name","email","country","since","ordersCount","spentMinor","refundedMinor","currency","tags","blocked","risk","orders","otherTickets","disputes"],"additionalProperties":false},"TicketDetail":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/TicketSummary"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/TicketMessage"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/TicketEvent"}},"customer":{"$ref":"#/components/schemas/TicketCustomerContext"},"replyAddress":{"type":["string","null"]},"mergedInto":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","number"],"additionalProperties":false},{"type":"null"}]},"satisfactionComment":{"type":["string","null"]},"firstResponseAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"resolvedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"viewers":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"discordThreadUrl":{"default":null,"type":["string","null"]}},"required":["ticket","messages","events","customer","replyAddress","mergedInto","satisfactionComment","firstResponseAt","resolvedAt","viewers","discordThreadUrl"],"additionalProperties":false},"TicketEvent":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketEventId"},"kind":{"$ref":"#/components/schemas/TicketEventKind"},"actorName":{"type":"string"},"summary":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","kind","actorName","summary","createdAt"],"additionalProperties":false},"TicketEventId":{"type":"string","pattern":"^tev_[0-9a-hjkmnp-tv-z]{20}$"},"TicketEventKind":{"type":"string","enum":["created","status","priority","assigned","tags","category","merged","merged_into","sla_breached","rated","subject","discord"]},"TicketId":{"type":"string","pattern":"^tkt_[0-9a-hjkmnp-tv-z]{20}$"},"TicketMessage":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketMessageId"},"author":{"$ref":"#/components/schemas/TicketAuthorKind"},"authorName":{"type":"string"},"authorUserId":{"anyOf":[{"$ref":"#/components/schemas/UserId"},{"type":"null"}]},"body":{"type":"string"},"internal":{"type":"boolean"},"via":{"$ref":"#/components/schemas/TicketChannel"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/TicketAttachment"}},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","author","authorName","authorUserId","body","internal","via","attachments","createdAt"],"additionalProperties":false},"TicketMessageId":{"type":"string","pattern":"^tmsg_[0-9a-hjkmnp-tv-z]{20}$"},"TicketPresenceResponse":{"type":"object","properties":{"viewers":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"},"typing":{"type":"boolean"}},"required":["id","name","typing"],"additionalProperties":false}}},"required":["viewers"],"additionalProperties":false},"TicketPriority":{"type":"string","enum":["low","normal","high","urgent"]},"TicketStatus":{"type":"string","enum":["open","pending","on_hold","solved","closed"]},"TicketSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TicketId"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"subject":{"type":"string"},"status":{"$ref":"#/components/schemas/TicketStatus"},"priority":{"$ref":"#/components/schemas/TicketPriority"},"category":{"type":["string","null"]},"channel":{"$ref":"#/components/schemas/TicketChannel"},"requesterName":{"type":"string"},"requesterEmail":{"type":"string"},"customerId":{"anyOf":[{"$ref":"#/components/schemas/CustomerId"},{"type":"null"}]},"assignee":{"anyOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"preview":{"type":"string"},"unread":{"type":"boolean"},"messageCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderNumber":{"type":["string","null"]},"firstResponseDueAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"resolutionDueAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"sla":{"$ref":"#/components/schemas/SlaState"},"satisfaction":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}]},"lastMessageAt":{"$ref":"#/components/schemas/Timestamp"},"lastMessageFrom":{"$ref":"#/components/schemas/TicketAuthorKind"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","number","subject","status","priority","category","channel","requesterName","requesterEmail","customerId","assignee","tags","preview","unread","messageCount","orderNumber","firstResponseDueAt","resolutionDueAt","sla","satisfaction","lastMessageAt","lastMessageFrom","createdAt"],"additionalProperties":false},"TieredRule":{"type":"object","properties":{"type":{"type":"string","const":"tiered"},"basis":{"type":"string","enum":["quantity","subtotal"]},"tiers":{"minItems":1,"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/DiscountTier"}}},"required":["type","basis","tiers"],"additionalProperties":false},"TikTokPixelId":{"type":"string","pattern":"^[A-Z0-9]{15,25}$"},"TikTokPixelSettings":{"type":"object","properties":{"pixelId":{"default":"","anyOf":[{"type":"string","const":""},{"$ref":"#/components/schemas/TikTokPixelId"}]},"ecommerce":{"default":true,"type":"boolean"}},"required":["pixelId","ecommerce"],"additionalProperties":false},"TimeZone":{"type":"string","minLength":1,"maxLength":64},"TimeZoneName":{"type":"string","minLength":1,"maxLength":64},"Timestamp":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"TipSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"presets":{"default":[5,10,20],"minItems":1,"maxItems":4,"type":"array","items":{"type":"integer","minimum":1,"maximum":100}},"allowCustom":{"default":true,"type":"boolean"},"heading":{"default":"Add a tip","type":"string","minLength":1,"maxLength":60},"note":{"default":"Tips go to the creator in full.","type":"string","maxLength":160},"maxMinor":{"default":50000,"type":"integer","minimum":100,"maximum":10000000,"$ref":"#/components/schemas/MinorUnits"}},"required":["enabled","presets","allowCustom","heading","note","maxMinor"],"additionalProperties":false},"TotpSetup":{"type":"object","properties":{"secret":{"type":"string"},"otpauthUrl":{"type":"string"}},"required":["secret","otpauthUrl"],"additionalProperties":false},"TourId":{"type":"string","enum":["first-product","theme","payments","discord","webhooks","plugins"]},"TourProgress":{"type":"object","properties":{"tour":{"$ref":"#/components/schemas/TourId"},"status":{"$ref":"#/components/schemas/TourStatus"},"step":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"achieved":{"type":"boolean"}},"required":["tour","status","step","updatedAt","achieved"],"additionalProperties":false},"TourStatus":{"type":"string","enum":["not_started","active","done","skipped"]},"TrackVisitResponse":{"type":"object","properties":{"ref":{"anyOf":[{"type":"object","properties":{"code":{"type":"string"},"cookieDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["code","cookieDays"],"additionalProperties":false},{"type":"null"}]}},"required":["ref"],"additionalProperties":false},"TrafficAnalytics":{"type":"object","properties":{"range":{"$ref":"#/components/schemas/GrowthRange"},"from":{"$ref":"#/components/schemas/IsoDate"},"to":{"$ref":"#/components/schemas/IsoDate"},"period":{"$ref":"#/components/schemas/AnalyticsPeriod"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"totals":{"type":"object","properties":{"visitors":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"visits":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"pageViews":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"productViews":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"checkouts":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"orders":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"conversionBps":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"checkoutRateBps":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"bounceRateBps":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false},"pagesPerVisitor":{"type":"object","properties":{"value":{"type":"number"},"previous":{"type":"number"}},"required":["value","previous"],"additionalProperties":false}},"required":["visitors","visits","pageViews","productViews","checkouts","orders","conversionBps","checkoutRateBps","bounceRateBps","pagesPerVisitor"],"additionalProperties":false},"funnel":{"type":"object","properties":{"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"productViewers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cartAdders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"checkoutStarters":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["visitors","productViewers","cartAdders","checkoutStarters","orders"],"additionalProperties":false},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/IsoDate"},"hour":{"anyOf":[{"type":"integer","minimum":0,"maximum":23},{"type":"null"}]},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"productViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"checkouts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","hour","visitors","pageViews","productViews","checkouts","orders"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"medium":{"type":"string"},"visits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"},"conversionBps":{"$ref":"#/components/schemas/Bps"}},"required":["source","medium","visits","orders","revenueMinor","conversionBps"],"additionalProperties":false}},"referrers":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string"},"visits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["host","visits"],"additionalProperties":false}},"landingPages":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"visits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","visits"],"additionalProperties":false}},"pages":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"entries":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["path","views","entries"],"additionalProperties":false}},"devices":{"type":"array","items":{"type":"object","properties":{"device":{"$ref":"#/components/schemas/VisitorDevice"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["device","visitors"],"additionalProperties":false}},"browsers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","visitors"],"additionalProperties":false}},"systems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","visitors"],"additionalProperties":false}},"countries":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"visitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["country","visitors","orders","revenueMinor"],"additionalProperties":false}}},"required":["range","from","to","period","currency","totals","funnel","daily","sources","referrers","landingPages","pages","devices","browsers","systems","countries"],"additionalProperties":false},"TrafficClass":{"type":"string","enum":["human","verified_bot","declared_bot","spoofed_bot","suspicious"]},"TrialNext":{"type":"object","properties":{"planId":{"$ref":"#/components/schemas/PlanId"},"planName":{"type":"string"},"monthlyPriceMinor":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string"},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"willStart":{"type":"boolean"}},"required":["planId","planName","monthlyPriceMinor","currency","startsAt","willStart"],"additionalProperties":false},"TrustBadge":{"type":"string","enum":["secure","instant","refund","support"]},"TrustBadgesSettings":{"type":"object","properties":{"badges":{"default":["instant_delivery","secure_checkout","support"],"minItems":1,"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/AppTrustBadge"}},"placement":{"default":"product","type":"string","enum":["product","product_and_cart"]},"style":{"default":"row","type":"string","enum":["row","cards"]}},"required":["badges","placement","style"],"additionalProperties":false},"TrustboxTemplate":{"type":"string","enum":["micro_combo","micro_star","micro_review_count","mini"]},"TrustpilotSettings":{"type":"object","properties":{"businessUnitId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^[a-f0-9]{24}$"}]},"template":{"default":"micro_combo","$ref":"#/components/schemas/TrustboxTemplate"},"customTemplateId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^[a-f0-9]{24}$"}]},"reviewUrl":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","maxLength":300,"pattern":"^https:\\/\\/(?:[a-z]{2,3}\\.)?trustpilot\\.com\\/review\\/[\\w.-]{3,120}$"}]},"placement":{"default":"product_and_footer","type":"string","enum":["product","footer","product_and_footer"]},"theme":{"default":"dark","type":"string","enum":["light","dark"]}},"required":["businessUnitId","template","customTemplateId","reviewUrl","placement","theme"],"additionalProperties":false},"UnmatchedPayment":{"type":"object","properties":{"receivedAt":{"$ref":"#/components/schemas/Timestamp"},"amountMinor":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"type":["string","null"]},"note":{"type":["string","null"]},"sender":{"type":["string","null"]},"paymentId":{"type":["string","null"]},"reason":{"type":"string"}},"required":["receivedAt","amountMinor","currency","note","sender","paymentId","reason"],"additionalProperties":false},"UpdateCategoryResponse":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/Category"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}},"required":["category","categories"],"additionalProperties":false},"UpdateGiftCardResponse":{"type":"object","properties":{"giftCard":{"$ref":"#/components/schemas/GiftCard"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardTransaction"}}},"required":["giftCard","transactions"],"additionalProperties":false},"UpdateManualMethodResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ManualMethodId"},"name":{"type":"string"},"instructions":{"type":"string"},"enabled":{"type":"boolean"},"payWithinHours":{"type":"integer","minimum":1,"maximum":720},"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"awaiting":{"type":"integer","minimum":0,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paymentModel":{"default":null,"anyOf":[{"$ref":"#/components/schemas/PaymentModel"},{"type":"null"}]},"switchedToOwn":{"default":false,"type":"boolean"}},"required":["id","name","instructions","enabled","payWithinHours","position","awaiting","createdAt","paymentModel","switchedToOwn"],"additionalProperties":false},"UpdateMarketingSettingsResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/MarketingSettings"}},"required":["settings"],"additionalProperties":false},"UpdateProductStatusesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductStatusRow"}},"changed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["items","changed"],"additionalProperties":false},"UpdateResellerProgramResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ResellerSettings"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/ResellerTier"}},"applyUrl":{"type":"string"}},"required":["settings","tiers","applyUrl"],"additionalProperties":false},"UpdateSupportOffer":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"heading":{"type":"string"},"message":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"minimumMinor":{"$ref":"#/components/schemas/MinorUnits"},"suggestedMinor":{"$ref":"#/components/schemas/MinorUnits"},"givenMinor":{"$ref":"#/components/schemas/MinorUnits"}},"required":["productId","productName","heading","message","currency","minimumMinor","suggestedMinor","givenMinor"],"additionalProperties":false},"UpdateSupportSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"minimumMinor":{"default":0,"type":"integer","minimum":0,"maximum":10000000,"$ref":"#/components/schemas/MinorUnits"},"suggestedMinor":{"default":500,"type":"integer","minimum":0,"maximum":10000000,"$ref":"#/components/schemas/MinorUnits"},"heading":{"default":"Support the next update","type":"string","minLength":1,"maxLength":60},"message":{"default":"Like the updates? Chip in what you want. You keep everything you own either way.","type":"string","maxLength":240},"renewalPwyw":{"default":false,"type":"boolean"},"renewalMinimumPct":{"default":50,"type":"integer","minimum":0,"maximum":100}},"required":["enabled","minimumMinor","suggestedMinor","heading","message","renewalPwyw","renewalMinimumPct"],"additionalProperties":false},"UpdateSupportSettingsResponse":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/SupportSettings"}},"required":["settings"],"additionalProperties":false},"UploadPurpose":{"type":"string","enum":["media","file","image","asset"]},"UploadTicket":{"type":"object","properties":{"uploadId":{"$ref":"#/components/schemas/MediaAssetId"},"url":{"type":"string"},"method":{"type":"string","const":"PUT"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"maxBytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["uploadId","url","method","headers","expiresAt","maxBytes"],"additionalProperties":false},"UploadedAsset":{"type":"object","properties":{"uploadId":{"$ref":"#/components/schemas/MediaAssetId"},"purpose":{"$ref":"#/components/schemas/UploadPurpose"},"filename":{"type":"string"},"contentType":{"type":"string"},"bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"url":{"type":["string","null"]},"width":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"height":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"sha256":{"type":["string","null"]}},"required":["uploadId","purpose","filename","contentType","bytes","url","width","height","sha256"],"additionalProperties":false},"UptimeDay":{"type":"object","properties":{"day":{"type":"string"},"uptime":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"worst":{"anyOf":[{"$ref":"#/components/schemas/StatusSeverity"},{"type":"null"}]},"labelId":{"anyOf":[{"$ref":"#/components/schemas/StatusLabelId"},{"type":"null"}]}},"required":["day","uptime","worst","labelId"],"additionalProperties":false},"User":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UserId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string","minLength":1,"maxLength":120},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"emailVerifiedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","email","name","createdAt","emailVerifiedAt"],"additionalProperties":false},"UserActivityPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ActivityItem"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]},"stores":{"type":"array","items":{"$ref":"#/components/schemas/ActivityStoreRef"}},"exclusion":{"$ref":"#/components/schemas/RecordingExclusion"}},"required":["items","nextCursor","stores","exclusion"],"additionalProperties":false},"UserId":{"type":"string","pattern":"^usr_[0-9a-hjkmnp-tv-z]{20}$"},"UserJourney":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/Timestamp"},"to":{"$ref":"#/components/schemas/Timestamp"},"totals":{"type":"object","properties":{"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"clicks":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"activeMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"medianSessionMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recordings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["sessions","pageViews","clicks","activeMs","medianSessionMs","recordings"],"additionalProperties":false},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageViews":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["day","sessions","pageViews"],"additionalProperties":false}},"topPages":{"type":"array","items":{"type":"object","properties":{"route":{"$ref":"#/components/schemas/DashboardRoute"},"views":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"avgMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"exits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["route","views","avgMs","exits"],"additionalProperties":false}},"dropOffs":{"type":"array","items":{"type":"object","properties":{"route":{"$ref":"#/components/schemas/DashboardRoute"},"exits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"share":{"type":"number"}},"required":["route","exits","share"],"additionalProperties":false}},"paths":{"type":"array","items":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/DashboardRoute"},"to":{"$ref":"#/components/schemas/DashboardRoute"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["from","to","count"],"additionalProperties":false}},"devices":{"type":"array","items":{"type":"object","properties":{"device":{"$ref":"#/components/schemas/DeviceClass"},"sessions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["device","sessions"],"additionalProperties":false}},"lastSeenAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"exclusion":{"$ref":"#/components/schemas/RecordingExclusion"}},"required":["from","to","totals","days","topPages","dropOffs","paths","devices","lastSeenAt","exclusion"],"additionalProperties":false},"UserSessionsPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ActivitySessionWithSteps"}},"nextCursor":{"anyOf":[{"$ref":"#/components/schemas/Cursor"},{"type":"null"}]}},"required":["items","nextCursor"],"additionalProperties":false},"VariantId":{"type":"string","pattern":"^var_[0-9a-hjkmnp-tv-z]{20}$"},"VatCategory":{"type":"string","enum":["S","Z","E","AE","O"]},"VerifiedMember":{"type":"object","properties":{"discordUserId":{"$ref":"#/components/schemas/DiscordObjectId"},"username":{"type":"string"},"globalName":{"type":["string","null"]},"source":{"type":"string","enum":["verified","seller"]},"accountCreatedAt":{"$ref":"#/components/schemas/Timestamp"},"verifiedAt":{"$ref":"#/components/schemas/Timestamp"},"grant":{"$ref":"#/components/schemas/CommunityGrantState"},"tokenExpiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"grantCheckedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"server":{"type":"string","enum":["in","left","unknown"]},"leftAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"sameNetwork":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"consentVersion":{"type":["string","null"]}},"required":["discordUserId","username","globalName","source","accountCreatedAt","verifiedAt","grant","tokenExpiresAt","grantCheckedAt","server","leftAt","sameNetwork","consentVersion"],"additionalProperties":false},"VerifyEmailResponse":{"type":"object","properties":{"ok":{"type":"boolean","const":true}},"required":["ok"],"additionalProperties":false},"ViewCustomer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomerId"},"email":{"$ref":"#/components/schemas/Email"},"name":{"type":"string"},"country":{"type":"string"},"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spentMinor":{"$ref":"#/components/schemas/MinorUnits"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","email","name","country","orders","spentMinor","createdAt"],"additionalProperties":false},"ViewOrder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"number":{"type":"string"},"buyerEmail":{"$ref":"#/components/schemas/Email"},"buyerName":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"isTest":{"type":"boolean"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"paidAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","number","buyerEmail","buyerName","status","isTest","totalMinor","currency","items","createdAt","paidAt"],"additionalProperties":false},"ViewProduct":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"status":{"$ref":"#/components/schemas/ProductStatus"},"priceMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"stock":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"updatedAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","name","type","status","priceMinor","currency","stock","updatedAt"],"additionalProperties":false},"ViewSession":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ViewSessionId"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"type":"string"},"storeHandle":{"$ref":"#/components/schemas/StoreHandle"},"admin":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/AdminUserId"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"reason":{"type":"string"},"startedAt":{"$ref":"#/components/schemas/Timestamp"},"expiresAt":{"$ref":"#/components/schemas/Timestamp"},"endedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"active":{"type":"boolean"},"isYours":{"type":"boolean"}},"required":["id","storeId","storeName","storeHandle","admin","reason","startedAt","expiresAt","endedAt","active","isYours"],"additionalProperties":false},"ViewSessionId":{"type":"string","pattern":"^avs_[0-9a-hjkmnp-tv-z]{20}$"},"ViewSnapshot":{"type":"object","properties":{"session":{"$ref":"#/components/schemas/ViewSession"},"settings":{"$ref":"#/components/schemas/ViewStoreSettings"},"counts":{"type":"object","properties":{"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"products":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["orders","products","customers"],"additionalProperties":false},"orders":{"type":"array","items":{"$ref":"#/components/schemas/ViewOrder"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ViewProduct"}},"customers":{"type":"array","items":{"$ref":"#/components/schemas/ViewCustomer"}}},"required":["session","settings","counts","orders","products","customers"],"additionalProperties":false},"ViewStoreSettings":{"type":"object","properties":{"name":{"type":"string"},"handle":{"$ref":"#/components/schemas/StoreHandle"},"domain":{"type":"string"},"customDomain":{"type":["string","null"]},"supportEmail":{"type":["string","null"]},"country":{"$ref":"#/components/schemas/CountryCode"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"paymentModel":{"$ref":"#/components/schemas/PaymentModel"},"planName":{"type":"string"},"status":{"type":"string","enum":["active","suspended"]},"statusReason":{"type":["string","null"]},"ownerEmail":{"$ref":"#/components/schemas/Email"},"ownerName":{"type":"string"},"ownerId":{"$ref":"#/components/schemas/UserId"},"members":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["name","handle","domain","customDomain","supportEmail","country","currency","paymentModel","planName","status","statusReason","ownerEmail","ownerName","ownerId","members","createdAt"],"additionalProperties":false},"VisitorDevice":{"type":"string","enum":["desktop","mobile","tablet","bot","unknown"]},"VpnPolicy":{"type":"string","enum":["allow","review","block"]},"WarrantySettings":{"type":"object","properties":{"days":{"anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"terms":{"type":"string","maxLength":1000}},"required":["days","terms"],"additionalProperties":false},"WatermarkKind":{"type":"string","enum":["pdf","image","archive","text"]},"WatermarkLabel":{"type":"string","enum":["email","order","code"]},"WatermarkSettings":{"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"pdf":{"default":true,"type":"boolean"},"image":{"default":true,"type":"boolean"},"archive":{"default":true,"type":"boolean"},"text":{"default":true,"type":"boolean"},"label":{"default":"email","$ref":"#/components/schemas/WatermarkLabel"}},"required":["enabled","pdf","image","archive","text","label"],"additionalProperties":false},"WebhookAttempt":{"type":"object","properties":{"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"at":{"$ref":"#/components/schemas/Timestamp"},"responseStatus":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"error":{"type":["string","null"]},"responseHeaders":{"type":"array","items":{"type":"array","prefixItems":[{"type":"string"},{"type":"string"}],"items":false,"minItems":2,"maxItems":2}},"responseBody":{"type":"string"}},"required":["number","at","responseStatus","durationMs","error","responseHeaders","responseBody"],"additionalProperties":false},"WebhookDelivery":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/WebhookDeliveryId"},"endpointId":{"$ref":"#/components/schemas/WebhookEndpointId"},"endpointUrl":{"type":"string"},"messageId":{"$ref":"#/components/schemas/WebhookMessageId"},"eventType":{"type":"string"},"status":{"$ref":"#/components/schemas/WebhookDeliveryStatus"},"attempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAttemptAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastResponseStatus":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"lastDurationMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"replayOf":{"anyOf":[{"$ref":"#/components/schemas/WebhookDeliveryId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["id","endpointId","endpointUrl","messageId","eventType","status","attempts","nextAttemptAt","lastResponseStatus","lastDurationMs","replayOf","createdAt","finishedAt"],"additionalProperties":false},"WebhookDeliveryDetail":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/WebhookDeliveryId"},"endpointId":{"$ref":"#/components/schemas/WebhookEndpointId"},"endpointUrl":{"type":"string"},"messageId":{"$ref":"#/components/schemas/WebhookMessageId"},"eventType":{"type":"string"},"status":{"$ref":"#/components/schemas/WebhookDeliveryStatus"},"attempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAttemptAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastResponseStatus":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"lastDurationMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"replayOf":{"anyOf":[{"$ref":"#/components/schemas/WebhookDeliveryId"},{"type":"null"}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"finishedAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"request":{"type":"object","properties":{"url":{"type":"string"},"headers":{"type":"array","items":{"type":"array","prefixItems":[{"type":"string"},{"type":"string"}],"items":false,"minItems":2,"maxItems":2}},"body":{"type":"string"}},"required":["url","headers","body"],"additionalProperties":false},"attemptLog":{"type":"array","items":{"$ref":"#/components/schemas/WebhookAttempt"}}},"required":["id","endpointId","endpointUrl","messageId","eventType","status","attempts","nextAttemptAt","lastResponseStatus","lastDurationMs","replayOf","createdAt","finishedAt","request","attemptLog"],"additionalProperties":false},"WebhookDeliveryId":{"type":"string","pattern":"^whd_[0-9a-hjkmnp-tv-z]{20}$"},"WebhookDeliveryStatus":{"type":"string","enum":["pending","retrying","succeeded","failed"]},"WebhookEndpoint":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/WebhookEndpointId"},"url":{"type":"string"},"description":{"type":"string","maxLength":200},"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventType"}},"status":{"$ref":"#/components/schemas/WebhookEndpointStatus"},"disabledReason":{"anyOf":[{"type":"string","enum":["manual","failing"]},{"type":"null"}]},"secretHint":{"type":"string"},"previousSecretExpiresAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"health":{"type":"object","properties":{"lastDeliveryAt":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]},"lastResponseStatus":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"successRate7d":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"deliveries7d":{"type":"integer","minimum":0,"maximum":9007199254740991},"consecutiveFailures":{"type":"integer","minimum":0,"maximum":9007199254740991},"failingSince":{"anyOf":[{"$ref":"#/components/schemas/Timestamp"},{"type":"null"}]}},"required":["lastDeliveryAt","lastResponseStatus","successRate7d","deliveries7d","consecutiveFailures","failingSince"],"additionalProperties":false},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"transformerPluginId":{"default":null,"anyOf":[{"type":"string","pattern":"^plg_[0-9a-hjkmnp-tv-z]{20}$"},{"type":"null"}]}},"required":["id","url","description","events","status","disabledReason","secretHint","previousSecretExpiresAt","health","createdAt","updatedAt","transformerPluginId"],"additionalProperties":false},"WebhookEndpointId":{"type":"string","pattern":"^we_[0-9a-hjkmnp-tv-z]{20}$"},"WebhookEndpointStatus":{"type":"string","enum":["enabled","disabled"]},"WebhookEventType":{"type":"string","enum":["order.created","order.paid","order.fulfilled","order.needs_attention","order.refunded","dispute.created","dispute.updated","dispute.closed","subscription.created","subscription.renewed","subscription.canceled","subscription.expired","product.created","product.updated","product.deleted","inventory.low","inventory.depleted","customer.created","review.created","discount.redeemed","payout.paid","theme.published","domain.verified","gift_card.created","gift_card.updated","gift_card.redeemed","discount.created","discount.updated","discount.deleted","team.member_joined","team.member_updated","team.member_removed","license.activated","license.device_reset","license.extended","license.expiring","license.expired","license.revoked","license.compensated","product.sales_paused","product.sales_resumed","license.replaced","subscription.renewal_failed","storefront.updated"]},"WebhookMessageId":{"type":"string","pattern":"^msg_[0-9a-hjkmnp-tv-z]{20}$"},"Weekday":{"type":"string","enum":["mon","tue","wed","thu","fri","sat","sun"]},"WholesaleApiCatalogResponse":{"type":"object","properties":{"currency":{"type":"string"},"tierName":{"type":"string"},"discountBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"items":{"type":"array","items":{"$ref":"#/components/schemas/WholesaleCatalogItem"}}},"required":["currency","tierName","discountBps","items"],"additionalProperties":false},"WholesaleApiOrder":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerOrderId"},"productId":{"$ref":"#/components/schemas/ProductId"},"productName":{"type":"string"},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unitPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"status":{"$ref":"#/components/schemas/WholesaleOrderStatus"},"payWith":{"$ref":"#/components/schemas/WholesalePayWith"},"payUrl":{"type":["string","null"]},"orderNumber":{"type":["string","null"]},"keysDelivered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reference":{"type":["string","null"]},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","productId","productName","quantity","unitPriceMinor","totalMinor","currency","status","payWith","payUrl","orderNumber","keysDelivered","reference","createdAt"],"additionalProperties":false},"WholesaleApiOrdersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WholesaleApiOrder"}}},"required":["items"],"additionalProperties":false},"WholesaleCatalog":{"type":"object","properties":{"storeName":{"type":"string"},"reseller":{"type":"object","properties":{"name":{"type":"string"},"company":{"type":"string"},"tierName":{"type":"string"},"discountBps":{"$ref":"#/components/schemas/Bps"},"minQuantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","company","tierName","discountBps","minQuantity"],"additionalProperties":false},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"listPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"wholesalePriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"stock":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","name","type","listPriceMinor","wholesalePriceMinor","stock"],"additionalProperties":false}},"orders":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerOrderId"},"productName":{"type":"string"},"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalMinor":{"$ref":"#/components/schemas/MinorUnits"},"status":{"$ref":"#/components/schemas/ResellerOrderStatus"},"payPath":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/Timestamp"}},"required":["id","productName","quantity","totalMinor","status","payPath","createdAt"],"additionalProperties":false}}},"required":["storeName","reseller","currency","products","orders"],"additionalProperties":false},"WholesaleCatalogItem":{"type":"object","properties":{"productId":{"$ref":"#/components/schemas/ProductId"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ProductType"},"listPriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"wholesalePriceMinor":{"$ref":"#/components/schemas/MinorUnits"},"stock":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"minQuantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["productId","name","type","listPriceMinor","wholesalePriceMinor","stock","minQuantity"],"additionalProperties":false},"WholesaleKeys":{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/ResellerOrderId"},"keys":{"type":"array","items":{"type":"object","properties":{"productName":{"type":"string"},"value":{"type":"string"}},"required":["productName","value"],"additionalProperties":false}}},"required":["orderId","keys"],"additionalProperties":false},"WholesaleMe":{"type":"object","properties":{"store":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StoreId"},"name":{"type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["id","name","currency"],"additionalProperties":false},"reseller":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerId"},"name":{"type":"string"},"company":{"type":"string"},"tierName":{"type":"string"},"discountBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minQuantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","company","tierName","discountBps","minQuantity"],"additionalProperties":false},"balance":{"type":"object","properties":{"storeCreditMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["storeCreditMinor","currency"],"additionalProperties":false},"key":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResellerApiKeyId"},"name":{"type":"string"},"scopes":{"type":"array","items":{"$ref":"#/components/schemas/ResellerApiScope"}}},"required":["id","name","scopes"],"additionalProperties":false},"rateLimit":{"type":"object","properties":{"perMinute":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["perMinute"],"additionalProperties":false}},"required":["store","reseller","balance","key","rateLimit"],"additionalProperties":false},"WholesaleOrderResponse":{"type":"object","properties":{"resellerOrderId":{"$ref":"#/components/schemas/ResellerOrderId"},"sessionId":{"$ref":"#/components/schemas/CheckoutSessionId"},"payPath":{"type":"string"}},"required":["resellerOrderId","sessionId","payPath"],"additionalProperties":false},"WholesaleOrderStatus":{"type":"string","enum":["awaiting_payment","paid","fulfilled","cancelled"]},"WholesalePanel":{"type":"object","properties":{"balance":{"type":"object","properties":{"storeCreditMinor":{"$ref":"#/components/schemas/MinorUnits"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["storeCreditMinor","currency"],"additionalProperties":false},"stats":{"type":"object","properties":{"orders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"units":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spentMinor":{"$ref":"#/components/schemas/MinorUnits"},"keysDelivered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["orders","units","spentMinor","keysDelivered"],"additionalProperties":false},"orders":{"type":"array","items":{"$ref":"#/components/schemas/WholesaleApiOrder"}},"keys":{"type":"array","items":{"$ref":"#/components/schemas/ResellerApiKey"}},"webhook":{"anyOf":[{"$ref":"#/components/schemas/ResellerWebhook"},{"type":"null"}]},"deliveries":{"type":"array","items":{"$ref":"#/components/schemas/ResellerWebhookDelivery"}},"calls":{"type":"array","items":{"$ref":"#/components/schemas/ResellerApiCall"}},"apiBase":{"type":"string"},"docsUrl":{"type":"string"}},"required":["balance","stats","orders","keys","webhook","deliveries","calls","apiBase","docsUrl"],"additionalProperties":false},"WholesalePanelCreateKeyResponse":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/ResellerApiKey"},"secret":{"type":"string"}},"required":["key","secret"],"additionalProperties":false},"WholesalePayWith":{"type":"string","enum":["checkout","store_credit"]},"WholesaleProgramPublicResponse":{"type":"object","properties":{"storeName":{"type":"string"},"enabled":{"type":"boolean"},"pitch":{"type":"string"},"tiers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"discountBps":{"$ref":"#/components/schemas/Bps"},"minQuantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","discountBps","minQuantity"],"additionalProperties":false}}},"required":["storeName","enabled","pitch","tiers"],"additionalProperties":false},"WishlistSettings":{"type":"object","properties":{"saveLabel":{"default":"Save for later","type":"string","minLength":1,"maxLength":30},"savedLabel":{"default":"Saved","type":"string","minLength":1,"maxLength":30},"listLabel":{"default":"Saved","type":"string","minLength":1,"maxLength":30},"position":{"default":"bottom-right","type":"string","enum":["bottom-left","bottom-right"]},"showList":{"default":true,"type":"boolean"}},"required":["saveLabel","savedLabel","listLabel","position","showList"],"additionalProperties":false},"WithdrawCommunityVerificationResponse":{"type":"object","properties":{"withdrawn":{"type":"boolean"}},"required":["withdrawn"],"additionalProperties":false},"XPixelSettings":{"type":"object","properties":{"pixelId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^[a-z0-9]{5,10}$"}]},"purchaseEventId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^tw-[a-z0-9]{5,10}-[a-z0-9]{5,10}$"}]},"addToCartEventId":{"default":"","anyOf":[{"type":"string","const":""},{"type":"string","pattern":"^tw-[a-z0-9]{5,10}-[a-z0-9]{5,10}$"}]}},"required":["pixelId","purchaseEventId","addToCartEventId"],"additionalProperties":false},"XpubCheck":{"type":"object","properties":{"ok":{"type":"boolean"},"scriptType":{"type":["string","null"]},"addresses":{"type":"array","items":{"type":"string"}},"error":{"type":["string","null"]}},"required":["ok","scriptType","addresses","error"],"additionalProperties":false},"YearsSelling":{"type":"string","enum":["new","under_1","1_3","3_plus"]},"ZoneDnsRecord":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/DnsRecordId"},"type":{"type":"string"},"name":{"type":"string"},"host":{"type":"string"},"content":{"type":"string"},"ttl":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"proxied":{"type":"boolean"},"managed":{"type":"boolean"},"input":{"anyOf":[{"$ref":"#/components/schemas/ZoneDnsRecordInput"},{"type":"null"}]}},"required":["id","type","name","host","content","ttl","proxied","managed","input"],"additionalProperties":false},"ZoneDnsRecordInput":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","const":"A"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv4","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","ttl"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"AAAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","format":"ipv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","ttl"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9_](?:[a-z0-9_-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","ttl"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"MX"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9_](?:[a-z0-9_-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"priority":{"type":"integer","minimum":0,"maximum":65535},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","priority","ttl"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"content":{"type":"string","minLength":1,"maxLength":2048,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","content","ttl"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"SRV"},"name":{"type":"string","pattern":"^_[a-z0-9-]+\\._(?:tcp|udp|tls)(?:\\..+)?$"},"priority":{"type":"integer","minimum":0,"maximum":65535},"weight":{"type":"integer","minimum":0,"maximum":65535},"port":{"type":"integer","minimum":0,"maximum":65535},"target":{"type":"string","maxLength":253,"pattern":"^(?:[a-z0-9_](?:[a-z0-9_-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","priority","weight","port","target","ttl"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"CAA"},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^(?:@|\\*|(?:\\*\\.)?[a-z0-9_](?:[a-z0-9_.-]*[a-z0-9_])?)$"},"flags":{"default":0,"anyOf":[{"type":"number","const":0},{"type":"number","const":128}]},"tag":{"type":"string","enum":["issue","issuewild","iodef"]},"value":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7e]+$"},"ttl":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","flags","tag","value","ttl"],"additionalProperties":false}]},"ZoneDnsRecords":{"type":"object","properties":{"zone":{"type":"string"},"managedHosts":{"type":"array","items":{"type":"string"}},"records":{"type":"array","items":{"$ref":"#/components/schemas/ZoneDnsRecord"}}},"required":["zone","managedHosts","records"],"additionalProperties":false}},"responses":{"Unauthorized":{"description":"No valid session cookie or API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Forbidden":{"description":"Your role, or the API key's scopes, do not cover this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"NotFound":{"description":"Not found. A store you are not a member of looks the same as one that does not exist.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Invalid":{"description":"The params, query or body failed validation. `fields` lists each problem by dotted path.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"TooManyRequests":{"description":"Rate limited. Retry after the `Retry-After` header.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Problem":{"description":"An RFC 9457 problem document.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"securitySchemes":{"sellerSession":{"type":"apiKey","in":"cookie","name":"__Host-sf_session","description":"The dashboard session cookie, set by POST /v1/auth/login."},"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"sk_live_…, sk_test_… or sfo_…","description":"A store API key from Settings → Developers, or an OAuth access token. Either names its store, so /v1/store/… needs no store id."},"adminSession":{"type":"apiKey","in":"cookie","name":"__Host-sf_admin_session","description":"Platform admin session cookie."}}}}