{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"StateSet","colors":{"primary":"#1854D8","light":"#9ABBFF","dark":"#1854D8"},"logo":{"light":"https://mintcdn.com/stateset/4wTHkssFeA2M0XSV/logo/stateset28.svg?fit=max\u0026auto=format\u0026n=4wTHkssFeA2M0XSV\u0026q=85\u0026s=24804c100796a1bf65ec331da17e6d35","dark":"https://mintcdn.com/stateset/JA8nckTOtvEhuHo_/logo/stateset-dark.svg?fit=max\u0026auto=format\u0026n=JA8nckTOtvEhuHo_\u0026q=85\u0026s=65eb9e8c70dcd90948e7767e33664716","href":"https://docs.stateset.com"},"favicon":"https://mintcdn.com/stateset/-A-d_TFUEdlnuegX/logo/favicon.png?fit=max\u0026auto=format\u0026n=-A-d_TFUEdlnuegX\u0026q=85\u0026s=0104c780f4ff026e880a05450e1156b0","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.stateset.com"}},"background":{"color":{"light":"#FFFFFF","dark":"#101827"}},"navbar":{"links":[{"href":"https://stateset.com/contact-us","label":"Talk to us"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.stateset.com"}},"footer":{"socials":{"x":"https://x.com/stateset","github":"https://github.com/stateset","linkedin":"https://www.linkedin.com/company/stateset"},"links":[{"header":"Explore","items":[{"label":"Sandbox","href":"https://sandbox.stateset.com"},{"label":"ResponseCX","href":"https://response.cx"},{"label":"Console","href":"https://console.stateset.com"}]},{"header":"Resources","items":[{"label":"Customers","href":"https://stateset.com/customers"},{"label":"Blog","href":"https://stateset.com/blog"},{"label":"Pricing","href":"https://stateset.com/pricing"},{"label":"Contact support","href":"https://stateset.com/support"},{"label":"Glossary","href":"https://www.stateset.com/glossary/icommerce/glossary"},{"label":"Status","href":"https://stateset.com/status"}]},{"header":"Company","items":[{"label":"Careers","href":"https://stateset.com/careers"},{"label":"FAQs","href":"https://stateset.com/faqs"},{"label":"Community","href":"https://discord.gg/VfcaqgZywq"},{"label":"Newsletter","href":"https://stateofmind.beehiiv.com/"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://stateset.com/privacy"},{"label":"Terms of Service","href":"https://stateset.com/terms"},{"label":"Trust Center","href":"https://trust.stateset.com"}]}]},"search":{"prompt":"Search guides, APIs, and MCP tools…"},"seo":{"metatags":{"og:type":"website","og:site_name":"StateSet API Docs","og:title":"StateSet API Docs","og:description":"Documentation for the StateSet iCommerce Engine — the execution layer for AI commerce. APIs, SDKs, MCP servers and skills for every service.","twitter:card":"summary_large_image","twitter:site":"@stateset"},"indexing":"all"},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"errors":{"404":{"redirect":false,"title":"This page does not exist","description":"It may have been retired — 376 old URLs redirect automatically, but you found one that doesn't. Try the [API router](/api-reference/introduction) to find the right surface, [host status](/api-reference/hosts) if a service seems missing, or [Getting Help](/support)."}},"contextual":{"options":["copy","chatgpt","claude","cursor"],"display":"header"},"thumbnails":{"appearance":"dark"},"interaction":{"drilldown":false},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/stateset"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stateset","hasAudioNarration":false,"actualSubdomain":"stateset","customDomains":["docs.stateset.com"],"gitSource":{"type":"github","owner":"stateset","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b007b04a22d9093f0bb676c","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1570},{"language":"default","tag":"iCommerce","count":482},{"language":"default","tag":"Platform docs","count":317},{"language":"default","tag":"NSR","count":264},{"language":"default","tag":"Learn \u0026 build","count":238},{"language":"default","tag":"EDI","count":204},{"language":"default","tag":"Temporal Engine","count":182},{"language":"default","tag":"Financials","count":97},{"language":"default","tag":"Computer Use","count":92},{"language":"default","tag":"Orders \u0026 Customers","count":88}],"searchSettings":{"maxResults":8}},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--ss-page: #ffffff;--ss-ink: #15243b;--ss-muted: #4e6078;--ss-line: #dce4ef;--ss-surface: #f5f8fd;--ss-accent: #1854d8}.dark{--ss-page: #101827;--ss-ink: #edf3ff;--ss-muted: #b0bfd4;--ss-line: #304057;--ss-surface: #182337;--ss-accent: #9abbff}html,body{background-color:var(--ss-page)}#navbar{border-bottom-color:var(--ss-line)}#search-bar-entry{border-color:var(--ss-line);border-radius:12px}#sidebar a{transition:background-color 140ms ease, color 140ms ease}#content-area h1{letter-spacing:-0.035em;text-wrap:balance}#content-area h2{letter-spacing:-0.025em}#content-area h3{letter-spacing:-0.015em}#content-area :is(a,button,[role=\"link\"]):focus-visible,#sidebar :is(a,button):focus-visible,#navbar :is(a,button):focus-visible,#footer :is(a,button):focus-visible{outline:3px solid var(--ss-accent);outline-offset:4px}#content-area .card{border-color:var(--ss-line);border-radius:16px;box-shadow:0 2px 5px rgb(15 35 65 / 3%);transition:border-color 160ms ease, box-shadow 160ms ease}#content-area .card:hover{border-color:var(--ss-accent);box-shadow:0 6px 20px rgb(15 35 65 / 7%)}#content-area th{background:var(--ss-surface)}#content-area :is(th,td){border-bottom-color:var(--ss-line)}.ss-home-actions{display:flex;flex-wrap:wrap;align-items:center;gap:0.75rem 1.5rem;margin:0 0 1.75rem}.ss-eyebrow{display:block;font-size:0.75rem;font-weight:700;letter-spacing:0.08em;color:var(--ss-accent)}#content-area .ss-primary-link,#content-area .ss-secondary-link{display:inline-flex;align-items:center;gap:0.75rem;font-size:0.875rem;font-weight:600;text-decoration:none;border-bottom:0}#content-area .ss-primary-link{padding:0.7rem 1rem;border-radius:10px;background:#1854d8;color:#fff}#content-area .ss-primary-link:hover{background:#1244b7}#content-area .ss-secondary-link{color:var(--ss-accent)}#content-area .ss-secondary-link:hover{text-decoration:underline;text-underline-offset:4px}.ss-reference-strip{display:flex;flex-wrap:wrap;gap:0.5rem 1rem;margin:1.25rem 0 2rem;padding:1rem 1.25rem;background:var(--ss-surface);border:1px solid var(--ss-line);border-radius:12px;font-size:0.875rem}.ss-reference-strip>span{flex-basis:100%;font-weight:600;color:var(--ss-muted)}.ss-operation-map{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));margin:1.5rem 0 2.5rem;border:1px solid var(--ss-line);border-radius:16px;background:var(--ss-surface)}.ss-operation-map>div{padding:1.25rem}.ss-operation-map>div+div{border-left:1px solid var(--ss-line)}.ss-operation-map strong{display:block;margin-top:0.65rem;font-size:0.95rem;color:var(--ss-ink)}#content-area .ss-operation-map p{margin:0.5rem 0 0;font-size:0.875rem;line-height:1.6;color:var(--ss-muted)}.ss-guide-summary{display:grid;grid-template-columns:1fr 1.3fr 1.3fr;gap:1.25rem;padding:1.25rem;margin:0 0 1.75rem;border:1px solid var(--ss-line);border-radius:14px;background:var(--ss-surface)}.ss-guide-summary strong{display:block;margin-top:0.5rem;color:var(--ss-ink);font-size:0.9rem}#content-area .ss-guide-summary p{margin:0.5rem 0 0;font-size:0.875rem;line-height:1.6;color:var(--ss-muted)}.ss-checkpoint{border-left:3px solid var(--ss-accent);border-radius:0 10px 10px 0;background:var(--ss-surface);padding:0.85rem 1.1rem;margin:1.5rem 0}#content-area .ss-checkpoint p{margin:0}#content-area th{padding:0.7rem 0.75rem}#content-area td{padding:0.8rem 0.75rem;vertical-align:top;line-height:1.6}#content-area :is(h2,h3){scroll-margin-top:8rem}#content-area :is(a,button,[role=\"tab\"]),#navbar button{-webkit-tap-highlight-color:transparent}#content-area .ss-primary-link,#content-area .ss-secondary-link{min-height:44px}#content-area [data-component-part=\"card-icon\"]{padding:0.5rem;box-sizing:content-box;background:var(--ss-surface);border-radius:10px}@media (max-width: 640px){.ss-home-actions{gap:0.5rem 1rem}.ss-operation-map,.ss-guide-summary{grid-template-columns:1fr}.ss-operation-map>div+div{border-left:0;border-top:1px solid var(--ss-line)}.ss-guide-summary{gap:1rem}.ss-guide-summary>div{display:grid;grid-template-columns:6.5rem 1fr;gap:0.5rem;align-items:baseline}#content-area .ss-guide-summary :is(p,strong){margin-top:0}}@media (prefers-reduced-motion: reduce){#sidebar a,#content-area .card{transition:none}}@media (forced-colors: active){.ss-checkpoint,.ss-guide-summary,.ss-operation-map,.ss-reference-strip{border:1px solid CanvasText}#content-area .ss-primary-link{border:1px solid ButtonText}}@media (max-width: 400px){#footer .nav-logo{max-width:140px}#footer div:has(>a .nav-logo){flex-wrap:wrap;gap:1rem}}#footer :is(a,span){color:var(--ss-muted)}#footer a:hover{color:var(--ss-accent)}.ss-test-sequence{display:grid;gap:1rem;margin:1.5rem 0}.ss-test-sequence .ss-test-case{border:1px solid var(--ss-line);border-radius:14px;padding:1.25rem}#content-area .ss-test-sequence h3{margin:0.5rem 0 0.75rem;font-size:1.1rem}#content-area .ss-test-sequence .ss-test-question{margin:0;padding:0.75rem 1rem;background:var(--ss-surface);border-left:3px solid var(--ss-accent);font-style:normal;color:var(--ss-ink)}#content-area .ss-test-sequence p{margin:0.85rem 0 0;font-size:0.9rem;line-height:1.7}"}]}
{"page":{"pagePath":"api-reference/v1/orders-by-cancel-create","slug":"/api-reference/v1/orders-by-cancel-create","pageMetadata":{"title":"Cancel order","api":"POST https://prod-api.stateset.cloud.stateset.app/api/v1/orders/{id}/cancel","description":"Cancel an order and return the updated order","href":"/api-reference/v1/orders-by-cancel-create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Cancel an order and return the updated order\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField,Table}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Cancel an order and return the updated order`}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Order ID`})}),`\n`,_jsx(Heading,{level:`3`,id:`request-body`,children:`Request body`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`CancelOrderRequest`})}),`\n`,_jsx(ParamField,{body:`reason`,type:`string,null`,id:`param-reason`,children:_jsx(_components.p,{children:`Cancellation reason`})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`ApiResponse_OrderResponse`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`data`,children:[_jsx(ResponseField,{name:`billing_address`,type:`Address,null`,id:`param-billing-address`,children:_jsxs(Expandable,{title:`Address`,children:[_jsx(ResponseField,{name:`address_line_1`,type:`string`,required:true,id:`param-address-line-1`}),_jsx(ResponseField,{name:`address_line_2`,type:`string,null`,id:`param-address-line-2`}),_jsx(ResponseField,{name:`city`,type:`string`,required:true,id:`param-city`}),_jsx(ResponseField,{name:`company`,type:`string,null`,id:`param-company`}),_jsx(ResponseField,{name:`country_code`,type:`string`,required:true,id:`param-country-code`}),_jsx(ResponseField,{name:`first_name`,type:`string`,required:true,id:`param-first-name`}),_jsx(ResponseField,{name:`last_name`,type:`string`,required:true,id:`param-last-name`}),_jsx(ResponseField,{name:`phone`,type:`string,null`,id:`param-phone`}),_jsx(ResponseField,{name:`postal_code`,type:`string`,required:true,id:`param-postal-code`}),_jsx(ResponseField,{name:`province`,type:`string`,required:true,id:`param-province`})]})}),_jsx(ResponseField,{name:`created_at`,type:`string (date-time)`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`Creation timestamp`})}),_jsx(ResponseField,{name:`currency`,type:`string,null`,id:`param-currency`,children:_jsx(_components.p,{children:`Currency code (ISO 4217)`})}),_jsx(ResponseField,{name:`customer_id`,type:`string`,required:true,id:`param-customer-id`,children:_jsx(_components.p,{children:`Customer identifier (UUID)`})}),_jsx(ResponseField,{name:`fulfillment_status`,type:`string`,required:true,id:`param-fulfillment-status`,children:_jsx(_components.p,{children:`Fulfillment status (unfulfilled, partially_fulfilled, fulfilled)`})}),_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-1`,children:_jsx(_components.p,{children:`Unique order identifier (UUID)`})}),_jsxs(ResponseField,{name:`items`,type:`OrderItem[]`,required:true,id:`param-items`,children:[_jsx(_components.p,{children:`Order line items`}),_jsxs(Expandable,{title:`OrderItem`,children:[_jsx(ResponseField,{name:`discount`,type:`string,null`,id:`param-discount`,children:_jsx(_components.p,{children:`Discount amount applied`})}),_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-2`,children:_jsx(_components.p,{children:`Line item ID`})}),_jsx(ResponseField,{name:`product_id`,type:`string`,required:true,id:`param-product-id`,children:_jsx(_components.p,{children:`Product variant ID`})}),_jsx(ResponseField,{name:`product_name`,type:`string`,required:true,id:`param-product-name`,children:_jsx(_components.p,{children:`Product display name`})}),_jsx(ResponseField,{name:`quantity`,type:`integer (int32)`,required:true,id:`param-quantity`,children:_jsx(_components.p,{children:`Quantity ordered`})}),_jsx(ResponseField,{name:`sku`,type:`string,null`,id:`param-sku`,children:_jsx(_components.p,{children:`Product SKU`})}),_jsx(ResponseField,{name:`tax_amount`,type:`string,null`,id:`param-tax-amount`,children:_jsx(_components.p,{children:`Calculated tax amount`})}),_jsx(ResponseField,{name:`tax_rate`,type:`string,null`,id:`param-tax-rate`,children:_jsx(_components.p,{children:`Tax rate as decimal`})}),_jsx(ResponseField,{name:`total_price`,type:`string`,required:true,id:`param-total-price`,children:_jsx(_components.p,{children:`Total price (unit_price × quantity)`})}),_jsx(ResponseField,{name:`unit_price`,type:`string`,required:true,id:`param-unit-price`,children:_jsx(_components.p,{children:`Price per unit`})})]})]}),_jsx(ResponseField,{name:`notes`,type:`string,null`,id:`param-notes`,children:_jsx(_components.p,{children:`Order notes`})}),_jsx(ResponseField,{name:`order_date`,type:`string (date-time)`,required:true,id:`param-order-date`,children:_jsx(_components.p,{children:`Date when the order was placed`})}),_jsx(ResponseField,{name:`order_number`,type:`string`,required:true,id:`param-order-number`,children:_jsx(_components.p,{children:`Human-readable order number`})}),_jsx(ResponseField,{name:`payment_method_id`,type:`string,null`,id:`param-payment-method-id`,children:_jsx(_components.p,{children:`Payment method identifier`})}),_jsx(ResponseField,{name:`payment_status`,type:`string`,required:true,id:`param-payment-status`,children:_jsx(_components.p,{children:`Payment status (pending, paid, failed, refunded)`})}),_jsx(ResponseField,{name:`shipment_id`,type:`string,null`,id:`param-shipment-id`,children:_jsx(_components.p,{children:`Associated shipment identifier`})}),_jsx(ResponseField,{name:`shipping_address`,type:`Address,null`,id:`param-shipping-address`,children:_jsxs(Expandable,{title:`Address`,children:[_jsx(ResponseField,{name:`address_line_1`,type:`string`,required:true,id:`param-address-line-1-1`}),_jsx(ResponseField,{name:`address_line_2`,type:`string,null`,id:`param-address-line-2-1`}),_jsx(ResponseField,{name:`city`,type:`string`,required:true,id:`param-city-1`}),_jsx(ResponseField,{name:`company`,type:`string,null`,id:`param-company-1`}),_jsx(ResponseField,{name:`country_code`,type:`string`,required:true,id:`param-country-code-1`}),_jsx(ResponseField,{name:`first_name`,type:`string`,required:true,id:`param-first-name-1`}),_jsx(ResponseField,{name:`last_name`,type:`string`,required:true,id:`param-last-name-1`}),_jsx(ResponseField,{name:`phone`,type:`string,null`,id:`param-phone-1`}),_jsx(ResponseField,{name:`postal_code`,type:`string`,required:true,id:`param-postal-code-1`}),_jsx(ResponseField,{name:`province`,type:`string`,required:true,id:`param-province-1`})]})}),_jsx(ResponseField,{name:`status`,type:`OrderStatus`,required:true,id:`param-status`,children:_jsx(_components.p,{children:`Current order status`})}),_jsx(ResponseField,{name:`total_amount`,type:`string,null`,id:`param-total-amount`,children:_jsx(_components.p,{children:`Total order amount`})}),_jsx(ResponseField,{name:`updated_at`,type:`string (date-time)`,required:true,id:`param-updated-at`,children:_jsx(_components.p,{children:`Last update timestamp`})}),_jsx(ResponseField,{name:`version`,type:`integer (int32)`,required:true,id:`param-version`,children:_jsx(_components.p,{children:`Version number for optimistic locking`})})]})}),`\n`,_jsx(ResponseField,{name:`errors`,type:`array,null`,id:`param-errors`}),`\n`,_jsx(ResponseField,{name:`message`,type:`string,null`,id:`param-message`}),`\n`,_jsx(ResponseField,{name:`meta`,type:`ResponseMeta,null`,id:`param-meta`,children:_jsxs(Expandable,{title:`ResponseMeta`,children:[_jsx(ResponseField,{name:`request_id`,type:`string,null`,id:`param-request-id`}),_jsx(ResponseField,{name:`timestamp`,type:`string`,required:true,id:`param-timestamp`})]})}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,required:true,id:`param-success`}),`\n`,_jsx(Heading,{level:`3`,id:`status-codes`,children:`Status codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`200`})}),_jsx(_components.td,{children:`Order cancelled successfully`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Unauthorized`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Forbidden`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Order not found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:`Validation error`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Internal server error`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel order","api":"POST https://prod-api.stateset.cloud.stateset.app/api/v1/orders/{id}/cancel","description":"Cancel an order and return the updated order","href":"/api-reference/v1/orders-by-cancel-create"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,RequestExample,ResponseExample,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Cancel an order and return the updated order`}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path parameters`}),`\n`,_jsx(ParamField,{path:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Order ID`})}),`\n`,_jsx(Heading,{level:`3`,id:`request-body`,children:`Request body`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`CancelOrderRequest`})}),`\n`,_jsx(ParamField,{body:`reason`,type:`string,null`,id:`param-reason`,children:_jsx(_components.p,{children:`Cancellation reason`})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`ApiResponse_OrderResponse`})}),`\n`,_jsx(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:_jsxs(Expandable,{title:`data`,children:[_jsx(ResponseField,{name:`billing_address`,type:`Address,null`,id:`param-billing-address`,children:_jsxs(Expandable,{title:`Address`,children:[_jsx(ResponseField,{name:`address_line_1`,type:`string`,required:true,id:`param-address-line-1`}),_jsx(ResponseField,{name:`address_line_2`,type:`string,null`,id:`param-address-line-2`}),_jsx(ResponseField,{name:`city`,type:`string`,required:true,id:`param-city`}),_jsx(ResponseField,{name:`company`,type:`string,null`,id:`param-company`}),_jsx(ResponseField,{name:`country_code`,type:`string`,required:true,id:`param-country-code`}),_jsx(ResponseField,{name:`first_name`,type:`string`,required:true,id:`param-first-name`}),_jsx(ResponseField,{name:`last_name`,type:`string`,required:true,id:`param-last-name`}),_jsx(ResponseField,{name:`phone`,type:`string,null`,id:`param-phone`}),_jsx(ResponseField,{name:`postal_code`,type:`string`,required:true,id:`param-postal-code`}),_jsx(ResponseField,{name:`province`,type:`string`,required:true,id:`param-province`})]})}),_jsx(ResponseField,{name:`created_at`,type:`string (date-time)`,required:true,id:`param-created-at`,children:_jsx(_components.p,{children:`Creation timestamp`})}),_jsx(ResponseField,{name:`currency`,type:`string,null`,id:`param-currency`,children:_jsx(_components.p,{children:`Currency code (ISO 4217)`})}),_jsx(ResponseField,{name:`customer_id`,type:`string`,required:true,id:`param-customer-id`,children:_jsx(_components.p,{children:`Customer identifier (UUID)`})}),_jsx(ResponseField,{name:`fulfillment_status`,type:`string`,required:true,id:`param-fulfillment-status`,children:_jsx(_components.p,{children:`Fulfillment status (unfulfilled, partially_fulfilled, fulfilled)`})}),_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-1`,children:_jsx(_components.p,{children:`Unique order identifier (UUID)`})}),_jsxs(ResponseField,{name:`items`,type:`OrderItem[]`,required:true,id:`param-items`,children:[_jsx(_components.p,{children:`Order line items`}),_jsxs(Expandable,{title:`OrderItem`,children:[_jsx(ResponseField,{name:`discount`,type:`string,null`,id:`param-discount`,children:_jsx(_components.p,{children:`Discount amount applied`})}),_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-2`,children:_jsx(_components.p,{children:`Line item ID`})}),_jsx(ResponseField,{name:`product_id`,type:`string`,required:true,id:`param-product-id`,children:_jsx(_components.p,{children:`Product variant ID`})}),_jsx(ResponseField,{name:`product_name`,type:`string`,required:true,id:`param-product-name`,children:_jsx(_components.p,{children:`Product display name`})}),_jsx(ResponseField,{name:`quantity`,type:`integer (int32)`,required:true,id:`param-quantity`,children:_jsx(_components.p,{children:`Quantity ordered`})}),_jsx(ResponseField,{name:`sku`,type:`string,null`,id:`param-sku`,children:_jsx(_components.p,{children:`Product SKU`})}),_jsx(ResponseField,{name:`tax_amount`,type:`string,null`,id:`param-tax-amount`,children:_jsx(_components.p,{children:`Calculated tax amount`})}),_jsx(ResponseField,{name:`tax_rate`,type:`string,null`,id:`param-tax-rate`,children:_jsx(_components.p,{children:`Tax rate as decimal`})}),_jsx(ResponseField,{name:`total_price`,type:`string`,required:true,id:`param-total-price`,children:_jsx(_components.p,{children:`Total price (unit_price × quantity)`})}),_jsx(ResponseField,{name:`unit_price`,type:`string`,required:true,id:`param-unit-price`,children:_jsx(_components.p,{children:`Price per unit`})})]})]}),_jsx(ResponseField,{name:`notes`,type:`string,null`,id:`param-notes`,children:_jsx(_components.p,{children:`Order notes`})}),_jsx(ResponseField,{name:`order_date`,type:`string (date-time)`,required:true,id:`param-order-date`,children:_jsx(_components.p,{children:`Date when the order was placed`})}),_jsx(ResponseField,{name:`order_number`,type:`string`,required:true,id:`param-order-number`,children:_jsx(_components.p,{children:`Human-readable order number`})}),_jsx(ResponseField,{name:`payment_method_id`,type:`string,null`,id:`param-payment-method-id`,children:_jsx(_components.p,{children:`Payment method identifier`})}),_jsx(ResponseField,{name:`payment_status`,type:`string`,required:true,id:`param-payment-status`,children:_jsx(_components.p,{children:`Payment status (pending, paid, failed, refunded)`})}),_jsx(ResponseField,{name:`shipment_id`,type:`string,null`,id:`param-shipment-id`,children:_jsx(_components.p,{children:`Associated shipment identifier`})}),_jsx(ResponseField,{name:`shipping_address`,type:`Address,null`,id:`param-shipping-address`,children:_jsxs(Expandable,{title:`Address`,children:[_jsx(ResponseField,{name:`address_line_1`,type:`string`,required:true,id:`param-address-line-1-1`}),_jsx(ResponseField,{name:`address_line_2`,type:`string,null`,id:`param-address-line-2-1`}),_jsx(ResponseField,{name:`city`,type:`string`,required:true,id:`param-city-1`}),_jsx(ResponseField,{name:`company`,type:`string,null`,id:`param-company-1`}),_jsx(ResponseField,{name:`country_code`,type:`string`,required:true,id:`param-country-code-1`}),_jsx(ResponseField,{name:`first_name`,type:`string`,required:true,id:`param-first-name-1`}),_jsx(ResponseField,{name:`last_name`,type:`string`,required:true,id:`param-last-name-1`}),_jsx(ResponseField,{name:`phone`,type:`string,null`,id:`param-phone-1`}),_jsx(ResponseField,{name:`postal_code`,type:`string`,required:true,id:`param-postal-code-1`}),_jsx(ResponseField,{name:`province`,type:`string`,required:true,id:`param-province-1`})]})}),_jsx(ResponseField,{name:`status`,type:`OrderStatus`,required:true,id:`param-status`,children:_jsx(_components.p,{children:`Current order status`})}),_jsx(ResponseField,{name:`total_amount`,type:`string,null`,id:`param-total-amount`,children:_jsx(_components.p,{children:`Total order amount`})}),_jsx(ResponseField,{name:`updated_at`,type:`string (date-time)`,required:true,id:`param-updated-at`,children:_jsx(_components.p,{children:`Last update timestamp`})}),_jsx(ResponseField,{name:`version`,type:`integer (int32)`,required:true,id:`param-version`,children:_jsx(_components.p,{children:`Version number for optimistic locking`})})]})}),`\n`,_jsx(ResponseField,{name:`errors`,type:`array,null`,id:`param-errors`}),`\n`,_jsx(ResponseField,{name:`message`,type:`string,null`,id:`param-message`}),`\n`,_jsx(ResponseField,{name:`meta`,type:`ResponseMeta,null`,id:`param-meta`,children:_jsxs(Expandable,{title:`ResponseMeta`,children:[_jsx(ResponseField,{name:`request_id`,type:`string,null`,id:`param-request-id`}),_jsx(ResponseField,{name:`timestamp`,type:`string`,required:true,id:`param-timestamp`})]})}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,required:true,id:`param-success`}),`\n`,_jsx(Heading,{level:`3`,id:`status-codes`,children:`Status codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`200`})}),_jsx(_components.td,{children:`Order cancelled successfully`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Unauthorized`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Forbidden`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Order not found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:`Validation error`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Internal server error`})]})]})]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://prod-api.stateset.cloud.stateset.app/api/v1/orders/{id}/cancel'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization: Bearer YOUR_API_KEY'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"reason\": \"Customer requested cancellation\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`200`,numberOfLines:`54`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`54`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"billing_address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"city\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"San Francisco\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"US\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"postal_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"94102\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"state\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CA\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"street\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"123 Main Street\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-12-09T10:30:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customer_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"123e4567-e89b-12d3-a456-426614174000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fulfillment_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"unfulfilled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"550e8400-e29b-41d4-a716-446655440000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"item-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"product_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"prod-abc123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"product_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Wireless Bluetooth Headphones\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sku\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"WBH-BLK-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tax_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"8.00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tax_rate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0.08\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total_price\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"99.98\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"unit_price\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"49.99\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"notes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Please deliver to back door\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"order_date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-12-09T10:30:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"order_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ORD-2024-001234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payment_method_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pm_card_visa\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"payment_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"shipping_address\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"city\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"San Francisco\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"US\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"postal_code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"94102\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"state\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"CA\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"street\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"123 Main Street\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"149.99\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-12-09T10:30:00Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errors\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"string\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Two-person tent, green — replacement for damaged pole set.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"meta\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"request_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-31T14:22:05Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel order","api":"POST https://prod-api.stateset.cloud.stateset.app/api/v1/orders/{id}/cancel","description":"Cancel an order and return the updated order","href":"/api-reference/v1/orders-by-cancel-create"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Path parameters","slug":"path-parameters","depth":3,"children":[]},{"title":"Request body","slug":"request-body","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Status codes","slug":"status-codes","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"7\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'https://prod-api.stateset.cloud.stateset.app/api/v1/orders/{id}/cancel'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Authorization: Bearer YOUR_API_KEY'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Content-Type: application/json'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"reason\": \"Customer requested cancellation\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">}'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"200","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"54\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"billing_address\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"city\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"San Francisco\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"country\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"US\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"postal_code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"94102\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"state\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"CA\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"street\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"123 Main Street\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2024-12-09T10:30:00Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"currency\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"USD\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"customer_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"123e4567-e89b-12d3-a456-426614174000\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"fulfillment_status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"unfulfilled\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"550e8400-e29b-41d4-a716-446655440000\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"items\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"item-001\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"product_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"prod-abc123\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"product_name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Wireless Bluetooth Headphones\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"quantity\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"sku\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"WBH-BLK-001\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"tax_amount\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"8.00\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"tax_rate\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"0.08\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"total_price\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"99.98\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"unit_price\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"49.99\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"notes\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Please deliver to back door\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"order_date\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2024-12-09T10:30:00Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"order_number\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ORD-2024-001234\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"payment_method_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pm_card_visa\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"payment_status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pending\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"shipping_address\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"city\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"San Francisco\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"country\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"US\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"postal_code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"94102\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"state\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"CA\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"street\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"123 Main Street\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pending\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"total_amount\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"149.99\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"updated_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2024-12-09T10:30:00Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"version\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"errors\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"string\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Two-person tent, green — replacement for damaged pole set.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"meta\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"request_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"timestamp\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-08-31T14:22:05Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Cancel order","path":"/api/v1/orders/{id}/cancel","servers":[{"url":"https://prod-api.stateset.cloud.stateset.app"}],"method":"post","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"id":{"schema":[{"type":"string","description":"Order ID","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"reason":[{"type":"object","properties":{},"description":"Cancellation reason"}]}}],"examples":{"example":{"value":{"reason":{}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"data":[{"type":"object","properties":{"billing_address":[{"type":"object","properties":{"address_line_1":[{"type":"string","required":true}],"address_line_2":[{"type":"object","properties":{}}],"city":[{"type":"string","required":true}],"company":[{"type":"object","properties":{}}],"country_code":[{"type":"string","required":true}],"first_name":[{"type":"string","required":true}],"last_name":[{"type":"string","required":true}],"phone":[{"type":"object","properties":{}}],"postal_code":[{"type":"string","required":true}],"province":[{"type":"string","required":true}]}}],"created_at":[{"type":"object","properties":{},"description":"Creation timestamp","required":true}],"currency":[{"type":"object","properties":{},"description":"Currency code (ISO 4217)"}],"customer_id":[{"type":"string","description":"Customer identifier (UUID)","required":true}],"fulfillment_status":[{"type":"string","description":"Fulfillment status (unfulfilled, partially_fulfilled, fulfilled)","required":true}],"id":[{"type":"string","description":"Unique order identifier (UUID)","required":true}],"items":[{"type":"array","items":[{"type":"object","properties":{"discount":[{"type":"object","properties":{},"description":"Discount amount applied"}],"id":[{"type":"string","description":"Line item ID","required":true}],"product_id":[{"type":"string","description":"Product variant ID","required":true}],"product_name":[{"type":"string","description":"Product display name","required":true}],"quantity":[{"type":"object","properties":{},"description":"Quantity ordered","required":true}],"sku":[{"type":"object","properties":{},"description":"Product SKU"}],"tax_amount":[{"type":"object","properties":{},"description":"Calculated tax amount"}],"tax_rate":[{"type":"object","properties":{},"description":"Tax rate as decimal"}],"total_price":[{"type":"string","description":"Total price (unit_price × quantity)","required":true}],"unit_price":[{"type":"string","description":"Price per unit","required":true}]}}],"description":"Order line items","required":true}],"notes":[{"type":"object","properties":{},"description":"Order notes"}],"order_date":[{"type":"object","properties":{},"description":"Date when the order was placed","required":true}],"order_number":[{"type":"string","description":"Human-readable order number","required":true}],"payment_method_id":[{"type":"object","properties":{},"description":"Payment method identifier"}],"payment_status":[{"type":"string","description":"Payment status (pending, paid, failed, refunded)","required":true}],"shipment_id":[{"type":"object","properties":{},"description":"Associated shipment identifier"}],"shipping_address":[{"type":"object","properties":{"address_line_1":[{"type":"string","required":true}],"address_line_2":[{"type":"object","properties":{}}],"city":[{"type":"string","required":true}],"company":[{"type":"object","properties":{}}],"country_code":[{"type":"string","required":true}],"first_name":[{"type":"string","required":true}],"last_name":[{"type":"string","required":true}],"phone":[{"type":"object","properties":{}}],"postal_code":[{"type":"string","required":true}],"province":[{"type":"string","required":true}]}}],"status":[{"type":"object","properties":{},"description":"Current order status","required":true}],"total_amount":[{"type":"object","properties":{},"description":"Total order amount"}],"updated_at":[{"type":"object","properties":{},"description":"Last update timestamp","required":true}],"version":[{"type":"object","properties":{},"description":"Version number for optimistic locking","required":true}]}}],"errors":[{"type":"object","properties":{}}],"message":[{"type":"object","properties":{}}],"meta":[{"type":"object","properties":{"request_id":[{"type":"object","properties":{}}],"timestamp":[{"type":"string","required":true}]}}],"success":[{"type":"boolean","required":true}]}}],"examples":{"example":{"value":{"data":{"billing_address":{"address_line_1":"\u003cstring>","address_line_2":{},"city":"\u003cstring>","company":{},"country_code":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","phone":{},"postal_code":"\u003cstring>","province":"\u003cstring>"},"created_at":{},"currency":{},"customer_id":"\u003cstring>","fulfillment_status":"\u003cstring>","id":"\u003cstring>","items":[{"discount":{},"id":"\u003cstring>","product_id":"\u003cstring>","product_name":"\u003cstring>","quantity":{},"sku":{},"tax_amount":{},"tax_rate":{},"total_price":"\u003cstring>","unit_price":"\u003cstring>"}],"notes":{},"order_date":{},"order_number":"\u003cstring>","payment_method_id":{},"payment_status":"\u003cstring>","shipment_id":{},"shipping_address":{"address_line_1":"\u003cstring>","address_line_2":{},"city":"\u003cstring>","company":{},"country_code":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","phone":{},"postal_code":"\u003cstring>","province":"\u003cstring>"},"status":{},"total_amount":{},"updated_at":{},"version":{}},"errors":{},"message":{},"meta":{"request_id":{},"timestamp":"\u003cstring>"},"success":true}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"stateset","siteName":"StateSet","title":"StateSet API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T19:12:28.751Z","gitLastModified":"2026-08-31T14:49:01.000Z","originalFileLocation":"api-reference/v1/orders-by-cancel-create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Cancel an order and return the updated order\">\u003cmeta data-mint-head name=\"application-name\" content=\"StateSet\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"StateSet API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Documentation for the StateSet iCommerce Engine — the execution layer for AI commerce. APIs, SDKs, MCP servers and skills for every service.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"StateSet API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stateset.com/api-reference/v1/orders-by-cancel-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stateset.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Cancel+order\u0026amp;description=Cancel+an+order+and+return+the+updated+order\u0026amp;theme=8b886a933b8fdd889c9fff09\u0026amp;signature=3afdadede1f2a6ec2d19fd1054628d388a39db01435b4e68b88980e076a36d61\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"StateSet API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Documentation for the StateSet iCommerce Engine — the execution layer for AI commerce. APIs, SDKs, MCP servers and skills for every service.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stateset.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Cancel+order\u0026amp;description=Cancel+an+order+and+return+the+updated+order\u0026amp;theme=8b886a933b8fdd889c9fff09\u0026amp;signature=3afdadede1f2a6ec2d19fd1054628d388a39db01435b4e68b88980e076a36d61\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"StateSet\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1854D8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stateset.com/api-reference/v1/orders-by-cancel-create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v1/orders-by-cancel-create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stateset.com/#organization\",\"name\":\"StateSet\",\"url\":\"https://docs.stateset.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stateset/4wTHkssFeA2M0XSV/logo/stateset28.svg?fit=max\u0026auto=format\u0026n=4wTHkssFeA2M0XSV\u0026q=85\u0026s=24804c100796a1bf65ec331da17e6d35\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stateset.com#website\",\"name\":\"StateSet\",\"url\":\"https://docs.stateset.com\",\"publisher\":{\"@id\":\"https://docs.stateset.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stateset.com/api-reference/v1/orders-by-cancel-create#webpage\",\"url\":\"https://docs.stateset.com/api-reference/v1/orders-by-cancel-create\",\"name\":\"Cancel order\",\"description\":\"Cancel an order and return the updated order\",\"dateModified\":\"2026-08-31T14:49:01.000Z\",\"isPartOf\":{\"@id\":\"https://docs.stateset.com#website\"}},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stateset.com/api-reference/v1/orders-by-cancel-create#apireference\",\"headline\":\"Cancel order\",\"name\":\"Cancel order\",\"description\":\"Cancel an order and return the updated order\",\"url\":\"https://docs.stateset.com/api-reference/v1/orders-by-cancel-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stateset.com/api-reference/v1/orders-by-cancel-create#webpage\"},\"dateModified\":\"2026-08-31T14:49:01.000Z\",\"publisher\":{\"@id\":\"https://docs.stateset.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stateset.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"StateSet\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"StateSet\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v1/orders-by-cancel-create.md","siteName":"StateSet","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/stateset"}]},"dropdowns":[{"dropdown":"Platform docs","icon":"book","description":"Products, guides and concepts","tabs":[{"tab":"Learn \u0026 build","icon":"book","groups":[{"group":"Get started","icon":"rocket","pages":[{"sidebarTitle":"Overview","title":"Build your first working operation","href":"/introduction"},{"sidebarTitle":"Signup to first value","title":"From Signup to First Value","icon":"rocket","href":"/guides/platform-onboarding"},{"sidebarTitle":"First local operation","title":"Your First Operation","icon":"play","href":"/guides/first-operation"},{"sidebarTitle":"Agent quickstart","title":"Getting Started for AI Agents","icon":"robot","href":"/getting-started-for-ai-agents"},{"title":"Why StateSet","icon":"scale-balanced","href":"/why-stateset"}]},{"group":"Build your first integration","icon":"blocks","pages":[{"sidebarTitle":"First support agent","title":"Your First Support Agent","icon":"bot","href":"/guides/first-support-agent"},{"sidebarTitle":"Workflow trial","title":"Your First Workflow Trial","icon":"workflow","href":"/guides/first-workflow-trial"},{"sidebarTitle":"Connect through MCP","title":"Manage Agents \u0026 Workflows with MCP","icon":"plug","href":"/guides/manage-platform-with-mcp"},{"title":"ResponseCX Quickstart","href":"/quickstart"},{"sidebarTitle":"Connect your systems","title":"Connect Your Operation","icon":"plug","href":"/guides/connect-your-operation"},{"sidebarTitle":"Rust engines \u0026 MCP","title":"Build Operations with Rust Engines \u0026 MCP","icon":"cpu","href":"/guides/rust-engines-and-mcp"},{"title":"Developer Guide","href":"/development"}]},{"group":"Operate and improve","icon":"activity","pages":[{"sidebarTitle":"Agent evaluations","title":"Your First Agent Evaluation","icon":"check-check","href":"/guides/first-agent-evaluation"},{"sidebarTitle":"Configuration changes","title":"Your First Workflow Configuration Change","icon":"git-pull-request","href":"/guides/first-workflow-config-change"},{"sidebarTitle":"Durable agents","title":"Operate Your First Durable Agent","icon":"bot","href":"/guides/first-durable-agent"},{"sidebarTitle":"Your first week","title":"Your First Week with StateSet","icon":"chart-line","href":"/guides/first-week-with-stateset"},{"title":"Launch a brand that runs itself","href":"/guides/launch-a-brand-autonomously"}]},{"group":"Resources and support","icon":"life-buoy","pages":[{"title":"Brand Onboarding","icon":"rocket","href":"/stateset-onboarding"},{"title":"ResponseCX","href":"/guides/response-quickstart"},{"sidebarTitle":"Troubleshooting","title":"Troubleshoot Your First Operation","icon":"life-ring","href":"/guides/onboarding-troubleshooting"},{"title":"Changelog","icon":"clock-rotate-left","href":"/changelog"},{"title":"Getting Help","icon":"life-ring","href":"/support"}]},{"group":"Platform","icon":"grid-2","pages":[{"title":"MCP Servers","icon":"plug","href":"/mcp-servers"},{"title":"StateSet Overview","icon":"eye","iconType":"solid","href":"/stateset-overview"},{"title":"StateSet Agent Operations Architecture","href":"/stateset-agentic-os"},{"title":"Global Commerce Architecture","href":"/global-commerce-architecture"},{"title":"Autonomous Agent Architecture","href":"/autonomous-agent-architecture"},{"title":"StateSet Billing","href":"/stateset-billing"},{"title":"Security \u0026 Compliance","icon":"shield","iconType":"solid","href":"/security"},{"title":"Service-as-a-Software (SaaS 3.0)","icon":"brain","iconType":"solid","href":"/service-as-a-software"}]},{"group":"Using the APIs","icon":"briefcase","pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"title":"Host status","href":"/api-reference/hosts"},{"title":"Errors across the engines","href":"/api-reference/errors-across-engines"},{"title":"Authentication","icon":"shield-halved","iconType":"solid","href":"/api-reference/authentication"},{"title":"API Design Guidelines","icon":"book","href":"/api-reference/api-design-guidelines"},{"title":"Overview","icon":"desktop","iconType":"solid","href":"/api-reference/overview"},{"title":"Getting Started","icon":"browser","iconType":"solid","href":"/api-reference/getting-started"},{"group":"Architecture","pages":[{"title":"Web Framework","icon":"browser","iconType":"solid","href":"/api-reference/framework"},{"title":"StateSet API","href":"/api-reference/backend-framework"},{"title":"gRPC","icon":"route","iconType":"solid","href":"/api-reference/grpc-framework"},{"title":"Workflow Framework with Temporal","icon":"arrow-progress","iconType":"solid","href":"/api-reference/temporal"},{"title":"Event-Driven APIs with StateSet One","icon":"webhook","iconType":"solid","href":"/api-reference/events"}]},{"title":"Features","href":"/api-reference/features"},{"title":"Reporting and Reconciliation","icon":"file-chart-column","href":"/api-reference/reporting"},{"title":"Integrations","icon":"plug","iconType":"solid","href":"/api-reference/integrations"},{"title":"API Changelog","icon":"clock-rotate-left","iconType":"solid","href":"/api-reference/changelog"}]},{"group":"StateSet Response","icon":"comments","pages":[{"title":"ResponseCX Platform","href":"/stateset-response/responsecx-platform"},{"title":"Chat Desk","sidebarTitle":"Chat Desk","icon":"inbox","href":"/stateset-response/chat-desk"},{"title":"Your First Shift in Chat Desk","sidebarTitle":"First desk shift","icon":"inbox","href":"/guides/chat-desk-first-shift"},{"title":"Connect the Chat Widget to Your Desk","sidebarTitle":"Widget to desk","icon":"messages-square","href":"/stateset-response/chat-desk-widget"},{"title":"Chat Desk Across Channels","sidebarTitle":"Desk channel coverage","icon":"network","href":"/stateset-response/chat-desk-channels"},{"title":"Autonomy dial","href":"/stateset-response/responsecx-autonomy"},{"title":"Workflow Studio","href":"/stateset-response/responsecx-workflow-studio"},{"title":"Website Onboarding","href":"/stateset-response/responsecx-website-onboarding"},{"title":"ResponseCX API","href":"/response-api-reference/overview"},{"title":"Agents","href":"/response-api-reference/agents"},{"title":"Authentication","icon":"key","iconType":"solid","href":"/response-api-reference/authentication"},{"title":"Models","href":"/response-api-reference/models"},{"title":"Agent Framework and SDK","href":"/response-api-reference/framework"},{"title":"Computer Use","href":"/response-api-reference/computer-use"},{"title":"ReasonCX","href":"/response-api-reference/reason"},{"title":"Realtime Voice","href":"/response-api-reference/voice"},{"title":"Response Public API (v1)","href":"/stateset-response/response-public-api"},{"title":"Response MCP Servers","href":"/stateset-response/response-mcp"},{"title":"Response ChatGPT App Guide","href":"/stateset-response/stateset-response-chatgpt-guide"},{"title":"Onsite Chat Quickstart","href":"/stateset-response/response-chat-widget-quickstart"},{"title":"Response Chat Widget","href":"/stateset-response/response-chat-widget"},{"title":"Widget Authentication and Conversation Recovery","sidebarTitle":"Auth and recovery","href":"/stateset-response/response-chat-widget-reliability"},{"title":"Native Widget Live Chat","sidebarTitle":"Native live chat","href":"/stateset-response/response-chat-widget-live-chat"},{"title":"Widget Sites, Configuration and MCP","sidebarTitle":"Sites and admin","href":"/stateset-response/response-chat-widget-admin"},{"title":"Deploy and Qualify the Onsite Widget","sidebarTitle":"Deployment","href":"/stateset-response/response-chat-widget-deployment"}]},{"group":"StateSet ResponseCX","icon":"headset","pages":[{"title":"Set up ResponseCX","href":"/stateset-response/stateset-responsecx"},{"title":"ResponseCX Platform","href":"/stateset-response/responsecx-platform"},{"title":"Autonomy dial","href":"/stateset-response/responsecx-autonomy"},{"title":"ResponseCX Workflows","href":"/stateset-response/stateset-responsecx-workflows"},{"title":"StateSet ResponseCX CLI","href":"/stateset-responsecx-cli"}]},{"group":"Temporal Engine","icon":"diagram-project","pages":[{"title":"Temporal Engine","href":"/next-temporal/overview"},{"title":"Start Automating Responses","href":"/next-temporal/getting-started"},{"title":"ResponseAutomationV2","href":"/next-temporal/workflow"},{"title":"Active-horizon agents","href":"/next-temporal/active-horizon-agents"},{"title":"Connectors \u0026 Capabilities","href":"/next-temporal/connectors"},{"title":"Policy Engine \u0026 Decision Gate","href":"/next-temporal/policy-engine"},{"title":"Control Plane","href":"/next-temporal/control-plane"},{"title":"Configuration","href":"/next-temporal/configuration"},{"title":"Workstream MCP","href":"/next-temporal/mcp-connector"},{"title":"Operations","href":"/next-temporal/operations"},{"title":"Kubernetes Deployment","href":"/next-temporal/kubernetes-deployment"},{"title":"Runbooks","href":"/next-temporal/runbooks"}]},{"group":"StateSet iCommerce Engine","icon":"shopping-bag","pages":[{"group":"Overview","pages":[{"title":"iCommerce Quickstart","href":"/stateset-icommerce/stateset-icommerce-quickstart"},{"title":"The Embedded iCommerce Engine","href":"/stateset-icommerce/stateset-icommerce-embedded"},{"title":"Governed Execution and Replay","href":"/stateset-icommerce/governed-execution"},{"title":"Physical Stock Fulfillment","href":"/stateset-icommerce/stock-fulfillment"},{"title":"Native Commerce and Inventory Simulations","href":"/stateset-icommerce/simulations"},{"title":"Build an iCommerce Storefront","href":"/stateset-icommerce/storefront"},{"title":"HTTP Retry Receipts and Reconciliation","href":"/stateset-icommerce/http-receipt-recovery"},{"title":"iCommerce Scenarios and Examples","href":"/stateset-icommerce/stateset-icommerce-scenarios"},{"title":"iCommerce Language Bindings","href":"/stateset-icommerce/stateset-icommerce-bindings"},{"title":"iCommerce Paper","href":"/icommerce-paper"},{"title":"iCommerce Intro","href":"/icommerce"},{"title":"StateSet iCommerce Engine Architecture","href":"/icommerce-architecture"},{"title":"iCommerce Quickstart for AI Agents","href":"/stateset-icommerce-quickstart"},{"title":"StateSet iCommerce Engine Skills","href":"/stateset-icommerce/stateset-icommerce-skills"},{"title":"iCommerce MCP Server","href":"/stateset-icommerce/stateset-icommerce-mcp"}]},{"group":"Agent Sandbox","pages":[{"title":"iCommerce Agent Execution","href":"/stateset-icommerce/stateset-icommerce-agent"},{"title":"Run iCommerce Inside Sandbox","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox"},{"title":"Agent Sandbox Costs","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox-costs"},{"title":"iCommerce Sandbox Runbook","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox-runbook"},{"title":"iCommerce Sandbox Troubleshooting","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox-troubleshooting"}]},{"group":"Lifecycle \u0026 Workflows","pages":[{"title":"Order Lifecycle","href":"/stateset-icommerce/stateset-icommerce-order-lifecycle"},{"title":"Returns Workflow","href":"/stateset-icommerce/stateset-icommerce-returns-workflow"},{"title":"Inventory Lifecycle","href":"/stateset-icommerce/stateset-icommerce-inventory-lifecycle"}]},{"group":"Platform \u0026 Operations","pages":[{"title":"Finance \u0026 Accounting","href":"/stateset-icommerce/stateset-icommerce-finance"},{"title":"Admin Console","href":"/stateset-icommerce/stateset-icommerce-admin"},{"title":"Commerce HTTP Access and Retry Controls","href":"/stateset-icommerce/stateset-icommerce-api-hardening"},{"title":"Backup, Restore, and Durability","href":"/stateset-icommerce/stateset-icommerce-backup-restore"}]},{"group":"CLI","pages":[{"title":"iCommerce CLI Reference","href":"/stateset-icommerce/stateset-icommerce-cli-reference"},{"title":"Operational CLI Workflows","href":"/stateset-icommerce/stateset-icommerce-cli-workflows"},{"title":"CLI and Agent Write Controls","href":"/stateset-icommerce/stateset-icommerce-cli-safety"}]},{"group":"Messaging \u0026 Payments","pages":[{"title":"Messaging Orchestrator","href":"/stateset-icommerce/stateset-icommerce-messaging-orchestrator"},{"title":"Run the WhatsApp gateway","href":"/stateset-icommerce/stateset-icommerce-whatsapp-integration"},{"title":"x402 Intents and Settlement Boundaries","href":"/stateset-icommerce/stateset-icommerce-x402-payments"},{"title":"Connect messaging channels","href":"/stateset-icommerce/stateset-icommerce-messaging-channels"}]},{"group":"Deployment","pages":[{"title":"Deploy StateSet iCommerce Engine on GCP","href":"/stateset-icommerce/stateset-icommerce-gcp"},{"title":"Deploy StateSet iCommerce Engine on Hetzner","href":"/stateset-icommerce/stateset-icommerce-hetzner"},{"title":"Deploy StateSet iCommerce Engine on Fly.io","href":"/stateset-icommerce/stateset-icommerce-flyio"}]}]},{"group":"StateSet Warehouse (WMS)","icon":"warehouse","pages":[{"title":"StateSet Warehouse (WMS)","sidebarTitle":"Overview","icon":"warehouse","href":"/stateset-warehouse/overview"},{"title":"Run StateSet Warehouse locally","sidebarTitle":"Quickstart","href":"/stateset-warehouse/quickstart"},{"title":"Warehouse REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-warehouse/api-and-mcp"},{"title":"Connect Sync OMS, Warehouse WMS, and Freight TMS","sidebarTitle":"OMS, WMS, and TMS","href":"/guides/oms-wms-tms"}]},{"group":"StateSet Freight (TMS)","icon":"truck","pages":[{"title":"StateSet Freight (TMS)","sidebarTitle":"Overview","icon":"truck","href":"/stateset-freight/overview"},{"title":"Run StateSet Freight locally","sidebarTitle":"Quickstart","href":"/stateset-freight/quickstart"},{"title":"Freight REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-freight/api-and-mcp"}]},{"group":"StateSet EDI","icon":"file-import","pages":[{"title":"StateSet EDI","href":"/stateset-edi/overview"},{"title":"Workspace Onboarding and Readiness","href":"/stateset-edi/onboarding"},{"title":"EDI Quickstart","href":"/stateset-edi/quickstart"},{"title":"Orders, Reviewed Sends, and Recovery","href":"/stateset-edi/orders-and-recovery"},{"title":"EDI Transaction Sets","href":"/stateset-edi/transaction-sets"},{"title":"EDI Transports","href":"/stateset-edi/transports"},{"title":"Guides, Mappings, and Callbacks","href":"/stateset-edi/mappings-and-callbacks"},{"title":"EDI Operations","href":"/stateset-edi/operations"},{"title":"EDI CLI and JavaScript SDK","href":"/stateset-edi/cli-and-sdk"},{"title":"EDI MCP Server","href":"/stateset-edi/mcp-server"},{"title":"EDI Configuration","href":"/stateset-edi/configuration"},{"title":"EDI Deployment and Qualification","href":"/stateset-edi/deployment-and-qualification"}]},{"group":"StateSet Mail","icon":"envelope","pages":[{"title":"StateSet Mail","href":"/stateset-mail/overview"},{"title":"Mail Quickstart","href":"/stateset-mail/quickstart"},{"title":"Conversations","href":"/stateset-mail/conversations"},{"title":"Mail MCP Server","href":"/stateset-mail/mcp-server"},{"title":"Mail Configuration","href":"/stateset-mail/configuration"}]},{"group":"StateSet iCommerce Voice Engine","icon":"phone","pages":[{"title":"StateSet iCommerce Voice Engine","href":"/stateset-voice/overview"},{"title":"Build Your First Voice Agent","href":"/stateset-voice/quickstart"},{"title":"Voice API","href":"/stateset-voice/api"},{"title":"Voice SDKs","href":"/stateset-voice/sdks"},{"title":"Voice Webhooks","href":"/stateset-voice/webhooks"},{"title":"Voice Configuration","href":"/stateset-voice/configuration"},{"title":"Voice MCP Server","href":"/stateset-voice/mcp-server"},{"title":"Voice Operations","href":"/stateset-voice/operations"}]},{"group":"StateSet iCommerce NSR Engine","icon":"brain","pages":[{"title":"Neuro-Symbolic Architecture","href":"/stateset-nsr"},{"title":"NSR-L Language Reference","href":"/stateset-nsr-l"},{"title":"Verified Decisions API","href":"/stateset-nsr-decisions"},{"title":"Jev + NSR","sidebarTitle":"Jev + NSR","icon":"scan-text","href":"/stateset-nsr-jev"},{"title":"Your First Jev + NSR Decision","sidebarTitle":"First Jev decision","icon":"play","href":"/guides/jev-first-decision"},{"title":"Jev + NSR Industry Pack Examples","sidebarTitle":"Industry examples","icon":"building","href":"/guides/jev-industry-packs"},{"title":"Use Industry Packs with the Decisions API","sidebarTitle":"Decisions API walkthrough","icon":"code","href":"/guides/jev-decisions-api"},{"title":"Connect Jev to Your NSR Workspace","sidebarTitle":"Jev workspace setup","icon":"key-round","href":"/guides/jev-workspace-setup"},{"title":"Agent Gate","href":"/stateset-nsr-agent-gate"},{"title":"Formal Verification","href":"/stateset-nsr-formal-verification"},{"title":"NSR as a Model Provider","href":"/stateset-nsr-providers"},{"title":"NSR Console \u0026 Billing","href":"/stateset-nsr-console"},{"title":"NSR SDKs","href":"/stateset-nsr-sdks"},{"title":"NSR MCP Server","href":"/stateset-nsr-mcp"}]},{"group":"AI Agents","icon":"robot","pages":[{"title":"StateSet Computer Use Agent","href":"/computer-use-agent"},{"title":"Engines and Commerce MCP Servers","href":"/computer-use-engines-mcp"},{"title":"Computer Use MCP Servers","href":"/computer-use-mcp"},{"title":"StateSet RL agents","href":"/stateset-rl-agents"}]},{"group":"StateSet Agents","pages":[{"title":"StateSet Agents","href":"/stateset-agents/overview"},{"title":"Prepare your first fine-tuning run","sidebarTitle":"Quickstart","href":"/stateset-agents/quickstart"},{"title":"Fine-tuning studio","href":"/stateset-agents/finetuning-studio"},{"title":"Fine-tuning from AI agents","href":"/stateset-agents/finetuning-agents"},{"title":"Checkpoint recovery and evaluation","href":"/stateset-agents/checkpoints-and-evaluation"},{"title":"River SFT, native RL, and retained evidence","sidebarTitle":"River training","href":"/stateset-agents/river-training"},{"title":"Industry data and fine-tuning","href":"/stateset-agents/industry-finetuning"},{"title":"StateSet Agents CLI","sidebarTitle":"CLI reference","href":"/stateset-agents/cli"},{"title":"Agents MCP server","href":"/stateset-agents/mcp-server"}]},{"group":"StateSet Sandbox","icon":"flask","pages":[{"title":"StateSet Sandbox","href":"/stateset-sandbox/stateset-sandboxes"},{"title":"Sandbox Quickstart","href":"/stateset-sandbox/stateset-sandbox-quickstart-guide"},{"title":"Get started with StateSet Swarm","href":"/stateset-sandbox/swarm-getting-started"},{"title":"Execution, workers, and recovery","href":"/stateset-sandbox/execution-and-recovery"},{"title":"Sandbox terminal workbench","href":"/stateset-sandbox/workbench"},{"title":"Prepared agent tasks and teams","href":"/stateset-sandbox/agent-tasks"},{"title":"Artifacts and recoverable tunnels","href":"/stateset-sandbox/artifacts-and-tunnels"},{"group":"Architecture \u0026 Operations","pages":[{"title":"Sandbox architecture","href":"/stateset-sandbox/stateset-sandbox-architecture"},{"title":"Sandbox operations and release evidence","href":"/stateset-sandbox/stateset-sandbox-operations"},{"title":"Sandbox webhooks and event delivery","href":"/stateset-sandbox/stateset-sandbox-webhooks"},{"title":"Sandbox security boundaries","href":"/stateset-sandbox/stateset-sandbox-security-guide"},{"title":"Sandbox API workflow","href":"/stateset-sandbox/stateset-sandbox-api-flow"},{"title":"Durable sandboxes and agent sessions","href":"/stateset-sandbox/stateset-sandbox-agent-sessions"},{"title":"Self-host Sandbox","href":"/stateset-sandbox/stateset-sandbox-deployments"},{"title":"Sandbox API directory","href":"/stateset-sandbox/stateset-sandbox-api-reference"},{"title":"Sandbox production configuration","href":"/stateset-sandbox/stateset-sandbox-production-guide"},{"title":"Sandbox Quickstart","href":"/stateset-sandbox/stateset-sandbox-quickstart-guide"},{"title":"Sandbox runtime selection","href":"/stateset-sandbox/stateset-sandbox-runtime-selection"},{"title":"Sandbox on AWS EKS","href":"/stateset-sandbox/stateset-sandbox-deployment-aws"},{"title":"Sandbox on GCP GKE","href":"/stateset-sandbox/stateset-sandbox-deployment-gcp"},{"title":"Sandbox on Azure AKS","href":"/stateset-sandbox/stateset-sandbox-deployment-azure"},{"title":"Sandbox MCP server","href":"/stateset-sandbox/stateset-sandbox-mcp"}]},{"group":"SDKs","pages":[{"title":"Sandbox TypeScript SDK","sidebarTitle":"Node.js SDK","href":"/stateset-sandbox/stateset-sandbox-sdk-node"},{"title":"Sandbox Python SDK","href":"/stateset-sandbox/stateset-sandbox-sdk-python"}]},{"title":"Build with StateSet Sandbox","href":"/guides/stateset-sandbox"}]},{"group":"StateSet ACP","icon":"bolt","pages":[{"title":"Agentic Commerce Protocol","href":"/stateset-acp/stateset-acp"},{"title":"ACP Overview","href":"/stateset-acp/stateset-acp-overview"},{"title":"ACP Quickstart","href":"/stateset-acp/stateset-acp-quickstart"},{"group":"Reference","pages":[{"title":"ACP Async Processing","href":"/stateset-acp/stateset-acp-async-processing"},{"title":"ACP API Endpoints","href":"/stateset-acp/stateset-acp-endpoints"},{"title":"ACP Routing Options","href":"/stateset-acp/stateset-acp-routing"},{"title":"ACP Request Schemas","href":"/stateset-acp/stateset-acp-schemas"}]},{"title":"Agentic Commerce Protocol Handler","href":"/guides/agentic-commerce-protocol-handler"},{"title":"Agentic Commerce Protocol Checkout Guide","href":"/agentic-commerce/agentic-commerce-checkout-guide"}]},{"group":"StateSet UCP","icon":"arrows-split-up-and-left","pages":[{"title":"Universal Commerce Protocol","href":"/stateset-ucp"},{"title":"UCP Quickstart","href":"/stateset-ucp-quickstart"},{"title":"Universal Commerce Protocol Handler","href":"/guides/universal-commerce-protocol-handler"}]},{"group":"StateSet ICP","icon":"network-wired","pages":[{"title":"Intelligent Commerce Protocol (ICP)","href":"/stateset-icp"}]},{"group":"StateSet Sequencer","icon":"layer-group","pages":[{"title":"StateSet VES System Overview","href":"/stateset-sequencer/stateset-sequencer"},{"title":"Sequencer Architecture: Deep Dive","href":"/stateset-sequencer-architecture"},{"title":"Sequencer Quickstart","href":"/stateset-sequencer/stateset-sequencer-quickstart"},{"title":"Sequencer Operations","href":"/stateset-sequencer/stateset-sequencer-operations"},{"title":"x402 payments reference","href":"/stateset-sequencer/stateset-sequencer-x402"}]},{"group":"StateSet Set L2","icon":"cube","pages":[{"title":"Set L2","href":"/set/set"},{"title":"StateSet Set L2","href":"/set/stateset-set-l2"},{"title":"Set L2 Architecture","href":"/set/stateset-set-l2-architecture"},{"title":"Set L2 Verification","href":"/set/stateset-set-l2-verification"},{"title":"Set L2 Verification Example","href":"/set/stateset-set-l2-verification-example"},{"title":"Set L2 Compliance Proofs","href":"/set/stateset-set-l2-compliance-proof"},{"title":"STARK Compliance Proofs","href":"/set/stateset-stark"}]},{"group":"StateSet Cloud","icon":"cloud","pages":[{"title":"StateSet Cloud Overview","href":"/cloud-api-reference/overview"},{"title":"Authentication","href":"/cloud-api-reference/authentication"},{"title":"API Keys","href":"/cloud-api-reference/api-keys"},{"group":"Cloud API","pages":[{"group":"Projects","pages":[{"title":"Create Projects","api":"POST https://api.stateset.com/v1/projects","href":"/cloud-api-reference/projects/create"},{"title":"Delete Project","api":"DELETE https://api.stateset.com/v1/projects/{id}","href":"/cloud-api-reference/projects/delete"},{"title":"Get Projects","api":"GET https://api.stateset.com/v1/projects","href":"/cloud-api-reference/projects/get"}]},{"group":"Deployments","pages":[{"title":"Create Deployment","api":"POST https://api.stateset.com/v1/deployments","href":"/cloud-api-reference/deployments/create"},{"title":"Delete Deployment","api":"DELETE https://api.stateset.com/v1/deployments/{id}","href":"/cloud-api-reference/deployments/delete"},{"title":"Get Deployments","api":"GET https://api.stateset.com/v1/deployments","href":"/cloud-api-reference/deployments/get"}]},{"group":"Secrets","pages":[{"title":"Create Secrets","api":"POST https://api.stateset.com/v1/secrets","href":"/cloud-api-reference/secrets/create"},{"title":"Delete Secret","api":"DELETE https://api.stateset.com/v1/secrets/{id}","href":"/cloud-api-reference/secrets/delete"},{"title":"Get Secrets","api":"GET https://api.stateset.com/v1/secrets","href":"/cloud-api-reference/secrets/get"},{"title":"Update Secrets","api":"PUT https://api.stateset.com/v1/secrets/{id}","href":"/cloud-api-reference/secrets/update"}]},{"group":"Logs","pages":[{"title":"Create Logs","api":"POST https://api.stateset.com/v1/logs","href":"/cloud-api-reference/logs/create"},{"title":"Get Logs","api":"GET https://api.stateset.com/v1/logs","href":"/cloud-api-reference/logs/get"}]},{"group":"Templates","pages":[{"title":"Create Template","api":"POST https://api.stateset.com/v1/templates","href":"/cloud-api-reference/templates/create"},{"title":"Delete Template","api":"DELETE https://api.stateset.com/v1/templates/{id}","href":"/cloud-api-reference/templates/delete"},{"title":"Get Templates","api":"GET https://api.stateset.com/v1/templates","href":"/cloud-api-reference/templates/get"},{"title":"Update Template","api":"PUT https://api.stateset.com/v1/templates/{id}","href":"/cloud-api-reference/templates/update"}]}]}]},{"group":"Apps \u0026 Consoles","pages":[{"title":"StateSet Console","href":"/stateset-console/stateset-console-overview"},{"title":"Get Started with Console on the Web","sidebarTitle":"Web Console quickstart","icon":"globe","href":"/guides/console-web-getting-started"},{"title":"Get Started with Console on Mobile","sidebarTitle":"Mobile Console quickstart","icon":"mobile-screen","href":"/guides/console-mobile-getting-started"},{"title":"Get Started with StateSet Desktop","sidebarTitle":"Desktop quickstart","icon":"monitor","href":"/guides/desktop-getting-started"},{"title":"StateSet Demo App","href":"/stateset-demo-app-overview"},{"title":"StateSet Worker","href":"/stateset-worker"},{"title":"Console Mobile","href":"/stateset-console/stateset-console-mobile"},{"title":"StateSet Desktop","href":"/stateset-desktop"}]},{"group":"Tools","icon":"wrench","pages":[{"title":"StateSet iCommerce CLI","href":"/stateset-cli-overview"},{"title":"Console Agent Pipeline","href":"/stateset-console/stateset-console-agent-pipeline"},{"title":"Console Auth Flow","href":"/stateset-console/stateset-console-auth-flow"},{"title":"Deploy the ACP Handler","href":"/stateset-deploy-acp-handler"},{"title":"Sync Server: What's New","href":"/stateset-sync-server-whats-new"},{"title":"Sync Server MCP","href":"/stateset-sync-mcp"},{"title":"Sync Server API Basics","href":"/stateset-sync-server-api-basics"},{"title":"StateSet Deploy","href":"/stateset-deploy-overview"},{"title":"Deploy the Response ChatGPT App","href":"/stateset-deploy-chatgpt-app"},{"title":"Sync Server gRPC Dispatch Flow","href":"/stateset-sync-server-grpc-flow"},{"title":"Sync Server connectors","href":"/stateset-sync-server-connectors"},{"title":"Sync Server troubleshooting","href":"/stateset-sync-server-troubleshooting"},{"title":"iCommerce Agent Operating Guide","href":"/stateset-icommerce-skill"},{"title":"Sandbox agent operating guide","href":"/stateset-sandbox-skill"},{"title":"Sync Server API Contract","href":"/stateset-sync-server-api-contract"},{"title":"Sync Server ACP Guide","href":"/stateset-sync-server-acp-guide"},{"title":"Sync Server gRPC Dispatch","href":"/stateset-sync-server-grpc-dispatch"}]}]},{"tab":"Guides","icon":"graduation-cap","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"SDK Installation and Setup","icon":"code","href":"/guides/sdk-installation"}]},{"group":"Quickstarts","icon":"play","pages":[{"title":"ResponseCX","href":"/guides/response-quickstart"},{"title":"Warranty Claims Quickstart","icon":"right-left","iconType":"solid","href":"/guides/warranties-quickstart"},{"title":"Customers Quickstart","icon":"user","href":"/guides/customers-quickstart"},{"title":"Agentic Commerce Protocol Checkout Guide","href":"/agentic-commerce/agentic-commerce-checkout-guide"},{"title":"StateSet Cloud Quickstart","icon":"cloud","iconType":"solid","href":"/guides/stateset-cloud-quickstart"},{"title":"Onsite Chat Quickstart","href":"/stateset-response/response-chat-widget-quickstart"}]},{"group":"End-to-end","icon":"route","pages":[{"title":"Launch a brand that runs itself","href":"/guides/launch-a-brand-autonomously"},{"title":"EDI Order to Cash Across StateSet","href":"/guides/journey-edi-order-to-cash"},{"title":"From 'where is my order?' to a closed operation","href":"/guides/journey-wismo-to-resolution"},{"title":"Sync a Shopify store with NetSuite","href":"/guides/sync-shopify-to-netsuite"},{"title":"Your First EDI Purchase-Order Cycle","href":"/guides/edi-first-850"},{"title":"Gate a refund with a verified decision","href":"/guides/nsr-first-verified-decision"},{"title":"Run a durable order workflow end to end","href":"/guides/temporal-first-durable-workflow"},{"title":"Automate a back-office tool that has no API","href":"/guides/computer-use-first-task"},{"title":"Put an agent on the phone","href":"/guides/voice-first-phone-agent"},{"title":"Your first Sandbox runtime workflow","href":"/guides/sandbox-first-runtime"}]},{"group":"Commerce Workflows","icon":"diagram-project","pages":[{"title":"Order to cash","href":"/guides/commerce/order-to-cash"},{"title":"AR and collections","href":"/guides/commerce/ar-collections"},{"title":"Period close","href":"/guides/commerce/period-close"},{"title":"Procure to pay","href":"/guides/commerce/procure-to-pay"},{"title":"Receiving and Put-away","href":"/guides/commerce/receiving-and-putaway"},{"title":"Fulfillment \u0026 Shipping","href":"/guides/commerce/fulfillment"},{"title":"Returns and return-to-vendor","href":"/guides/commerce/returns-and-rtv"},{"title":"Lot and serial traceability","href":"/guides/commerce/traceability"}]},{"group":"Order Management","icon":"shopping-cart","pages":[{"title":"Orders Quickstart","href":"/guides/orders-quickstart"},{"title":"Payments \u0026 Refunds Quickstart","href":"/guides/payments-quickstart"},{"title":"Order Settlements Quickstart","icon":"gears","iconType":"solid","href":"/guides/order-settlement"},{"title":"Wholesale Quickstart","icon":"cart-shopping","iconType":"solid","href":"/guides/wholesale-quickstart"},{"title":"Order Operations","href":"/guides/order-operations"}]},{"group":"Returns \u0026 Warranties","icon":"rotate-left","pages":[{"title":"Returns Quickstart","href":"/guides/returns-quickstart"},{"title":"Warranty Vision Workflow User Guide","icon":"brain","iconType":"solid","href":"/guides/warranty-vision-guide"}]},{"group":"Supply Chain","icon":"truck","pages":[{"title":"Manufacturing Quickstart","href":"/guides/manufacturing-quickstart"},{"title":"Warehouse Receiving Quickstart","icon":"warehouse","href":"/guides/warehouse-quickstart"},{"title":"Supplier \u0026 Purchase Order Quickstart","icon":"truck","iconType":"solid","href":"/guides/supplier-quickstart"},{"title":"Inventory Quickstart","href":"/guides/inventory-quickstart"},{"title":"COGS","href":"/guides/cogs-quickstart"}]},{"group":"Agent Development","icon":"robot","pages":[{"title":"Agents Quickstart","icon":"message-bot","iconType":"solid","href":"/guides/agents-quickstart"},{"title":"Agent Training Guide","icon":"graduation-cap","iconType":"solid","href":"/guides/agent-trainer-guide"},{"title":"Agent Objectives, Goals, Metrics \u0026 Rewards Guide","icon":"brain","iconType":"solid","href":"/guides/agent-objectives-guide"},{"title":"Multi-Agent System Architectures","icon":"brain","iconType":"solid","href":"/guides/multi-agent-systems"},{"title":"StateSet Computer Use Agents - Quick Start Guide","icon":"brain","iconType":"solid","href":"/guides/stateset-computer-use-agents"},{"title":"StateSet Computer Use Agents - Architecture Overview","icon":"brain","iconType":"solid","href":"/guides/stateset-computer-use-agents-architecture"},{"title":"Reinforcement learning and fine-tuning","href":"/guides/reinforcement-learning-platform"},{"title":"GRPO and the StateSet training framework","sidebarTitle":"GRPO framework","href":"/guides/grpo-agent-framework"},{"title":"MCP Integration for AI Agents","icon":"plug","iconType":"solid","href":"/guides/mcp-integration-guide"}]},{"group":"Knowledge \u0026 RAG","icon":"brain","pages":[{"title":"Knowledge Base Quickstart","icon":"brain","iconType":"solid","href":"/guides/knowledgebase-quickstart"},{"title":"RAG Quickstart","icon":"wand-magic-sparkles","iconType":"solid","href":"/guides/rag-quickstart"},{"title":"Sources Quickstart","icon":"database","iconType":"solid","href":"/guides/sources-quickstart"}]},{"group":"Response Features","icon":"wand-magic-sparkles","pages":[{"title":"Agent Attributes \u0026 Personality","icon":"palette","iconType":"solid","href":"/guides/attributes-quickstart"},{"title":"Agent Rules Quickstart","icon":"scale-balanced","iconType":"solid","href":"/guides/rules-quickstart"},{"title":"Examples Quickstart","icon":"lightbulb","iconType":"solid","href":"/guides/examples-quickstart"},{"title":"Evaluations Guide","sidebarTitle":"Evaluations","icon":"clipboard-check","href":"/guides/evaluations-guide"},{"title":"Agent Schedules \u0026 Automation","icon":"clock","iconType":"solid","href":"/guides/schedules-quickstart"},{"title":"Agent Functions Quickstart","icon":"plug","iconType":"solid","href":"/guides/functions-quickstart"}]},{"group":"Advanced Features","icon":"flask","pages":[{"title":"Vision Quickstart","icon":"eye","iconType":"solid","href":"/guides/vision-quickstart"},{"title":"Voice AI Guide","icon":"microphone","iconType":"solid","href":"/guides/voice-quickstart"},{"title":"Synthetic Fixtures for Agent Testing","icon":"brain","href":"/guides/synthetic-data"},{"title":"StateSet Synthetic Data Studio Architecture Guide","icon":"diagram-project","iconType":"solid","href":"/guides/synthetic-data-architecture"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"Shopify Product Embeddings","icon":"shopify","iconType":"solid","href":"/guides/shopify-quickstart"},{"title":"Gorgias Ticket Quickstart","icon":"ticket","iconType":"solid","href":"/guides/gorgias-quickstart"},{"title":"Multi-Channel Commerce Integration Guide","icon":"store","iconType":"solid","href":"/guides/multi-channel-integration-guide"}]},{"group":"Commerce Network","icon":"link","pages":[{"title":"StateSet Network Quickstart","icon":"globe","iconType":"solid","href":"/guides/stateset-network"},{"title":"Commerce Network Orders: Migration Guide","href":"/guides/stateset-network-orders"},{"title":"StateSet Contracts","icon":"file-contract","iconType":"solid","href":"/guides/stateset-contracts"},{"title":"Agent Payments: Build and Verify","href":"/guides/smart-agents-usdc-guide"},{"title":"Complete an x402 payment","href":"/stateset-x402-walkthrough"},{"title":"CCTP Integration: Availability and Prerequisites","href":"/guides/cctp-module-integration"},{"title":"Agent Payments and Legacy Network Examples","href":"/smart-agents-usdc-guide"}]},{"group":"Self-Hosted","icon":"server","pages":[{"title":"Build with StateSet Sandbox","href":"/guides/stateset-sandbox"},{"title":"Agentic Commerce Protocol Handler","href":"/guides/agentic-commerce-protocol-handler"},{"title":"Universal Commerce Protocol Handler","href":"/guides/universal-commerce-protocol-handler"}]},{"group":"Best Practices","icon":"shield-check","pages":[{"title":"Error Handling \u0026 Retries","icon":"triangle-exclamation","href":"/guides/error-handling-best-practices"},{"title":"Handle Rate Limits Without Losing Requests","icon":"gauge-high","href":"/guides/api-rate-limiting"},{"title":"Performance Optimization Guide","icon":"rocket","iconType":"solid","href":"/guides/performance-optimization"},{"title":"Integration Test Plan","icon":"flask","href":"/guides/comprehensive-testing-guide"},{"title":"Integration Testing","icon":"flask","href":"/guides/api-testing"},{"title":"Batch Operations Guide","icon":"cogs","iconType":"solid","href":"/guides/batch-operations"},{"title":"Webhook Security Guide","icon":"shield","iconType":"solid","href":"/guides/webhook-security"}]},{"group":"E-commerce Workflows","icon":"cart-shopping","pages":[{"title":"Ecommerce Agent Workflows Guide","icon":"gears","href":"/guides/ecommerce-agent-workflows-guide"}]}]}]},{"dropdown":"API Reference","icon":"code","description":"Every endpoint, with a playground","tabs":[{"tab":"iCommerce","icon":"shopping-cart","groups":[{"group":"Overview","pages":[{"title":"StateSet Commerce API","href":"/api-reference/commerce/overview"},{"title":"Invariant error codes","href":"/api-reference/commerce/invariant-codes"},{"title":"Error Handling","icon":"triangle-exclamation","href":"/api-reference/errors"},{"title":"Rate Limits and Retry Contracts","icon":"gauge-high","href":"/api-reference/rate-limiting"},{"title":"Webhooks","icon":"webhook","href":"/api-reference/webhooks"},{"title":"Commerce Engine API history","href":"/api-reference/commerce/history"}]},{"group":"Orders \u0026 Customers","pages":[{"group":"Orders","pages":[{"title":"Cancel an order","api":"PATCH https://api.stateset.com/api/v1/orders/{id}/cancel","href":"/api-reference/commerce/orders/orders-by-cancel-update"},{"title":"Get an order","api":"GET https://api.stateset.com/api/v1/orders/{id}","href":"/api-reference/commerce/orders/orders-by-get"},{"title":"Ship an order","api":"PATCH https://api.stateset.com/api/v1/orders/{id}/ship","href":"/api-reference/commerce/orders/orders-by-ship-update"},{"title":"Create an order","api":"POST https://api.stateset.com/api/v1/orders","href":"/api-reference/commerce/orders/orders-create"},{"title":"List orders","api":"GET https://api.stateset.com/api/v1/orders","href":"/api-reference/commerce/orders/orders-list"}]},{"group":"Carts","pages":[{"title":"Cancel a cart","api":"POST https://api.stateset.com/api/v1/carts/{id}/cancel","href":"/api-reference/commerce/carts/carts-by-cancel-create"},{"title":"Complete a cart","api":"POST https://api.stateset.com/api/v1/carts/{id}/complete","href":"/api-reference/commerce/carts/carts-by-complete-create"},{"title":"Get a cart","api":"GET https://api.stateset.com/api/v1/carts/{id}","href":"/api-reference/commerce/carts/carts-by-get"},{"title":"Remove an item","api":"DELETE https://api.stateset.com/api/v1/carts/{id}/items/{item_id}","href":"/api-reference/commerce/carts/carts-by-items-by-delete"},{"title":"Update an item","api":"PUT https://api.stateset.com/api/v1/carts/{id}/items/{item_id}","href":"/api-reference/commerce/carts/carts-by-items-by-update"},{"title":"Add an item","api":"POST https://api.stateset.com/api/v1/carts/{id}/items","href":"/api-reference/commerce/carts/carts-by-items-create"},{"title":"Set payment","api":"POST https://api.stateset.com/api/v1/carts/{id}/payment","href":"/api-reference/commerce/carts/carts-by-payment-create"},{"title":"Set shipping","api":"POST https://api.stateset.com/api/v1/carts/{id}/shipping","href":"/api-reference/commerce/carts/carts-by-shipping-create"},{"title":"Create a cart","api":"POST https://api.stateset.com/api/v1/carts","href":"/api-reference/commerce/carts/carts-create"},{"title":"List carts","api":"GET https://api.stateset.com/api/v1/carts","href":"/api-reference/commerce/carts/carts-list"}]},{"group":"Customers","pages":[{"title":"Delete a customer","api":"DELETE https://api.stateset.com/api/v1/customers/{id}","href":"/api-reference/commerce/customers/customers-by-delete"},{"title":"Get a customer","api":"GET https://api.stateset.com/api/v1/customers/{id}","href":"/api-reference/commerce/customers/customers-by-get"},{"title":"Update a customer","api":"PATCH https://api.stateset.com/api/v1/customers/{id}","href":"/api-reference/commerce/customers/customers-by-update"},{"title":"Create a customer","api":"POST https://api.stateset.com/api/v1/customers","href":"/api-reference/commerce/customers/customers-create"},{"title":"List customers","api":"GET https://api.stateset.com/api/v1/customers","href":"/api-reference/commerce/customers/customers-list"}]},{"group":"Companies","pages":[{"title":"Create a contact","api":"POST https://api.stateset.com/api/v1/companies/{id}/contacts","href":"/api-reference/commerce/companies/companies-by-contacts-create"},{"title":"List contacts","api":"GET https://api.stateset.com/api/v1/companies/{id}/contacts","href":"/api-reference/commerce/companies/companies-by-contacts-get"},{"title":"Delete a company","api":"DELETE https://api.stateset.com/api/v1/companies/{id}","href":"/api-reference/commerce/companies/companies-by-delete"},{"title":"Get a company","api":"GET https://api.stateset.com/api/v1/companies/{id}","href":"/api-reference/commerce/companies/companies-by-get"},{"title":"Create a company","api":"POST https://api.stateset.com/api/v1/companies","href":"/api-reference/commerce/companies/companies-create"},{"title":"List companies","api":"GET https://api.stateset.com/api/v1/companies","href":"/api-reference/commerce/companies/companies-list"}]},{"group":"Channels","pages":[{"title":"Delete a channel","api":"DELETE https://api.stateset.com/api/v1/channels/{id}","href":"/api-reference/commerce/channels/channels-by-delete"},{"title":"Get a channel","api":"GET https://api.stateset.com/api/v1/channels/{id}","href":"/api-reference/commerce/channels/channels-by-get"},{"title":"Lock a set","api":"POST https://api.stateset.com/api/v1/channels/{id}/lock","href":"/api-reference/commerce/channels/channels-by-lock-create"},{"title":"Update a channel","api":"PUT https://api.stateset.com/api/v1/channels/{id}","href":"/api-reference/commerce/channels/channels-by-update"},{"title":"Create a channel","api":"POST https://api.stateset.com/api/v1/channels","href":"/api-reference/commerce/channels/channels-create"},{"title":"List channels","api":"GET https://api.stateset.com/api/v1/channels","href":"/api-reference/commerce/channels/channels-list"}]},{"group":"Segments","pages":[{"title":"Delete a segment","api":"DELETE https://api.stateset.com/api/v1/segments/{id}","href":"/api-reference/commerce/segments/segments-by-delete"},{"title":"Get a segment","api":"GET https://api.stateset.com/api/v1/segments/{id}","href":"/api-reference/commerce/segments/segments-by-get"},{"title":"Add a member","api":"POST https://api.stateset.com/api/v1/segments/{id}/members/{customer_id}","href":"/api-reference/commerce/segments/segments-by-members-by-create"},{"title":"Remove a member","api":"DELETE https://api.stateset.com/api/v1/segments/{id}/members/{customer_id}","href":"/api-reference/commerce/segments/segments-by-members-by-delete"},{"title":"Create a segment","api":"POST https://api.stateset.com/api/v1/segments","href":"/api-reference/commerce/segments/segments-create"},{"title":"List segments","api":"GET https://api.stateset.com/api/v1/segments","href":"/api-reference/commerce/segments/segments-list"}]},{"group":"Wishlists","pages":[{"title":"Delete a wishlist","api":"DELETE https://api.stateset.com/api/v1/wishlists/{id}","href":"/api-reference/commerce/wishlists/wishlists-by-delete"},{"title":"Get a wishlist","api":"GET https://api.stateset.com/api/v1/wishlists/{id}","href":"/api-reference/commerce/wishlists/wishlists-by-get"},{"title":"Remove an item (/api/v1/wishlists/{id}/items/{product_id})","api":"DELETE https://api.stateset.com/api/v1/wishlists/{id}/items/{product_id}","href":"/api-reference/commerce/wishlists/wishlists-by-items-by-delete"},{"title":"Add an item (/api/v1/wishlists/{id}/items)","api":"POST https://api.stateset.com/api/v1/wishlists/{id}/items","href":"/api-reference/commerce/wishlists/wishlists-by-items-create"},{"title":"Create a wishlist","api":"POST https://api.stateset.com/api/v1/wishlists","href":"/api-reference/commerce/wishlists/wishlists-create"},{"title":"List wishlists","api":"GET https://api.stateset.com/api/v1/wishlists","href":"/api-reference/commerce/wishlists/wishlists-list"}]},{"group":"Reviews","pages":[{"title":"Delete a review","api":"DELETE https://api.stateset.com/api/v1/reviews/{id}","href":"/api-reference/commerce/reviews/reviews-by-delete"},{"title":"Get a review","api":"GET https://api.stateset.com/api/v1/reviews/{id}","href":"/api-reference/commerce/reviews/reviews-by-get"},{"title":"Create a review","api":"POST https://api.stateset.com/api/v1/reviews","href":"/api-reference/commerce/reviews/reviews-create"},{"title":"List reviews","api":"GET https://api.stateset.com/api/v1/reviews","href":"/api-reference/commerce/reviews/reviews-list"}]},{"group":"Loyalty","pages":[{"title":"Get an account (/api/v1/loyalty/accounts/{id})","api":"GET https://api.stateset.com/api/v1/loyalty/accounts/{id}","href":"/api-reference/commerce/loyalty/loyalty-accounts-by-get"},{"title":"Enroll customer","api":"POST https://api.stateset.com/api/v1/loyalty/enroll","href":"/api-reference/commerce/loyalty/loyalty-enroll-create"},{"title":"Create a program","api":"POST https://api.stateset.com/api/v1/loyalty/programs","href":"/api-reference/commerce/loyalty/loyalty-programs-create"},{"title":"List programs","api":"GET https://api.stateset.com/api/v1/loyalty/programs","href":"/api-reference/commerce/loyalty/loyalty-programs-list"}]},{"group":"Store Credits","pages":[{"title":"Adjust a store credit","api":"POST https://api.stateset.com/api/v1/store-credits/{id}/adjust","href":"/api-reference/commerce/store_credits/store-credits-by-adjust-create"},{"title":"Apply a store credit","api":"POST https://api.stateset.com/api/v1/store-credits/{id}/apply","href":"/api-reference/commerce/store_credits/store-credits-by-apply-create"},{"title":"Get a store credit","api":"GET https://api.stateset.com/api/v1/store-credits/{id}","href":"/api-reference/commerce/store_credits/store-credits-by-get"},{"title":"Create a store credit","api":"POST https://api.stateset.com/api/v1/store-credits","href":"/api-reference/commerce/store_credits/store-credits-create"},{"title":"List store credits","api":"GET https://api.stateset.com/api/v1/store-credits","href":"/api-reference/commerce/store_credits/store-credits-list"}]},{"group":"Gift Cards","pages":[{"title":"Charge gift card","api":"POST https://api.stateset.com/api/v1/gift-cards/{id}/charge","href":"/api-reference/commerce/gift_cards/gift-cards-by-charge-create"},{"title":"Disable a gift card","api":"POST https://api.stateset.com/api/v1/gift-cards/{id}/disable","href":"/api-reference/commerce/gift_cards/gift-cards-by-disable-create"},{"title":"Get a gift card","api":"GET https://api.stateset.com/api/v1/gift-cards/{id}","href":"/api-reference/commerce/gift_cards/gift-cards-by-get"},{"title":"Refund a gift card","api":"POST https://api.stateset.com/api/v1/gift-cards/{id}/refund","href":"/api-reference/commerce/gift_cards/gift-cards-by-refund-create"},{"title":"Create a gift card","api":"POST https://api.stateset.com/api/v1/gift-cards","href":"/api-reference/commerce/gift_cards/gift-cards-create"},{"title":"List gift cards","api":"GET https://api.stateset.com/api/v1/gift-cards","href":"/api-reference/commerce/gift_cards/gift-cards-list"}]},{"group":"Subscriptions","pages":[{"title":"Cancel a subscription","api":"PATCH https://api.stateset.com/api/v1/subscriptions/{id}/cancel","href":"/api-reference/commerce/subscriptions/subscriptions-by-cancel-update"},{"title":"Get a subscription","api":"GET https://api.stateset.com/api/v1/subscriptions/{id}","href":"/api-reference/commerce/subscriptions/subscriptions-by-get"},{"title":"Pause subscription","api":"PATCH https://api.stateset.com/api/v1/subscriptions/{id}/pause","href":"/api-reference/commerce/subscriptions/subscriptions-by-pause-update"},{"title":"Resume subscription","api":"PATCH https://api.stateset.com/api/v1/subscriptions/{id}/resume","href":"/api-reference/commerce/subscriptions/subscriptions-by-resume-update"},{"title":"Create a subscription","api":"POST https://api.stateset.com/api/v1/subscriptions","href":"/api-reference/commerce/subscriptions/subscriptions-create"},{"title":"List subscriptions","api":"GET https://api.stateset.com/api/v1/subscriptions","href":"/api-reference/commerce/subscriptions/subscriptions-list"}]},{"group":"Promotions","pages":[{"title":"Activate a promotion","api":"PATCH https://api.stateset.com/api/v1/promotions/{id}/activate","href":"/api-reference/commerce/promotions/promotions-by-activate-update"},{"title":"Deactivate a promotion","api":"PATCH https://api.stateset.com/api/v1/promotions/{id}/deactivate","href":"/api-reference/commerce/promotions/promotions-by-deactivate-update"},{"title":"Get a promotion","api":"GET https://api.stateset.com/api/v1/promotions/{id}","href":"/api-reference/commerce/promotions/promotions-by-get"},{"title":"Create a promotion","api":"POST https://api.stateset.com/api/v1/promotions","href":"/api-reference/commerce/promotions/promotions-create"},{"title":"List promotions","api":"GET https://api.stateset.com/api/v1/promotions","href":"/api-reference/commerce/promotions/promotions-list"}]},{"group":"Price Levels","pages":[{"title":"Delete a price level","api":"DELETE https://api.stateset.com/api/v1/price-levels/{id}","href":"/api-reference/commerce/price_levels/price-levels-by-delete"},{"title":"Set entry","api":"POST https://api.stateset.com/api/v1/price-levels/{id}/entries","href":"/api-reference/commerce/price_levels/price-levels-by-entries-create"},{"title":"List entries (/api/v1/price-levels/{id}/entries)","api":"GET https://api.stateset.com/api/v1/price-levels/{id}/entries","href":"/api-reference/commerce/price_levels/price-levels-by-entries-get"},{"title":"Get a price level","api":"GET https://api.stateset.com/api/v1/price-levels/{id}","href":"/api-reference/commerce/price_levels/price-levels-by-get"},{"title":"Update a price level","api":"PUT https://api.stateset.com/api/v1/price-levels/{id}","href":"/api-reference/commerce/price_levels/price-levels-by-update"},{"title":"Create a price level","api":"POST https://api.stateset.com/api/v1/price-levels","href":"/api-reference/commerce/price_levels/price-levels-create"},{"title":"List price levels","api":"GET https://api.stateset.com/api/v1/price-levels","href":"/api-reference/commerce/price_levels/price-levels-list"}]},{"group":"Price Schedules","pages":[{"title":"Delete a price schedule","api":"DELETE https://api.stateset.com/api/v1/price-schedules/{id}","href":"/api-reference/commerce/price_schedules/price-schedules-by-delete"},{"title":"Set entry (/api/v1/price-schedules/{id}/entries)","api":"POST https://api.stateset.com/api/v1/price-schedules/{id}/entries","href":"/api-reference/commerce/price_schedules/price-schedules-by-entries-create"},{"title":"List entries (/api/v1/price-schedules/{id}/entries)","api":"GET https://api.stateset.com/api/v1/price-schedules/{id}/entries","href":"/api-reference/commerce/price_schedules/price-schedules-by-entries-get"},{"title":"Get a price schedule","api":"GET https://api.stateset.com/api/v1/price-schedules/{id}","href":"/api-reference/commerce/price_schedules/price-schedules-by-get"},{"title":"Create a price schedule","api":"POST https://api.stateset.com/api/v1/price-schedules","href":"/api-reference/commerce/price_schedules/price-schedules-create"},{"title":"List price schedules","api":"GET https://api.stateset.com/api/v1/price-schedules","href":"/api-reference/commerce/price_schedules/price-schedules-list"},{"title":"Resolve a price schedule","api":"GET https://api.stateset.com/api/v1/price-schedules/resolve","href":"/api-reference/commerce/price_schedules/price-schedules-resolve-list"}]}]},{"group":"Inventory \u0026 Warehouse","pages":[{"group":"Inventory","pages":[{"title":"Adjust a stock","api":"POST https://api.stateset.com/api/v1/inventory/{sku}/adjust","href":"/api-reference/commerce/inventory/inventory-by-adjust-create"},{"title":"Get a stock","api":"GET https://api.stateset.com/api/v1/inventory/{sku}","href":"/api-reference/commerce/inventory/inventory-by-get"},{"title":"List inventories","api":"GET https://api.stateset.com/api/v1/inventory","href":"/api-reference/commerce/inventory/inventory-list"}]},{"group":"Warehouse","pages":[{"title":"Cancel a cycle count","api":"POST https://api.stateset.com/api/v1/cycle-counts/{id}/cancel","href":"/api-reference/commerce/warehouse/cycle-counts-by-cancel-create"},{"title":"Complete a cycle count","api":"POST https://api.stateset.com/api/v1/cycle-counts/{id}/complete","href":"/api-reference/commerce/warehouse/cycle-counts-by-complete-create"},{"title":"Cycle count record counts","api":"POST https://api.stateset.com/api/v1/cycle-counts/{id}/counts","href":"/api-reference/commerce/warehouse/cycle-counts-by-counts-create"},{"title":"Get a cycle count","api":"GET https://api.stateset.com/api/v1/cycle-counts/{id}","href":"/api-reference/commerce/warehouse/cycle-counts-by-get"},{"title":"Cycle count start","api":"POST https://api.stateset.com/api/v1/cycle-counts/{id}/start","href":"/api-reference/commerce/warehouse/cycle-counts-by-start-create"},{"title":"Create a cycle count","api":"POST https://api.stateset.com/api/v1/cycle-counts","href":"/api-reference/commerce/warehouse/cycle-counts-create"},{"title":"List cycle counts","api":"GET https://api.stateset.com/api/v1/cycle-counts","href":"/api-reference/commerce/warehouse/cycle-counts-list"},{"title":"Adjust an inventory","api":"POST https://api.stateset.com/api/v1/warehouse-inventory/adjust","href":"/api-reference/commerce/warehouse/warehouse-inventory-adjust-create"},{"title":"Inventory move","api":"POST https://api.stateset.com/api/v1/warehouse-inventory/move","href":"/api-reference/commerce/warehouse/warehouse-inventory-move-create"},{"title":"Get a location","api":"GET https://api.stateset.com/api/v1/warehouse-locations/{id}","href":"/api-reference/commerce/warehouse/warehouse-locations-by-get"},{"title":"Location inventory","api":"GET https://api.stateset.com/api/v1/warehouse-locations/{id}/inventory","href":"/api-reference/commerce/warehouse/warehouse-locations-by-inventory-get"},{"title":"Create a location","api":"POST https://api.stateset.com/api/v1/warehouse-locations","href":"/api-reference/commerce/warehouse/warehouse-locations-create"},{"title":"List locations","api":"GET https://api.stateset.com/api/v1/warehouse-locations","href":"/api-reference/commerce/warehouse/warehouse-locations-list"},{"title":"Delete a warehouse","api":"DELETE https://api.stateset.com/api/v1/warehouses/{id}","href":"/api-reference/commerce/warehouse/warehouses-by-delete"},{"title":"Get a warehouse","api":"GET https://api.stateset.com/api/v1/warehouses/{id}","href":"/api-reference/commerce/warehouse/warehouses-by-get"},{"title":"Update a warehouse","api":"PUT https://api.stateset.com/api/v1/warehouses/{id}","href":"/api-reference/commerce/warehouse/warehouses-by-update"},{"title":"Create a warehouse","api":"POST https://api.stateset.com/api/v1/warehouses","href":"/api-reference/commerce/warehouse/warehouses-create"},{"title":"List warehouses","api":"GET https://api.stateset.com/api/v1/warehouses","href":"/api-reference/commerce/warehouse/warehouses-list"},{"title":"List bins","api":"GET https://api.stateset.com/api/v1/warehouse-bins","href":"/api-reference/commerce/warehouse/warehouse-bins-list"},{"title":"Create a bin","api":"POST https://api.stateset.com/api/v1/warehouse-bins","href":"/api-reference/commerce/warehouse/warehouse-bins-create"},{"title":"Get a bin","api":"GET https://api.stateset.com/api/v1/warehouse-bins/{id}","href":"/api-reference/commerce/warehouse/warehouse-bins-by-get"},{"title":"Update a bin","api":"PUT https://api.stateset.com/api/v1/warehouse-bins/{id}","href":"/api-reference/commerce/warehouse/warehouse-bins-by-update"},{"title":"Delete a bin","api":"DELETE https://api.stateset.com/api/v1/warehouse-bins/{id}","href":"/api-reference/commerce/warehouse/warehouse-bins-by-delete"},{"title":"Bin levels","api":"GET https://api.stateset.com/api/v1/warehouse-bins/{id}/levels","href":"/api-reference/commerce/warehouse/warehouse-bins-by-levels-get"},{"title":"Adjust a bin","api":"POST https://api.stateset.com/api/v1/warehouse-bins/adjust","href":"/api-reference/commerce/warehouse/warehouse-bins-adjust-create"},{"title":"Bin move","api":"POST https://api.stateset.com/api/v1/warehouse-bins/move","href":"/api-reference/commerce/warehouse/warehouse-bins-move-create"},{"title":"Bin reconcile","api":"GET https://api.stateset.com/api/v1/warehouse-bins/reconcile","href":"/api-reference/commerce/warehouse/warehouse-bins-reconcile-list"}]},{"group":"Lots","pages":[{"title":"Consume a lot","api":"POST https://api.stateset.com/api/v1/lots/{id}/consume","href":"/api-reference/commerce/lots/lots-by-consume-create"},{"title":"Get a lot","api":"GET https://api.stateset.com/api/v1/lots/{id}","href":"/api-reference/commerce/lots/lots-by-get"},{"title":"Quarantine","api":"POST https://api.stateset.com/api/v1/lots/{id}/quarantine","href":"/api-reference/commerce/lots/lots-by-quarantine-create"},{"title":"Release a quarantine","api":"POST https://api.stateset.com/api/v1/lots/{id}/release-quarantine","href":"/api-reference/commerce/lots/lots-by-release-quarantine-create"},{"title":"Reserve a lot","api":"POST https://api.stateset.com/api/v1/lots/{id}/reserve","href":"/api-reference/commerce/lots/lots-by-reserve-create"},{"title":"Create a lot","api":"POST https://api.stateset.com/api/v1/lots","href":"/api-reference/commerce/lots/lots-create"},{"title":"Expiring","api":"GET https://api.stateset.com/api/v1/lots/expiring","href":"/api-reference/commerce/lots/lots-expiring-list"},{"title":"List lots","api":"GET https://api.stateset.com/api/v1/lots","href":"/api-reference/commerce/lots/lots-list"},{"title":"Release a reservation (/api/v1/lots/reservations/{reservation_id}/release)","api":"POST https://api.stateset.com/api/v1/lots/reservations/{reservation_id}/release","href":"/api-reference/commerce/lots/lots-reservations-by-release-create"}]},{"group":"Serials","pages":[{"title":"Get a serial","api":"GET https://api.stateset.com/api/v1/serials/{id}","href":"/api-reference/commerce/serials/serials-by-get"},{"title":"Reserve a serial","api":"POST https://api.stateset.com/api/v1/serials/{id}/reserve","href":"/api-reference/commerce/serials/serials-by-reserve-create"},{"title":"Return","api":"POST https://api.stateset.com/api/v1/serials/{id}/return","href":"/api-reference/commerce/serials/serials-by-return-create"},{"title":"Scrap","api":"POST https://api.stateset.com/api/v1/serials/{id}/scrap","href":"/api-reference/commerce/serials/serials-by-scrap-create"},{"title":"Ship a serial","api":"POST https://api.stateset.com/api/v1/serials/{id}/ship","href":"/api-reference/commerce/serials/serials-by-ship-create"},{"title":"Create a serial","api":"POST https://api.stateset.com/api/v1/serials","href":"/api-reference/commerce/serials/serials-create"},{"title":"List serials","api":"GET https://api.stateset.com/api/v1/serials","href":"/api-reference/commerce/serials/serials-list"},{"title":"Release a reservation (/api/v1/serials/reservations/{reservation_id}/release)","api":"POST https://api.stateset.com/api/v1/serials/reservations/{reservation_id}/release","href":"/api-reference/commerce/serials/serials-reservations-by-release-create"}]},{"group":"Stock Snapshots","pages":[{"title":"Delete a stock snapshot","api":"DELETE https://api.stateset.com/api/v1/stock-snapshots/{id}","href":"/api-reference/commerce/stock_snapshots/stock-snapshots-by-delete"},{"title":"Get a stock snapshot","api":"GET https://api.stateset.com/api/v1/stock-snapshots/{id}","href":"/api-reference/commerce/stock_snapshots/stock-snapshots-by-get"},{"title":"Capture","api":"POST https://api.stateset.com/api/v1/stock-snapshots","href":"/api-reference/commerce/stock_snapshots/stock-snapshots-create"},{"title":"Latest","api":"GET https://api.stateset.com/api/v1/stock-snapshots/latest","href":"/api-reference/commerce/stock_snapshots/stock-snapshots-latest-list"},{"title":"List stock snapshots","api":"GET https://api.stateset.com/api/v1/stock-snapshots","href":"/api-reference/commerce/stock_snapshots/stock-snapshots-list"}]},{"group":"Units Of Measure","pages":[{"title":"Create a class","api":"POST https://api.stateset.com/api/v1/unit-classes","href":"/api-reference/commerce/units_of_measure/unit-classes-create"},{"title":"List classes","api":"GET https://api.stateset.com/api/v1/unit-classes","href":"/api-reference/commerce/units_of_measure/unit-classes-list"},{"title":"Create a rule","api":"POST https://api.stateset.com/api/v1/unit-conversion-rules","href":"/api-reference/commerce/units_of_measure/unit-conversion-rules-create"},{"title":"List rules","api":"GET https://api.stateset.com/api/v1/unit-conversion-rules","href":"/api-reference/commerce/units_of_measure/unit-conversion-rules-list"},{"title":"Create an UOM","api":"POST https://api.stateset.com/api/v1/units-of-measure","href":"/api-reference/commerce/units_of_measure/units-of-measure-create"},{"title":"List uoms","api":"GET https://api.stateset.com/api/v1/units-of-measure","href":"/api-reference/commerce/units_of_measure/units-of-measure-list"}]},{"group":"Transfer Orders","pages":[{"title":"Cancel a transfer order","api":"POST https://api.stateset.com/api/v1/transfer-orders/{id}/cancel","href":"/api-reference/commerce/transfer_orders/transfer-orders-by-cancel-create"},{"title":"Get a transfer order","api":"GET https://api.stateset.com/api/v1/transfer-orders/{id}","href":"/api-reference/commerce/transfer_orders/transfer-orders-by-get"},{"title":"Receive a transfer order","api":"POST https://api.stateset.com/api/v1/transfer-orders/{id}/receive","href":"/api-reference/commerce/transfer_orders/transfer-orders-by-receive-create"},{"title":"Ship a transfer order","api":"POST https://api.stateset.com/api/v1/transfer-orders/{id}/ship","href":"/api-reference/commerce/transfer_orders/transfer-orders-by-ship-create"},{"title":"Create a transfer order","api":"POST https://api.stateset.com/api/v1/transfer-orders","href":"/api-reference/commerce/transfer_orders/transfer-orders-create"},{"title":"List transfer orders","api":"GET https://api.stateset.com/api/v1/transfer-orders","href":"/api-reference/commerce/transfer_orders/transfer-orders-list"}]},{"group":"Backorders","pages":[{"title":"Cancel a backorder","api":"POST https://api.stateset.com/api/v1/backorders/{id}/cancel","href":"/api-reference/commerce/backorders/backorders-by-cancel-create"},{"title":"Fulfill a backorder","api":"POST https://api.stateset.com/api/v1/backorders/{id}/fulfill","href":"/api-reference/commerce/backorders/backorders-by-fulfill-create"},{"title":"Get a backorder","api":"GET https://api.stateset.com/api/v1/backorders/{id}","href":"/api-reference/commerce/backorders/backorders-by-get"},{"title":"Create a backorder","api":"POST https://api.stateset.com/api/v1/backorders","href":"/api-reference/commerce/backorders/backorders-create"},{"title":"List backorders","api":"GET https://api.stateset.com/api/v1/backorders","href":"/api-reference/commerce/backorders/backorders-list"}]},{"group":"Print Stations","pages":[{"title":"Complete a job","api":"POST https://api.stateset.com/api/v1/print-jobs/{job_id}/complete","href":"/api-reference/commerce/print_stations/print-jobs-by-complete-create"},{"title":"Enqueue","api":"POST https://api.stateset.com/api/v1/print-stations/{id}/jobs","href":"/api-reference/commerce/print_stations/print-stations-by-jobs-create"},{"title":"List jobs","api":"GET https://api.stateset.com/api/v1/print-stations/{id}/jobs","href":"/api-reference/commerce/print_stations/print-stations-by-jobs-get"},{"title":"Next job","api":"POST https://api.stateset.com/api/v1/print-stations/{id}/jobs/next","href":"/api-reference/commerce/print_stations/print-stations-by-jobs-next-create"},{"title":"Revoke","api":"POST https://api.stateset.com/api/v1/print-stations/{id}/revoke","href":"/api-reference/commerce/print_stations/print-stations-by-revoke-create"},{"title":"Pair","api":"POST https://api.stateset.com/api/v1/print-stations","href":"/api-reference/commerce/print_stations/print-stations-create"},{"title":"List stations","api":"GET https://api.stateset.com/api/v1/print-stations","href":"/api-reference/commerce/print_stations/print-stations-list"}]}]},{"group":"Fulfillment \u0026 Shipping","pages":[{"group":"Fulfillment","pages":[{"title":"Add a carton","api":"POST https://api.stateset.com/api/v1/fulfillment/packs/{id}/cartons","href":"/api-reference/commerce/fulfillment/fulfillment-packs-by-cartons-create"},{"title":"List cartons","api":"GET https://api.stateset.com/api/v1/fulfillment/packs/{id}/cartons","href":"/api-reference/commerce/fulfillment/fulfillment-packs-by-cartons-get"},{"title":"Complete a pack","api":"POST https://api.stateset.com/api/v1/fulfillment/packs/{id}/complete","href":"/api-reference/commerce/fulfillment/fulfillment-packs-by-complete-create"},{"title":"List packs","api":"GET https://api.stateset.com/api/v1/fulfillment/packs","href":"/api-reference/commerce/fulfillment/fulfillment-packs-list"},{"title":"Assign a pick","api":"POST https://api.stateset.com/api/v1/fulfillment/picks/{id}/assign","href":"/api-reference/commerce/fulfillment/fulfillment-picks-by-assign-create"},{"title":"Complete a pick","api":"POST https://api.stateset.com/api/v1/fulfillment/picks/{id}/complete","href":"/api-reference/commerce/fulfillment/fulfillment-picks-by-complete-create"},{"title":"List picks","api":"GET https://api.stateset.com/api/v1/fulfillment/picks","href":"/api-reference/commerce/fulfillment/fulfillment-picks-list"},{"title":"Complete a ship","api":"POST https://api.stateset.com/api/v1/fulfillment/ships/{id}/complete","href":"/api-reference/commerce/fulfillment/fulfillment-ships-by-complete-create"},{"title":"List ships","api":"GET https://api.stateset.com/api/v1/fulfillment/ships","href":"/api-reference/commerce/fulfillment/fulfillment-ships-list"},{"title":"Get a wave","api":"GET https://api.stateset.com/api/v1/fulfillment/waves/{id}","href":"/api-reference/commerce/fulfillment/fulfillment-waves-by-get"},{"title":"Release a wave","api":"POST https://api.stateset.com/api/v1/fulfillment/waves/{id}/release","href":"/api-reference/commerce/fulfillment/fulfillment-waves-by-release-create"},{"title":"Create a wave","api":"POST https://api.stateset.com/api/v1/fulfillment/waves","href":"/api-reference/commerce/fulfillment/fulfillment-waves-create"},{"title":"List waves","api":"GET https://api.stateset.com/api/v1/fulfillment/waves","href":"/api-reference/commerce/fulfillment/fulfillment-waves-list"}]},{"group":"Shipments","pages":[{"title":"Deliver shipment","api":"POST https://api.stateset.com/api/v1/shipments/{id}/deliver","href":"/api-reference/commerce/shipments/shipments-by-deliver-create"},{"title":"Get a shipment","api":"GET https://api.stateset.com/api/v1/shipments/{id}","href":"/api-reference/commerce/shipments/shipments-by-get"},{"title":"Create a shipment","api":"POST https://api.stateset.com/api/v1/shipments","href":"/api-reference/commerce/shipments/shipments-create"},{"title":"List shipments","api":"GET https://api.stateset.com/api/v1/shipments","href":"/api-reference/commerce/shipments/shipments-list"}]},{"group":"Shipping","pages":[{"title":"Delete a zone","api":"DELETE https://api.stateset.com/api/v1/shipping-zones/{id}","href":"/api-reference/commerce/shipping/shipping-zones-by-delete"},{"title":"Get a zone","api":"GET https://api.stateset.com/api/v1/shipping-zones/{id}","href":"/api-reference/commerce/shipping/shipping-zones-by-get"},{"title":"Create a zone","api":"POST https://api.stateset.com/api/v1/shipping-zones","href":"/api-reference/commerce/shipping/shipping-zones-create"},{"title":"List zones","api":"GET https://api.stateset.com/api/v1/shipping-zones","href":"/api-reference/commerce/shipping/shipping-zones-list"}]},{"group":"Receiving","pages":[{"title":"Complete a put away","api":"POST https://api.stateset.com/api/v1/put-aways/{id}/complete","href":"/api-reference/commerce/receiving/put-aways-by-complete-create"},{"title":"Get a put away","api":"GET https://api.stateset.com/api/v1/put-aways/{id}","href":"/api-reference/commerce/receiving/put-aways-by-get"},{"title":"Create a put away","api":"POST https://api.stateset.com/api/v1/put-aways","href":"/api-reference/commerce/receiving/put-aways-create"},{"title":"List put aways","api":"GET https://api.stateset.com/api/v1/put-aways","href":"/api-reference/commerce/receiving/put-aways-list"},{"title":"Cancel a receipt","api":"POST https://api.stateset.com/api/v1/receipts/{id}/cancel","href":"/api-reference/commerce/receiving/receipts-by-cancel-create"},{"title":"Complete a receipt","api":"POST https://api.stateset.com/api/v1/receipts/{id}/complete","href":"/api-reference/commerce/receiving/receipts-by-complete-create"},{"title":"Get a receipt","api":"GET https://api.stateset.com/api/v1/receipts/{id}","href":"/api-reference/commerce/receiving/receipts-by-get"},{"title":"Receipt items","api":"GET https://api.stateset.com/api/v1/receipts/{id}/items","href":"/api-reference/commerce/receiving/receipts-by-items-get"},{"title":"Receipt receive items","api":"POST https://api.stateset.com/api/v1/receipts/{id}/receive","href":"/api-reference/commerce/receiving/receipts-by-receive-create"},{"title":"Receipt start","api":"POST https://api.stateset.com/api/v1/receipts/{id}/start","href":"/api-reference/commerce/receiving/receipts-by-start-create"},{"title":"Create a receipt","api":"POST https://api.stateset.com/api/v1/receipts","href":"/api-reference/commerce/receiving/receipts-create"},{"title":"List receipts","api":"GET https://api.stateset.com/api/v1/receipts","href":"/api-reference/commerce/receiving/receipts-list"}]},{"group":"Inbound Shipments","pages":[{"title":"Mark arrived","api":"POST https://api.stateset.com/api/v1/inbound-shipments/{id}/arrived","href":"/api-reference/commerce/inbound_shipments/inbound-shipments-by-arrived-create"},{"title":"Cancel an inbound shipment","api":"POST https://api.stateset.com/api/v1/inbound-shipments/{id}/cancel","href":"/api-reference/commerce/inbound_shipments/inbound-shipments-by-cancel-create"},{"title":"Get an inbound shipment","api":"GET https://api.stateset.com/api/v1/inbound-shipments/{id}","href":"/api-reference/commerce/inbound_shipments/inbound-shipments-by-get"},{"title":"Mark in transit","api":"POST https://api.stateset.com/api/v1/inbound-shipments/{id}/in-transit","href":"/api-reference/commerce/inbound_shipments/inbound-shipments-by-in-transit-create"},{"title":"Receive an inbound shipment","api":"POST https://api.stateset.com/api/v1/inbound-shipments/{id}/receive","href":"/api-reference/commerce/inbound_shipments/inbound-shipments-by-receive-create"},{"title":"Create an inbound shipment","api":"POST https://api.stateset.com/api/v1/inbound-shipments","href":"/api-reference/commerce/inbound_shipments/inbound-shipments-create"},{"title":"List inbound shipments","api":"GET https://api.stateset.com/api/v1/inbound-shipments","href":"/api-reference/commerce/inbound_shipments/inbound-shipments-list"}]},{"group":"Returns","pages":[{"title":"Approve a return","api":"PATCH https://api.stateset.com/api/v1/returns/{id}/approve","href":"/api-reference/commerce/returns/returns-by-approve-update"},{"title":"Get a return","api":"GET https://api.stateset.com/api/v1/returns/{id}","href":"/api-reference/commerce/returns/returns-by-get"},{"title":"Create a return","api":"POST https://api.stateset.com/api/v1/returns","href":"/api-reference/commerce/returns/returns-create"},{"title":"List returns","api":"GET https://api.stateset.com/api/v1/returns","href":"/api-reference/commerce/returns/returns-list"},{"title":"Return item set disposition","api":"POST https://api.stateset.com/api/v1/returns/{id}/items/{item_id}/disposition","href":"/api-reference/commerce/returns/returns-by-items-by-disposition-create"},{"title":"Returns","href":"/object-reference/returns/object"}]},{"group":"Vendor Returns","pages":[{"title":"Cancel a vendor return","api":"POST https://api.stateset.com/api/v1/vendor-returns/{id}/cancel","href":"/api-reference/commerce/vendor_returns/vendor-returns-by-cancel-create"},{"title":"Get a vendor return","api":"GET https://api.stateset.com/api/v1/vendor-returns/{id}","href":"/api-reference/commerce/vendor_returns/vendor-returns-by-get"},{"title":"Process","api":"POST https://api.stateset.com/api/v1/vendor-returns/{id}/process","href":"/api-reference/commerce/vendor_returns/vendor-returns-by-process-create"},{"title":"Submit a vendor return","api":"POST https://api.stateset.com/api/v1/vendor-returns/{id}/submit","href":"/api-reference/commerce/vendor_returns/vendor-returns-by-submit-create"},{"title":"Create a vendor return","api":"POST https://api.stateset.com/api/v1/vendor-returns","href":"/api-reference/commerce/vendor_returns/vendor-returns-create"},{"title":"List vendor returns","api":"GET https://api.stateset.com/api/v1/vendor-returns","href":"/api-reference/commerce/vendor_returns/vendor-returns-list"}]},{"group":"Warranties","pages":[{"title":"Get a warranty","api":"GET https://api.stateset.com/api/v1/warranties/{id}","href":"/api-reference/commerce/warranties/warranties-by-get"},{"title":"Create a warranty","api":"POST https://api.stateset.com/api/v1/warranties","href":"/api-reference/commerce/warranties/warranties-create"},{"title":"List warranties","api":"GET https://api.stateset.com/api/v1/warranties","href":"/api-reference/commerce/warranties/warranties-list"}]}]},{"group":"Manufacturing \u0026 Quality","pages":[{"group":"Work Orders","pages":[{"title":"Cancel a work order","api":"POST https://api.stateset.com/api/v1/work-orders/{id}/cancel","href":"/api-reference/commerce/work_orders/work-orders-by-cancel-create"},{"title":"Complete a work order","api":"POST https://api.stateset.com/api/v1/work-orders/{id}/complete","href":"/api-reference/commerce/work_orders/work-orders-by-complete-create"},{"title":"Get a work order","api":"GET https://api.stateset.com/api/v1/work-orders/{id}","href":"/api-reference/commerce/work_orders/work-orders-by-get"},{"title":"Hold (/api/v1/work-orders/{id}/hold)","api":"POST https://api.stateset.com/api/v1/work-orders/{id}/hold","href":"/api-reference/commerce/work_orders/work-orders-by-hold-create"},{"title":"Resume","api":"POST https://api.stateset.com/api/v1/work-orders/{id}/resume","href":"/api-reference/commerce/work_orders/work-orders-by-resume-create"},{"title":"Start","api":"POST https://api.stateset.com/api/v1/work-orders/{id}/start","href":"/api-reference/commerce/work_orders/work-orders-by-start-create"},{"title":"Add a task","api":"POST https://api.stateset.com/api/v1/work-orders/{id}/tasks","href":"/api-reference/commerce/work_orders/work-orders-by-tasks-create"},{"title":"List tasks","api":"GET https://api.stateset.com/api/v1/work-orders/{id}/tasks","href":"/api-reference/commerce/work_orders/work-orders-by-tasks-get"},{"title":"Update a work order","api":"PUT https://api.stateset.com/api/v1/work-orders/{id}","href":"/api-reference/commerce/work_orders/work-orders-by-update"},{"title":"Create a work order","api":"POST https://api.stateset.com/api/v1/work-orders","href":"/api-reference/commerce/work_orders/work-orders-create"},{"title":"List work orders","api":"GET https://api.stateset.com/api/v1/work-orders","href":"/api-reference/commerce/work_orders/work-orders-list"},{"title":"Complete a task","api":"POST https://api.stateset.com/api/v1/work-orders/tasks/{task_id}/complete","href":"/api-reference/commerce/work_orders/work-orders-tasks-by-complete-create"},{"title":"Start task","api":"POST https://api.stateset.com/api/v1/work-orders/tasks/{task_id}/start","href":"/api-reference/commerce/work_orders/work-orders-tasks-by-start-create"}]},{"group":"BOM","pages":[{"title":"Activate a BOM","api":"POST https://api.stateset.com/api/v1/boms/{id}/activate","href":"/api-reference/commerce/bom/boms-by-activate-create"},{"title":"Add a component","api":"POST https://api.stateset.com/api/v1/boms/{id}/components","href":"/api-reference/commerce/bom/boms-by-components-create"},{"title":"List components","api":"GET https://api.stateset.com/api/v1/boms/{id}/components","href":"/api-reference/commerce/bom/boms-by-components-get"},{"title":"Delete a BOM","api":"DELETE https://api.stateset.com/api/v1/boms/{id}","href":"/api-reference/commerce/bom/boms-by-delete"},{"title":"Get a BOM","api":"GET https://api.stateset.com/api/v1/boms/{id}","href":"/api-reference/commerce/bom/boms-by-get"},{"title":"Update a BOM","api":"PUT https://api.stateset.com/api/v1/boms/{id}","href":"/api-reference/commerce/bom/boms-by-update"},{"title":"Create a BOM","api":"POST https://api.stateset.com/api/v1/boms","href":"/api-reference/commerce/bom/boms-create"},{"title":"List BOMs","api":"GET https://api.stateset.com/api/v1/boms","href":"/api-reference/commerce/bom/boms-list"}]},{"group":"Production Batches","pages":[{"title":"Delete a production batch","api":"DELETE https://api.stateset.com/api/v1/production-batches/{id}","href":"/api-reference/commerce/production_batches/production-batches-by-delete"},{"title":"Get a production batch","api":"GET https://api.stateset.com/api/v1/production-batches/{id}","href":"/api-reference/commerce/production_batches/production-batches-by-get"},{"title":"Add a work order","api":"POST https://api.stateset.com/api/v1/production-batches/{id}/work-orders","href":"/api-reference/commerce/production_batches/production-batches-by-work-orders-create"},{"title":"Create a production batch","api":"POST https://api.stateset.com/api/v1/production-batches","href":"/api-reference/commerce/production_batches/production-batches-create"},{"title":"List production batches","api":"GET https://api.stateset.com/api/v1/production-batches","href":"/api-reference/commerce/production_batches/production-batches-list"}]},{"group":"Quality","pages":[{"title":"Get a hold","api":"GET https://api.stateset.com/api/v1/quality/holds/{id}","href":"/api-reference/commerce/quality/quality-holds-by-get"},{"title":"Release a hold","api":"POST https://api.stateset.com/api/v1/quality/holds/{id}/release","href":"/api-reference/commerce/quality/quality-holds-by-release-create"},{"title":"Create a hold","api":"POST https://api.stateset.com/api/v1/quality/holds","href":"/api-reference/commerce/quality/quality-holds-create"},{"title":"List holds","api":"GET https://api.stateset.com/api/v1/quality/holds","href":"/api-reference/commerce/quality/quality-holds-list"},{"title":"Complete an inspection","api":"POST https://api.stateset.com/api/v1/quality/inspections/{id}/complete","href":"/api-reference/commerce/quality/quality-inspections-by-complete-create"},{"title":"Get an inspection","api":"GET https://api.stateset.com/api/v1/quality/inspections/{id}","href":"/api-reference/commerce/quality/quality-inspections-by-get"},{"title":"Record inspection result","api":"POST https://api.stateset.com/api/v1/quality/inspections/{id}/results","href":"/api-reference/commerce/quality/quality-inspections-by-results-create"},{"title":"Start inspection","api":"POST https://api.stateset.com/api/v1/quality/inspections/{id}/start","href":"/api-reference/commerce/quality/quality-inspections-by-start-create"},{"title":"Create an inspection","api":"POST https://api.stateset.com/api/v1/quality/inspections","href":"/api-reference/commerce/quality/quality-inspections-create"},{"title":"List inspections","api":"GET https://api.stateset.com/api/v1/quality/inspections","href":"/api-reference/commerce/quality/quality-inspections-list"},{"title":"Close a ncr","api":"POST https://api.stateset.com/api/v1/quality/ncrs/{id}/close","href":"/api-reference/commerce/quality/quality-ncrs-by-close-create"},{"title":"Disposition ncr","api":"POST https://api.stateset.com/api/v1/quality/ncrs/{id}/disposition","href":"/api-reference/commerce/quality/quality-ncrs-by-disposition-create"},{"title":"Get a ncr","api":"GET https://api.stateset.com/api/v1/quality/ncrs/{id}","href":"/api-reference/commerce/quality/quality-ncrs-by-get"},{"title":"Create a ncr","api":"POST https://api.stateset.com/api/v1/quality/ncrs","href":"/api-reference/commerce/quality/quality-ncrs-create"},{"title":"List ncrs","api":"GET https://api.stateset.com/api/v1/quality/ncrs","href":"/api-reference/commerce/quality/quality-ncrs-list"}]}]},{"group":"Procurement","pages":[{"group":"Purchase Orders","pages":[{"title":"Acknowledge","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/acknowledge","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-acknowledge-create"},{"title":"Approve a purchase order","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/approve","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-approve-create"},{"title":"Cancel a purchase order","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/cancel","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-cancel-create"},{"title":"Complete a purchase order","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/complete","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-complete-create"},{"title":"Get a purchase order","api":"GET https://api.stateset.com/api/v1/purchase-orders/{id}","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-get"},{"title":"Hold","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/hold","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-hold-create"},{"title":"Get an item","api":"GET https://api.stateset.com/api/v1/purchase-orders/{id}/items","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-items-get"},{"title":"Receive a purchase order","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/receive","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-receive-create"},{"title":"Send a purchase order","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/send","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-send-create"},{"title":"Submit a purchase order","api":"POST https://api.stateset.com/api/v1/purchase-orders/{id}/submit","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-submit-create"},{"title":"Update a purchase order","api":"PUT https://api.stateset.com/api/v1/purchase-orders/{id}","href":"/api-reference/commerce/purchase_orders/purchase-orders-by-update"},{"title":"Create a purchase order","api":"POST https://api.stateset.com/api/v1/purchase-orders","href":"/api-reference/commerce/purchase_orders/purchase-orders-create"},{"title":"List purchase orders","api":"GET https://api.stateset.com/api/v1/purchase-orders","href":"/api-reference/commerce/purchase_orders/purchase-orders-list"},{"title":"Delete a supplier","api":"DELETE https://api.stateset.com/api/v1/suppliers/{id}","href":"/api-reference/commerce/purchase_orders/suppliers-by-delete"},{"title":"Get a supplier","api":"GET https://api.stateset.com/api/v1/suppliers/{id}","href":"/api-reference/commerce/purchase_orders/suppliers-by-get"},{"title":"Update a supplier","api":"PUT https://api.stateset.com/api/v1/suppliers/{id}","href":"/api-reference/commerce/purchase_orders/suppliers-by-update"},{"title":"Create a supplier","api":"POST https://api.stateset.com/api/v1/suppliers","href":"/api-reference/commerce/purchase_orders/suppliers-create"},{"title":"List suppliers","api":"GET https://api.stateset.com/api/v1/suppliers","href":"/api-reference/commerce/purchase_orders/suppliers-list"}]},{"group":"Supplier SKUs","pages":[{"title":"Delete a supplier SKUs","api":"DELETE https://api.stateset.com/api/v1/supplier-skus/{id}","href":"/api-reference/commerce/supplier_skus/supplier-skus-by-delete"},{"title":"Get a supplier SKUs","api":"GET https://api.stateset.com/api/v1/supplier-skus/{id}","href":"/api-reference/commerce/supplier_skus/supplier-skus-by-get"},{"title":"Create a supplier SKUs","api":"POST https://api.stateset.com/api/v1/supplier-skus","href":"/api-reference/commerce/supplier_skus/supplier-skus-create"},{"title":"List supplier SKUs","api":"GET https://api.stateset.com/api/v1/supplier-skus","href":"/api-reference/commerce/supplier_skus/supplier-skus-list"}]},{"group":"Vendor Credits","pages":[{"title":"Apply a vendor credit","api":"POST https://api.stateset.com/api/v1/vendor-credits/{id}/apply","href":"/api-reference/commerce/vendor_credits/vendor-credits-by-apply-create"},{"title":"Cancel a vendor credit","api":"POST https://api.stateset.com/api/v1/vendor-credits/{id}/cancel","href":"/api-reference/commerce/vendor_credits/vendor-credits-by-cancel-create"},{"title":"Get a vendor credit","api":"GET https://api.stateset.com/api/v1/vendor-credits/{id}","href":"/api-reference/commerce/vendor_credits/vendor-credits-by-get"},{"title":"Create a vendor credit","api":"POST https://api.stateset.com/api/v1/vendor-credits","href":"/api-reference/commerce/vendor_credits/vendor-credits-create"},{"title":"List vendor credits","api":"GET https://api.stateset.com/api/v1/vendor-credits","href":"/api-reference/commerce/vendor_credits/vendor-credits-list"}]}]},{"group":"Financials","pages":[{"group":"General Ledger","pages":[{"title":"Get an account","api":"GET https://api.stateset.com/api/v1/gl/accounts/{id}","href":"/api-reference/commerce/general_ledger/gl-accounts-by-get"},{"title":"Create an account","api":"POST https://api.stateset.com/api/v1/gl/accounts","href":"/api-reference/commerce/general_ledger/gl-accounts-create"},{"title":"List accounts","api":"GET https://api.stateset.com/api/v1/gl/accounts","href":"/api-reference/commerce/general_ledger/gl-accounts-list"},{"title":"Balance sheet","api":"GET https://api.stateset.com/api/v1/gl/balance-sheet","href":"/api-reference/commerce/general_ledger/gl-balance-sheet-list"},{"title":"Close a month","api":"POST https://api.stateset.com/api/v1/gl/close-month","href":"/api-reference/commerce/general_ledger/gl-close-month-create"},{"title":"Income statement","api":"GET https://api.stateset.com/api/v1/gl/income-statement","href":"/api-reference/commerce/general_ledger/gl-income-statement-list"},{"title":"Get a journal entry","api":"GET https://api.stateset.com/api/v1/gl/journal-entries/{id}","href":"/api-reference/commerce/general_ledger/gl-journal-entries-by-get"},{"title":"Post a journal entry","api":"POST https://api.stateset.com/api/v1/gl/journal-entries/{id}/post","href":"/api-reference/commerce/general_ledger/gl-journal-entries-by-post-create"},{"title":"Reverse a journal entry","api":"POST https://api.stateset.com/api/v1/gl/journal-entries/{id}/reverse","href":"/api-reference/commerce/general_ledger/gl-journal-entries-by-reverse-create"},{"title":"Void a journal entry","api":"POST https://api.stateset.com/api/v1/gl/journal-entries/{id}/void","href":"/api-reference/commerce/general_ledger/gl-journal-entries-by-void-create"},{"title":"Create a journal entry","api":"POST https://api.stateset.com/api/v1/gl/journal-entries","href":"/api-reference/commerce/general_ledger/gl-journal-entries-create"},{"title":"List journal entries","api":"GET https://api.stateset.com/api/v1/gl/journal-entries","href":"/api-reference/commerce/general_ledger/gl-journal-entries-list"},{"title":"Close a period","api":"POST https://api.stateset.com/api/v1/gl/periods/{id}/close","href":"/api-reference/commerce/general_ledger/gl-periods-by-close-create"},{"title":"Lock a period","api":"POST https://api.stateset.com/api/v1/gl/periods/{id}/lock","href":"/api-reference/commerce/general_ledger/gl-periods-by-lock-create"},{"title":"Open a period","api":"POST https://api.stateset.com/api/v1/gl/periods/{id}/open","href":"/api-reference/commerce/general_ledger/gl-periods-by-open-create"},{"title":"Reopen a period","api":"POST https://api.stateset.com/api/v1/gl/periods/{id}/reopen","href":"/api-reference/commerce/general_ledger/gl-periods-by-reopen-create"},{"title":"Create a period","api":"POST https://api.stateset.com/api/v1/gl/periods","href":"/api-reference/commerce/general_ledger/gl-periods-create"},{"title":"List periods","api":"GET https://api.stateset.com/api/v1/gl/periods","href":"/api-reference/commerce/general_ledger/gl-periods-list"},{"title":"Revalue a general ledger","api":"POST https://api.stateset.com/api/v1/gl/revalue","href":"/api-reference/commerce/general_ledger/gl-revalue-create"},{"title":"Trial balance","api":"GET https://api.stateset.com/api/v1/gl/trial-balance","href":"/api-reference/commerce/general_ledger/gl-trial-balance-list"}]},{"group":"Accounts Payable","pages":[{"title":"Ap aging","api":"GET https://api.stateset.com/api/v1/ap/aging","href":"/api-reference/commerce/accounts_payable/ap-aging-list"},{"title":"Ap approve bill","api":"POST https://api.stateset.com/api/v1/ap/bills/{id}/approve","href":"/api-reference/commerce/accounts_payable/ap-bills-by-approve-create"},{"title":"Ap cancel bill","api":"POST https://api.stateset.com/api/v1/ap/bills/{id}/cancel","href":"/api-reference/commerce/accounts_payable/ap-bills-by-cancel-create"},{"title":"Ap dispute bill","api":"POST https://api.stateset.com/api/v1/ap/bills/{id}/dispute","href":"/api-reference/commerce/accounts_payable/ap-bills-by-dispute-create"},{"title":"Ap get bill","api":"GET https://api.stateset.com/api/v1/ap/bills/{id}","href":"/api-reference/commerce/accounts_payable/ap-bills-by-get"},{"title":"Ap three way match bill","api":"GET https://api.stateset.com/api/v1/ap/bills/{id}/three-way-match","href":"/api-reference/commerce/accounts_payable/ap-bills-by-three-way-match-get"},{"title":"Ap create bill","api":"POST https://api.stateset.com/api/v1/ap/bills","href":"/api-reference/commerce/accounts_payable/ap-bills-create"},{"title":"Ap list bills","api":"GET https://api.stateset.com/api/v1/ap/bills","href":"/api-reference/commerce/accounts_payable/ap-bills-list"},{"title":"Ap approve payment run","api":"POST https://api.stateset.com/api/v1/ap/payment-runs/{id}/approve","href":"/api-reference/commerce/accounts_payable/ap-payment-runs-by-approve-create"},{"title":"Ap cancel payment run","api":"POST https://api.stateset.com/api/v1/ap/payment-runs/{id}/cancel","href":"/api-reference/commerce/accounts_payable/ap-payment-runs-by-cancel-create"},{"title":"Ap process payment run","api":"POST https://api.stateset.com/api/v1/ap/payment-runs/{id}/process","href":"/api-reference/commerce/accounts_payable/ap-payment-runs-by-process-create"},{"title":"Ap create payment run","api":"POST https://api.stateset.com/api/v1/ap/payment-runs","href":"/api-reference/commerce/accounts_payable/ap-payment-runs-create"},{"title":"Ap void payment","api":"POST https://api.stateset.com/api/v1/ap/payments/{id}/void","href":"/api-reference/commerce/accounts_payable/ap-payments-by-void-create"},{"title":"Ap create payment","api":"POST https://api.stateset.com/api/v1/ap/payments","href":"/api-reference/commerce/accounts_payable/ap-payments-create"}]},{"group":"Accounts Receivable","pages":[{"title":"Ar customer aging","api":"GET https://api.stateset.com/api/v1/ar/aging/customers/{customer_id}","href":"/api-reference/commerce/accounts_receivable/ar-aging-customers-by-get"},{"title":"Ar aging report","api":"GET https://api.stateset.com/api/v1/ar/aging/customers","href":"/api-reference/commerce/accounts_receivable/ar-aging-customers-list"},{"title":"Ar aging summary","api":"GET https://api.stateset.com/api/v1/ar/aging","href":"/api-reference/commerce/accounts_receivable/ar-aging-list"},{"title":"Ar record collection activity","api":"POST https://api.stateset.com/api/v1/ar/collection-activities","href":"/api-reference/commerce/accounts_receivable/ar-collection-activities-create"},{"title":"Ar list collection activities","api":"GET https://api.stateset.com/api/v1/ar/collection-activities","href":"/api-reference/commerce/accounts_receivable/ar-collection-activities-list"},{"title":"Ar apply credit memo","api":"POST https://api.stateset.com/api/v1/ar/credit-memos/{id}/apply","href":"/api-reference/commerce/accounts_receivable/ar-credit-memos-by-apply-create"},{"title":"Ar create credit memo","api":"POST https://api.stateset.com/api/v1/ar/credit-memos","href":"/api-reference/commerce/accounts_receivable/ar-credit-memos-create"},{"title":"Ar list credit memos","api":"GET https://api.stateset.com/api/v1/ar/credit-memos","href":"/api-reference/commerce/accounts_receivable/ar-credit-memos-list"},{"title":"Ar customer statement","api":"GET https://api.stateset.com/api/v1/ar/customers/{customer_id}/statement","href":"/api-reference/commerce/accounts_receivable/ar-customers-by-statement-get"},{"title":"Ar invoices due for dunning","api":"GET https://api.stateset.com/api/v1/ar/dunning/due","href":"/api-reference/commerce/accounts_receivable/ar-dunning-due-list"},{"title":"Ar send dunning","api":"POST https://api.stateset.com/api/v1/ar/invoices/{invoice_id}/dunning","href":"/api-reference/commerce/accounts_receivable/ar-invoices-by-dunning-create"},{"title":"Ar unapply payment","api":"POST https://api.stateset.com/api/v1/ar/payment-applications/{id}/unapply","href":"/api-reference/commerce/accounts_receivable/ar-payment-applications-by-unapply-create"},{"title":"Ar apply payment","api":"POST https://api.stateset.com/api/v1/ar/payment-applications","href":"/api-reference/commerce/accounts_receivable/ar-payment-applications-create"},{"title":"Ar reverse write off","api":"POST https://api.stateset.com/api/v1/ar/write-offs/{id}/reverse","href":"/api-reference/commerce/accounts_receivable/ar-write-offs-by-reverse-create"},{"title":"Ar create write off","api":"POST https://api.stateset.com/api/v1/ar/write-offs","href":"/api-reference/commerce/accounts_receivable/ar-write-offs-create"}]},{"group":"Invoices","pages":[{"title":"Get an invoice","api":"GET https://api.stateset.com/api/v1/invoices/{id}","href":"/api-reference/commerce/invoices/invoices-by-get"},{"title":"Record invoice payment","api":"POST https://api.stateset.com/api/v1/invoices/{id}/payments","href":"/api-reference/commerce/invoices/invoices-by-payments-create"},{"title":"Send an invoice","api":"POST https://api.stateset.com/api/v1/invoices/{id}/send","href":"/api-reference/commerce/invoices/invoices-by-send-create"},{"title":"Create an invoice","api":"POST https://api.stateset.com/api/v1/invoices","href":"/api-reference/commerce/invoices/invoices-create"},{"title":"List invoices","api":"GET https://api.stateset.com/api/v1/invoices","href":"/api-reference/commerce/invoices/invoices-list"}]},{"group":"Payments","pages":[{"title":"Complete a payment","api":"POST https://api.stateset.com/api/v1/payments/{id}/complete","href":"/api-reference/commerce/payments/payments-by-complete-create"},{"title":"Get a payment","api":"GET https://api.stateset.com/api/v1/payments/{id}","href":"/api-reference/commerce/payments/payments-by-get"},{"title":"Refund a create","api":"POST https://api.stateset.com/api/v1/payments/{id}/refund","href":"/api-reference/commerce/payments/payments-by-refund-create"},{"title":"Create a payment","api":"POST https://api.stateset.com/api/v1/payments","href":"/api-reference/commerce/payments/payments-create"},{"title":"List payments","api":"GET https://api.stateset.com/api/v1/payments","href":"/api-reference/commerce/payments/payments-list"}]},{"group":"Payment Obligations","pages":[{"title":"Link bill","api":"POST https://api.stateset.com/api/v1/payment-obligations/{id}/bills","href":"/api-reference/commerce/payment_obligations/payment-obligations-by-bills-create"},{"title":"Get a payment obligation","api":"GET https://api.stateset.com/api/v1/payment-obligations/{id}","href":"/api-reference/commerce/payment_obligations/payment-obligations-by-get"},{"title":"Record payment (/api/v1/payment-obligations/{id}/payments)","api":"POST https://api.stateset.com/api/v1/payment-obligations/{id}/payments","href":"/api-reference/commerce/payment_obligations/payment-obligations-by-payments-create"},{"title":"Set status (/api/v1/payment-obligations/{id}/status)","api":"POST https://api.stateset.com/api/v1/payment-obligations/{id}/status","href":"/api-reference/commerce/payment_obligations/payment-obligations-by-status-create"},{"title":"Create a payment obligation","api":"POST https://api.stateset.com/api/v1/payment-obligations","href":"/api-reference/commerce/payment_obligations/payment-obligations-create"},{"title":"Dashboard","api":"GET https://api.stateset.com/api/v1/payment-obligations/dashboard","href":"/api-reference/commerce/payment_obligations/payment-obligations-dashboard-list"},{"title":"List payment obligations","api":"GET https://api.stateset.com/api/v1/payment-obligations","href":"/api-reference/commerce/payment_obligations/payment-obligations-list"}]},{"group":"Prepayments","pages":[{"title":"Apply a prepayment","api":"POST https://api.stateset.com/api/v1/prepayments/{id}/apply","href":"/api-reference/commerce/prepayments/prepayments-by-apply-create"},{"title":"Get a prepayment","api":"GET https://api.stateset.com/api/v1/prepayments/{id}","href":"/api-reference/commerce/prepayments/prepayments-by-get"},{"title":"Refund a prepayment","api":"POST https://api.stateset.com/api/v1/prepayments/{id}/refund","href":"/api-reference/commerce/prepayments/prepayments-by-refund-create"},{"title":"Create a prepayment","api":"POST https://api.stateset.com/api/v1/prepayments","href":"/api-reference/commerce/prepayments/prepayments-create"},{"title":"List prepayments","api":"GET https://api.stateset.com/api/v1/prepayments","href":"/api-reference/commerce/prepayments/prepayments-list"}]},{"group":"Fixed Assets","pages":[{"title":"Dispose","api":"POST https://api.stateset.com/api/v1/fixed-assets/{id}/dispose","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-dispose-create"},{"title":"Get a fixed asset","api":"GET https://api.stateset.com/api/v1/fixed-assets/{id}","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-get"},{"title":"Place in service","api":"POST https://api.stateset.com/api/v1/fixed-assets/{id}/place-in-service","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-place-in-service-create"},{"title":"Post a depreciation","api":"POST https://api.stateset.com/api/v1/fixed-assets/{id}/post-depreciation","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-post-depreciation-create"},{"title":"Generate schedule","api":"POST https://api.stateset.com/api/v1/fixed-assets/{id}/schedule","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-schedule-create"},{"title":"Get a schedule","api":"GET https://api.stateset.com/api/v1/fixed-assets/{id}/schedule","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-schedule-get"},{"title":"Update a fixed asset","api":"PUT https://api.stateset.com/api/v1/fixed-assets/{id}","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-update"},{"title":"Write off","api":"POST https://api.stateset.com/api/v1/fixed-assets/{id}/write-off","href":"/api-reference/commerce/fixed_assets/fixed-assets-by-write-off-create"},{"title":"Create a fixed asset","api":"POST https://api.stateset.com/api/v1/fixed-assets","href":"/api-reference/commerce/fixed_assets/fixed-assets-create"},{"title":"List fixed assets","api":"GET https://api.stateset.com/api/v1/fixed-assets","href":"/api-reference/commerce/fixed_assets/fixed-assets-list"}]},{"group":"Revenue Recognition","pages":[{"title":"Get a contract","api":"GET https://api.stateset.com/api/v1/revenue-contracts/{id}","href":"/api-reference/commerce/revenue_recognition/revenue-contracts-by-get"},{"title":"List obligations","api":"GET https://api.stateset.com/api/v1/revenue-contracts/{id}/obligations","href":"/api-reference/commerce/revenue_recognition/revenue-contracts-by-obligations-get"},{"title":"Update a contract","api":"PUT https://api.stateset.com/api/v1/revenue-contracts/{id}","href":"/api-reference/commerce/revenue_recognition/revenue-contracts-by-update"},{"title":"Create a contract","api":"POST https://api.stateset.com/api/v1/revenue-contracts","href":"/api-reference/commerce/revenue_recognition/revenue-contracts-create"},{"title":"List contracts","api":"GET https://api.stateset.com/api/v1/revenue-contracts","href":"/api-reference/commerce/revenue_recognition/revenue-contracts-list"},{"title":"Recognize","api":"POST https://api.stateset.com/api/v1/revenue-obligations/{id}/recognize","href":"/api-reference/commerce/revenue_recognition/revenue-obligations-by-recognize-create"},{"title":"Generate schedule (/api/v1/revenue-obligations/{id}/schedule)","api":"POST https://api.stateset.com/api/v1/revenue-obligations/{id}/schedule","href":"/api-reference/commerce/revenue_recognition/revenue-obligations-by-schedule-create"},{"title":"Get a schedule (/api/v1/revenue-obligations/{id}/schedule)","api":"GET https://api.stateset.com/api/v1/revenue-obligations/{id}/schedule","href":"/api-reference/commerce/revenue_recognition/revenue-obligations-by-schedule-get"}]},{"group":"Currency","pages":[{"title":"Convert currency","api":"POST https://api.stateset.com/api/v1/currencies/convert","href":"/api-reference/commerce/currency/currencies-convert-create"},{"title":"Set rate","api":"POST https://api.stateset.com/api/v1/currencies/rates","href":"/api-reference/commerce/currency/currencies-rates-create"},{"title":"List rates","api":"GET https://api.stateset.com/api/v1/currencies/rates","href":"/api-reference/commerce/currency/currencies-rates-list"}]},{"group":"Reports","pages":[{"title":"Check close readiness","api":"POST https://api.stateset.com/api/v1/reports/close-the-books","href":"/api-reference/commerce/reports/reports-close-the-books-create"},{"title":"Calculate consumption","api":"POST https://api.stateset.com/api/v1/reports/consumption","href":"/api-reference/commerce/reports/reports-consumption-create"},{"title":"Calculate inventory aging","api":"POST https://api.stateset.com/api/v1/reports/inventory-aging","href":"/api-reference/commerce/reports/reports-inventory-aging-create"},{"title":"Summarize sales by channel","api":"POST https://api.stateset.com/api/v1/reports/sales-by-channel","href":"/api-reference/commerce/reports/reports-sales-by-channel-create"},{"title":"Calculate transaction cost of goods","api":"POST https://api.stateset.com/api/v1/reports/transaction-cogs","href":"/api-reference/commerce/reports/reports-transaction-cogs-create"}]}]},{"group":"Agents \u0026 Protocols","pages":[{"group":"A2A","pages":[{"title":"Charge credit","api":"POST https://api.stateset.com/api/v1/a2a/credit/{id}/charge","href":"/api-reference/commerce/a2a/a2a-credit-by-charge-create"},{"title":"Get a term","api":"GET https://api.stateset.com/api/v1/a2a/credit/{id}","href":"/api-reference/commerce/a2a/a2a-credit-by-get"},{"title":"Record payment","api":"POST https://api.stateset.com/api/v1/a2a/credit/{id}/payment","href":"/api-reference/commerce/a2a/a2a-credit-by-payment-create"},{"title":"Create a term","api":"POST https://api.stateset.com/api/v1/a2a/credit","href":"/api-reference/commerce/a2a/a2a-credit-create"},{"title":"List terms","api":"GET https://api.stateset.com/api/v1/a2a/credit","href":"/api-reference/commerce/a2a/a2a-credit-list"},{"title":"Acknowledge message","api":"POST https://api.stateset.com/api/v1/a2a/messages/{id}/acknowledge","href":"/api-reference/commerce/a2a/a2a-messages-by-acknowledge-create"},{"title":"Send a message","api":"POST https://api.stateset.com/api/v1/a2a/messages","href":"/api-reference/commerce/a2a/a2a-messages-create"},{"title":"List messages","api":"GET https://api.stateset.com/api/v1/a2a/messages","href":"/api-reference/commerce/a2a/a2a-messages-list"}]},{"group":"Negotiations","pages":[{"title":"Accept negotiation","api":"POST https://api.stateset.com/api/v1/negotiations/{id}/accept","href":"/api-reference/commerce/negotiations/negotiations-by-accept-create"},{"title":"Counter offer","api":"POST https://api.stateset.com/api/v1/negotiations/{id}/counter-offer","href":"/api-reference/commerce/negotiations/negotiations-by-counter-offer-create"},{"title":"Get a negotiation","api":"GET https://api.stateset.com/api/v1/negotiations/{id}","href":"/api-reference/commerce/negotiations/negotiations-by-get"},{"title":"Reject a negotiation","api":"POST https://api.stateset.com/api/v1/negotiations/{id}/reject","href":"/api-reference/commerce/negotiations/negotiations-by-reject-create"},{"title":"Create a negotiation","api":"POST https://api.stateset.com/api/v1/negotiations","href":"/api-reference/commerce/negotiations/negotiations-create"}]},{"group":"EDI Documents","pages":[{"title":"Get an EDI document","api":"GET https://api.stateset.com/api/v1/edi-documents/{id}","href":"/api-reference/commerce/edi_documents/edi-documents-by-get"},{"title":"Set status","api":"POST https://api.stateset.com/api/v1/edi-documents/{id}/status","href":"/api-reference/commerce/edi_documents/edi-documents-by-status-create"},{"title":"Create an EDI document","api":"POST https://api.stateset.com/api/v1/edi-documents","href":"/api-reference/commerce/edi_documents/edi-documents-create"},{"title":"List EDI documents","api":"GET https://api.stateset.com/api/v1/edi-documents","href":"/api-reference/commerce/edi_documents/edi-documents-list"},{"title":"Summary","api":"GET https://api.stateset.com/api/v1/edi-documents/summary","href":"/api-reference/commerce/edi_documents/edi-documents-summary-list"}]},{"group":"Events","pages":[{"title":"Event stream","api":"GET https://api.stateset.com/api/v1/events/stream","href":"/api-reference/commerce/events/events-stream-list"}]}]},{"group":"Platform","pages":[{"group":"Products","pages":[{"title":"Delete a product","api":"DELETE https://api.stateset.com/api/v1/products/{id}","href":"/api-reference/commerce/products/products-by-delete"},{"title":"Get a product","api":"GET https://api.stateset.com/api/v1/products/{id}","href":"/api-reference/commerce/products/products-by-get"},{"title":"Update a product","api":"PATCH https://api.stateset.com/api/v1/products/{id}","href":"/api-reference/commerce/products/products-by-update"},{"title":"Create a product","api":"POST https://api.stateset.com/api/v1/products","href":"/api-reference/commerce/products/products-create"},{"title":"List products","api":"GET https://api.stateset.com/api/v1/products","href":"/api-reference/commerce/products/products-list"}]},{"group":"Integration Mappings","pages":[{"title":"Create a bulk (/api/v1/integration-mappings/bulk)","api":"POST https://api.stateset.com/api/v1/integration-mappings/bulk","href":"/api-reference/commerce/integration_mappings/integration-mappings-bulk-create"},{"title":"Delete an integration mapping","api":"DELETE https://api.stateset.com/api/v1/integration-mappings/{id}","href":"/api-reference/commerce/integration_mappings/integration-mappings-by-delete"},{"title":"Get an integration mapping","api":"GET https://api.stateset.com/api/v1/integration-mappings/{id}","href":"/api-reference/commerce/integration_mappings/integration-mappings-by-get"},{"title":"Update an integration mapping","api":"PUT https://api.stateset.com/api/v1/integration-mappings/{id}","href":"/api-reference/commerce/integration_mappings/integration-mappings-by-update"},{"title":"Create an integration mapping","api":"POST https://api.stateset.com/api/v1/integration-mappings","href":"/api-reference/commerce/integration_mappings/integration-mappings-create"},{"title":"List integration mappings","api":"GET https://api.stateset.com/api/v1/integration-mappings","href":"/api-reference/commerce/integration_mappings/integration-mappings-list"},{"title":"Resolve an integration mapping","api":"GET https://api.stateset.com/api/v1/integration-mappings/resolve","href":"/api-reference/commerce/integration_mappings/integration-mappings-resolve-list"}]},{"group":"Integration Field Mappings","pages":[{"title":"Create a bulk","api":"POST https://api.stateset.com/api/v1/integration-field-mappings/bulk","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-bulk-create"},{"title":"Delete a bulk","api":"DELETE https://api.stateset.com/api/v1/integration-field-mappings/bulk","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-bulk-delete"},{"title":"Delete an integration field mapping","api":"DELETE https://api.stateset.com/api/v1/integration-field-mappings/{id}","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-by-delete"},{"title":"Get an integration field mapping","api":"GET https://api.stateset.com/api/v1/integration-field-mappings/{id}","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-by-get"},{"title":"Update an integration field mapping","api":"PUT https://api.stateset.com/api/v1/integration-field-mappings/{id}","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-by-update"},{"title":"Create an integration field mapping","api":"POST https://api.stateset.com/api/v1/integration-field-mappings","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-create"},{"title":"Groups","api":"GET https://api.stateset.com/api/v1/integration-field-mappings/groups","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-groups-list"},{"title":"List integration field mappings","api":"GET https://api.stateset.com/api/v1/integration-field-mappings","href":"/api-reference/commerce/integration_field_mappings/integration-field-mappings-list"}]},{"group":"Activity Logs","pages":[{"title":"History","api":"GET https://api.stateset.com/api/v1/activity-logs/{subject_type}/{subject_id}","href":"/api-reference/commerce/activity_logs/activity-logs-by-by-get"},{"title":"Get an activity log","api":"GET https://api.stateset.com/api/v1/activity-logs/{id}","href":"/api-reference/commerce/activity_logs/activity-logs-by-get"},{"title":"Record","api":"POST https://api.stateset.com/api/v1/activity-logs","href":"/api-reference/commerce/activity_logs/activity-logs-create"},{"title":"List activity logs","api":"GET https://api.stateset.com/api/v1/activity-logs","href":"/api-reference/commerce/activity_logs/activity-logs-list"}]},{"group":"Purgatory","pages":[{"title":"Delete a purgatory","api":"DELETE https://api.stateset.com/api/v1/purgatory/orders/{id}","href":"/api-reference/commerce/purgatory/purgatory-orders-by-delete"},{"title":"Get a purgatory","api":"GET https://api.stateset.com/api/v1/purgatory/orders/{id}","href":"/api-reference/commerce/purgatory/purgatory-orders-by-get"},{"title":"Map line","api":"POST https://api.stateset.com/api/v1/purgatory/orders/{id}/lines/{line_id}","href":"/api-reference/commerce/purgatory/purgatory-orders-by-lines-by-create"},{"title":"Post an order","api":"POST https://api.stateset.com/api/v1/purgatory/orders/{id}/post","href":"/api-reference/commerce/purgatory/purgatory-orders-by-post-create"},{"title":"Ingest","api":"POST https://api.stateset.com/api/v1/purgatory/orders","href":"/api-reference/commerce/purgatory/purgatory-orders-create"},{"title":"List purgatories","api":"GET https://api.stateset.com/api/v1/purgatory/orders","href":"/api-reference/commerce/purgatory/purgatory-orders-list"}]},{"group":"Topology Snapshots","pages":[{"title":"Delete a topology snapshot","api":"DELETE https://api.stateset.com/api/v1/topology-snapshots/{id}","href":"/api-reference/commerce/topology_snapshots/topology-snapshots-by-delete"},{"title":"Get a topology snapshot","api":"GET https://api.stateset.com/api/v1/topology-snapshots/{id}","href":"/api-reference/commerce/topology_snapshots/topology-snapshots-by-get"},{"title":"Capture (/api/v1/topology-snapshots)","api":"POST https://api.stateset.com/api/v1/topology-snapshots","href":"/api-reference/commerce/topology_snapshots/topology-snapshots-create"},{"title":"Latest (/api/v1/topology-snapshots/latest)","api":"GET https://api.stateset.com/api/v1/topology-snapshots/latest","href":"/api-reference/commerce/topology_snapshots/topology-snapshots-latest-list"},{"title":"List topology snapshots","api":"GET https://api.stateset.com/api/v1/topology-snapshots","href":"/api-reference/commerce/topology_snapshots/topology-snapshots-list"}]},{"group":"Health","pages":[{"title":"Deep health","api":"GET https://api.stateset.com/health/deep","href":"/api-reference/commerce/health/health-deep-list"},{"title":"Health","api":"GET https://api.stateset.com/health","href":"/api-reference/commerce/health/health-list"},{"title":"Readiness","api":"GET https://api.stateset.com/health/ready","href":"/api-reference/commerce/health/health-ready-list"},{"title":"Metrics","api":"GET https://api.stateset.com/metrics","href":"/api-reference/commerce/health/metrics-list"},{"title":"Version","api":"GET https://api.stateset.com/version","href":"/api-reference/commerce/health/version-list"}]}]},{"group":"A2A","pages":[{"title":"List entries","api":"GET https://api.stateset.com/api/v1/a2a/credit/{id}/entries","href":"/api-reference/commerce/a2a/a2a-credit-by-entries-get"},{"title":"Fail message","api":"POST https://api.stateset.com/api/v1/a2a/messages/{id}/fail","href":"/api-reference/commerce/a2a/a2a-messages-by-fail-create"},{"title":"Get a message","api":"GET https://api.stateset.com/api/v1/a2a/messages/{id}","href":"/api-reference/commerce/a2a/a2a-messages-by-get"}]},{"group":"Inventory","pages":[{"title":"Create a reservation","api":"POST https://api.stateset.com/api/v1/inventory/{sku}/reservations","href":"/api-reference/commerce/inventory/inventory-by-reservations-create"},{"title":"Confirm a reservation","api":"POST https://api.stateset.com/api/v1/inventory/reservations/{reservation_id}/confirm","href":"/api-reference/commerce/inventory/inventory-reservations-by-confirm-create"},{"title":"Get a reservation","api":"GET https://api.stateset.com/api/v1/inventory/reservations/{reservation_id}","href":"/api-reference/commerce/inventory/inventory-reservations-by-get"},{"title":"Release a reservation","api":"POST https://api.stateset.com/api/v1/inventory/reservations/{reservation_id}/release","href":"/api-reference/commerce/inventory/inventory-reservations-by-release-create"},{"title":"Expire reservations","api":"POST https://api.stateset.com/api/v1/inventory/reservations/expire","href":"/api-reference/commerce/inventory/inventory-reservations-expire-create"},{"title":"List reservations","api":"GET https://api.stateset.com/api/v1/inventory/reservations","href":"/api-reference/commerce/inventory/inventory-reservations-list"},{"title":"Run sweeps","api":"POST https://api.stateset.com/api/v1/inventory/sweeps/run","href":"/api-reference/commerce/inventory/inventory-sweeps-run-create"}]},{"group":"Governed audit","pages":[{"title":"Audit checkpoint","api":"GET https://api.stateset.com/api/v1/kernel/audit/checkpoint","href":"/api-reference/commerce/kernel/kernel-audit-checkpoint-list"},{"title":"Verify audit chain","api":"GET https://api.stateset.com/api/v1/kernel/audit","href":"/api-reference/commerce/kernel/kernel-audit-list"}]},{"group":"Lots","pages":[{"title":"Genealogy","api":"GET https://api.stateset.com/api/v1/lots/{id}/genealogy","href":"/api-reference/commerce/lots/lots-by-genealogy-get"}]},{"group":"Returns","pages":[{"title":"Complete a return","api":"PATCH https://api.stateset.com/api/v1/returns/{id}/complete","href":"/api-reference/commerce/returns/returns-by-complete-update"},{"title":"Reject a return","api":"PATCH https://api.stateset.com/api/v1/returns/{id}/reject","href":"/api-reference/commerce/returns/returns-by-reject-update"},{"title":"Update a return","api":"PATCH https://api.stateset.com/api/v1/returns/{id}","href":"/api-reference/commerce/returns/returns-by-update"}]},{"group":"Shipments","pages":[{"title":"Cancel before carrier handoff, retaining shipment items and tracking history.","api":"POST https://api.stateset.com/api/v1/shipments/{id}/cancel","href":"/api-reference/commerce/shipments/shipments-by-cancel-create"},{"title":"Remove a manifest item belonging to this shipment. Requires delete permission.","api":"DELETE https://api.stateset.com/api/v1/shipments/{id}/items/{item_id}","href":"/api-reference/commerce/shipments/shipments-by-items-by-delete"},{"title":"Add manifest contents while packing, using native order allocation guards.","api":"POST https://api.stateset.com/api/v1/shipments/{id}/items","href":"/api-reference/commerce/shipments/shipments-by-items-create"},{"title":"Patch one native shipment without skipping lifecycle guards.","api":"PATCH https://api.stateset.com/api/v1/shipments/{id}","href":"/api-reference/commerce/shipments/shipments-by-update"}]},{"group":"Tax exemptions","pages":[{"title":"Get an exemption","api":"GET https://api.stateset.com/api/v1/tax/exemptions/{id}","href":"/api-reference/commerce/tax/tax-exemptions-by-get"},{"title":"Verify exemption","api":"POST https://api.stateset.com/api/v1/tax/exemptions/{id}/verify","href":"/api-reference/commerce/tax/tax-exemptions-by-verify-create"},{"title":"Create an exemption","api":"POST https://api.stateset.com/api/v1/tax/exemptions","href":"/api-reference/commerce/tax/tax-exemptions-create"},{"title":"List exemptions","api":"GET https://api.stateset.com/api/v1/tax/exemptions","href":"/api-reference/commerce/tax/tax-exemptions-list"}]},{"group":"x402 payment intents","pages":[{"title":"Intents for cart","api":"GET https://api.stateset.com/api/v1/x402/carts/{cart_id}/intents","href":"/api-reference/commerce/x402/x402-carts-by-intents-get"},{"title":"Cancel an intent","api":"POST https://api.stateset.com/api/v1/x402/intents/{id}/cancel","href":"/api-reference/commerce/x402/x402-intents-by-cancel-create"},{"title":"Fail intent","api":"POST https://api.stateset.com/api/v1/x402/intents/{id}/fail","href":"/api-reference/commerce/x402/x402-intents-by-fail-create"},{"title":"Get an intent","api":"GET https://api.stateset.com/api/v1/x402/intents/{id}","href":"/api-reference/commerce/x402/x402-intents-by-get"},{"title":"Settle intent","api":"POST https://api.stateset.com/api/v1/x402/intents/{id}/settle","href":"/api-reference/commerce/x402/x402-intents-by-settle-create"},{"title":"Sign intent","api":"POST https://api.stateset.com/api/v1/x402/intents/{id}/sign","href":"/api-reference/commerce/x402/x402-intents-by-sign-create"},{"title":"Create an intent","api":"POST https://api.stateset.com/api/v1/x402/intents","href":"/api-reference/commerce/x402/x402-intents-create"},{"title":"List intents","api":"GET https://api.stateset.com/api/v1/x402/intents","href":"/api-reference/commerce/x402/x402-intents-list"},{"title":"Intents for order","api":"GET https://api.stateset.com/api/v1/x402/orders/{order_id}/intents","href":"/api-reference/commerce/x402/x402-orders-by-intents-get"}]}]},{"tab":"ResponseCX","icon":"headset","groups":[{"group":"Overview","pages":[{"title":"ResponseCX API","href":"/api-reference/responsecx/overview"},{"title":"ResponseCX API history","href":"/api-reference/responsecx/history"}]},{"group":"Workspace","pages":[{"title":"Orientation: agents, configuration state, and a suggested next action","api":"GET https://response.stateset.com/api/v1/workspace","href":"/api-reference/responsecx/workspace-list"}]},{"group":"Agents","pages":[{"title":"Run an agent's eval suite (regression check)","api":"POST https://response.stateset.com/api/v1/agents/{id}/evals/run","href":"/api-reference/responsecx/agents-by-evals-run-create"},{"title":"Give the agent an API-call tool","api":"POST https://response.stateset.com/api/v1/agents/{id}/functions","href":"/api-reference/responsecx/agents-by-functions-create"},{"title":"List an agent's tools","api":"GET https://response.stateset.com/api/v1/agents/{id}/functions","href":"/api-reference/responsecx/agents-by-functions-get"},{"title":"Get one agent, including its instructions","api":"GET https://response.stateset.com/api/v1/agents/{id}","href":"/api-reference/responsecx/agents-by-get"},{"title":"Attach a guardrail rule","api":"POST https://response.stateset.com/api/v1/agents/{id}/rules","href":"/api-reference/responsecx/agents-by-rules-create"},{"title":"List an agent's guardrail rules","api":"GET https://response.stateset.com/api/v1/agents/{id}/rules","href":"/api-reference/responsecx/agents-by-rules-get"},{"title":"Read an agent's model and behaviour settings","api":"GET https://response.stateset.com/api/v1/agents/{id}/settings","href":"/api-reference/responsecx/agents-by-settings-get"},{"title":"Set model, temperature, token limits and escalation behaviour","api":"PUT https://response.stateset.com/api/v1/agents/{id}/settings","href":"/api-reference/responsecx/agents-by-settings-update"},{"title":"Update an agent; set activated:true to launch it","api":"PATCH https://response.stateset.com/api/v1/agents/{id}","href":"/api-reference/responsecx/agents-by-update"},{"title":"Create an agent","api":"POST https://response.stateset.com/api/v1/agents","href":"/api-reference/responsecx/agents-create"},{"title":"List agents","api":"GET https://response.stateset.com/api/v1/agents","href":"/api-reference/responsecx/agents-list"},{"title":"Build a complete agent — rules, tools and settings — in one atomic call","api":"POST https://response.stateset.com/api/v1/agents/provision","href":"/api-reference/responsecx/agents-provision-create"}]},{"group":"Rules","pages":[{"title":"Get one rule","api":"GET https://response.stateset.com/api/v1/rules/{id}","href":"/api-reference/responsecx/rules-by-get"},{"title":"Update a rule; activated:false retires it","api":"PATCH https://response.stateset.com/api/v1/rules/{id}","href":"/api-reference/responsecx/rules-by-update"}]},{"group":"Functions","pages":[{"title":"Get one tool","api":"GET https://response.stateset.com/api/v1/functions/{id}","href":"/api-reference/responsecx/functions-by-get"},{"title":"Probe a tool's endpoint and report whether it works","api":"POST https://response.stateset.com/api/v1/functions/{id}/test","href":"/api-reference/responsecx/functions-by-test-create"},{"title":"Update a tool; activated:false retires it","api":"PATCH https://response.stateset.com/api/v1/functions/{id}","href":"/api-reference/responsecx/functions-by-update"}]},{"group":"Knowledge","pages":[{"title":"Remove an obsolete knowledge document (not reversible)","api":"DELETE https://response.stateset.com/api/v1/knowledge/{id}","href":"/api-reference/responsecx/knowledge-by-delete"},{"title":"Correct a knowledge document in place","api":"PATCH https://response.stateset.com/api/v1/knowledge/{id}","href":"/api-reference/responsecx/knowledge-by-update"},{"title":"Add a knowledge-base document (near-duplicates update in place)","api":"POST https://response.stateset.com/api/v1/knowledge","href":"/api-reference/responsecx/knowledge-create"},{"title":"List stored knowledge documents","api":"GET https://response.stateset.com/api/v1/knowledge","href":"/api-reference/responsecx/knowledge-list"},{"title":"Semantic search over the knowledge base","api":"POST https://response.stateset.com/api/v1/knowledge/search","href":"/api-reference/responsecx/knowledge-search-create"}]},{"group":"Conversations","pages":[{"title":"Read one conversation with its message transcript","api":"GET https://response.stateset.com/api/v1/conversations/{id}","href":"/api-reference/responsecx/conversations-by-get"},{"title":"List recent customer conversations","api":"GET https://response.stateset.com/api/v1/conversations","href":"/api-reference/responsecx/conversations-list"}]},{"group":"Responses","pages":[{"title":"Get one response","api":"GET https://response.stateset.com/api/v1/responses/{id}","href":"/api-reference/responsecx/responses-by-get"},{"title":"List handled response turns","api":"GET https://response.stateset.com/api/v1/responses","href":"/api-reference/responsecx/responses-list"}]},{"group":"Evals","pages":[{"title":"Get one eval","api":"GET https://response.stateset.com/api/v1/evals/{id}","href":"/api-reference/responsecx/evals-by-get"},{"title":"Replay one eval and grade it against the recorded answer","api":"POST https://response.stateset.com/api/v1/evals/{id}/run","href":"/api-reference/responsecx/evals-by-run-create"},{"title":"Record what the agent should have said","api":"POST https://response.stateset.com/api/v1/evals","href":"/api-reference/responsecx/evals-create"},{"title":"List recorded evals (corrections made to agent replies)","api":"GET https://response.stateset.com/api/v1/evals","href":"/api-reference/responsecx/evals-list"}]},{"group":"Analytics","pages":[{"title":"Per-agent volume, AI vs human handling, and human-handled rate","api":"GET https://response.stateset.com/api/v1/analytics/agents","href":"/api-reference/responsecx/analytics-agents-list"},{"title":"Total, AI-handled and human-handled counts over a window","api":"GET https://response.stateset.com/api/v1/analytics/summary","href":"/api-reference/responsecx/analytics-summary-list"}]},{"group":"Integrations","pages":[{"title":"Connect Gorgias with an agent email + REST API key","api":"POST https://response.stateset.com/api/v1/integrations/gorgias","href":"/api-reference/responsecx/integrations-gorgias-create"},{"title":"Shopify and Gorgias connection status (identifiers, never tokens)","api":"GET https://response.stateset.com/api/v1/integrations","href":"/api-reference/responsecx/integrations-list"},{"title":"Connect Shopify with a custom-app Admin API token","api":"POST https://response.stateset.com/api/v1/integrations/shopify","href":"/api-reference/responsecx/integrations-shopify-create"},{"title":"Ground agents from the store: import products, collections and policies","api":"POST https://response.stateset.com/api/v1/integrations/shopify/import-knowledge","href":"/api-reference/responsecx/integrations-shopify-import-knowledge-create"}]},{"group":"Changes","pages":[{"title":"Configuration change log for agents, rules and tools","api":"GET https://response.stateset.com/api/v1/changes","href":"/api-reference/responsecx/changes-list"}]}]},{"tab":"Chat Widget","icon":"message-square","groups":[{"group":"Overview","pages":[{"title":"Chat Widget API","href":"/api-reference/chat-widget/overview"},{"title":"Chat Widget API history","href":"/api-reference/chat-widget/history"}]},{"group":"Chat","pages":[{"title":"Send a chat message (creates the thread when threadId is absent)","api":"POST https://api.example.com/api/chat","href":"/api-reference/chat-widget/chat/api-chat-create"},{"title":"Alias of POST /api/chat","api":"POST https://api.example.com/api/response/stateset","href":"/api-reference/chat-widget/chat/api-response-stateset-create"}]},{"group":"Threads","pages":[{"title":"Alias of DELETE /api/threads/{id}","api":"DELETE https://api.example.com/api/response/threads/{id}","href":"/api-reference/chat-widget/threads/api-response-threads-by-delete"},{"title":"Alias of GET /api/threads/{id}","api":"GET https://api.example.com/api/response/threads/{id}","href":"/api-reference/chat-widget/threads/api-response-threads-by-get"},{"title":"Alias of POST /api/threads/{id}/messages","api":"POST https://api.example.com/api/response/threads/{id}/messages","href":"/api-reference/chat-widget/threads/api-response-threads-by-messages-create"},{"title":"Alias of PATCH /api/threads/{id}","api":"PATCH https://api.example.com/api/response/threads/{id}","href":"/api-reference/chat-widget/threads/api-response-threads-by-update"},{"title":"Alias of POST /api/threads","api":"POST https://api.example.com/api/response/threads","href":"/api-reference/chat-widget/threads/api-response-threads-create"},{"title":"Delete a thread","api":"DELETE https://api.example.com/api/threads/{id}","href":"/api-reference/chat-widget/threads/api-threads-by-delete"},{"title":"Load a thread and its messages","api":"GET https://api.example.com/api/threads/{id}","href":"/api-reference/chat-widget/threads/api-threads-by-get"},{"title":"Append a message to a thread and receive the assistant reply","api":"POST https://api.example.com/api/threads/{id}/messages","href":"/api-reference/chat-widget/threads/api-threads-by-messages-create"},{"title":"Update a thread's subject, title or meta","api":"PATCH https://api.example.com/api/threads/{id}","href":"/api-reference/chat-widget/threads/api-threads-by-update"},{"title":"Create a thread and receive its capability token","api":"POST https://api.example.com/api/threads","href":"/api-reference/chat-widget/threads/api-threads-create"}]},{"group":"Catalog","pages":[{"title":"List or search products","api":"GET https://api.example.com/api/products","href":"/api-reference/chat-widget/catalog/api-products-list"},{"title":"Alias of GET /api/products","api":"GET https://api.example.com/api/products/search","href":"/api-reference/chat-widget/catalog/api-products-search-list"}]},{"group":"Cart","pages":[{"title":"Add a variant to a Shopify cart","api":"POST https://api.example.com/api/cart/add","href":"/api-reference/chat-widget/cart/api-cart-add-create"},{"title":"Record a Shopify cart receipt attributed to a chat conversion","api":"POST https://api.example.com/api/cart-attribution","href":"/api-reference/chat-widget/cart/api-cart-attribution-create"},{"title":"Alias of POST /api/cart/add","api":"POST https://api.example.com/api/shopify/cart/add","href":"/api-reference/chat-widget/cart/api-shopify-cart-add-create"}]},{"group":"Settings","pages":[{"title":"Issue a short-lived token for the deployment-bound storefront","api":"POST https://api.example.com/api/widget/session","href":"/api-reference/chat-widget/settings/api-widget-session-create"},{"title":"Published widget configuration for a site or origin","api":"GET https://api.example.com/api/widget/settings","href":"/api-reference/chat-widget/settings/api-widget-settings-list"}]},{"group":"Feedback","pages":[{"title":"Alias of POST /api/response/feedback","api":"POST https://api.example.com/api/feedback","href":"/api-reference/chat-widget/feedback/api-feedback-create"},{"title":"React to an assistant message (thumbs up/down, optional comment)","api":"POST https://api.example.com/api/response/feedback","href":"/api-reference/chat-widget/feedback/api-response-feedback-create"}]},{"group":"Telemetry","pages":[{"title":"Alias of GET /api/telemetry","api":"GET https://api.example.com/api/response/telemetry","href":"/api-reference/chat-widget/telemetry/api-response-telemetry-list"},{"title":"In-memory request telemetry for an org/agent","api":"GET https://api.example.com/api/telemetry","href":"/api-reference/chat-widget/telemetry/api-telemetry-list"}]},{"group":"Review","pages":[{"title":"Same as GET /api/response/review with parameters in the body","api":"POST https://api.example.com/api/response/review","href":"/api-reference/chat-widget/review/api-response-review-create"},{"title":"Analyze recent stored responses and suggest rule/example drafts","api":"GET https://api.example.com/api/response/review","href":"/api-reference/chat-widget/review/api-response-review-list"},{"title":"Same as GET /api/response/thread-analytics with parameters in the body","api":"POST https://api.example.com/api/response/thread-analytics","href":"/api-reference/chat-widget/review/api-response-thread-analytics-create"},{"title":"Conversation-length analytics over stored responses","api":"GET https://api.example.com/api/response/thread-analytics","href":"/api-reference/chat-widget/review/api-response-thread-analytics-list"}]},{"group":"Analytics","pages":[{"title":"Record a widget analytics event","api":"POST https://api.example.com/api/analytics","href":"/api-reference/chat-widget/analytics/api-analytics-create"}]},{"group":"System","pages":[{"title":"Liveness probe","api":"GET https://api.example.com/api/health","href":"/api-reference/chat-widget/system/api-health-list"},{"title":"Prometheus exposition","api":"GET https://api.example.com/api/metrics","href":"/api-reference/chat-widget/system/api-metrics-list"},{"title":"Readiness probe (503 until stores are initialised)","api":"GET https://api.example.com/api/ready","href":"/api-reference/chat-widget/system/api-ready-list"}]},{"group":"Webhooks","pages":[{"title":"Gorgias HTTP integration webhook (agent replies into the chat thread)","api":"POST https://api.example.com/api/webhooks/gorgias","href":"/api-reference/chat-widget/webhooks/api-webhooks-gorgias-create"},{"title":"Shopify orders webhook (tags chat-attributed orders)","api":"POST https://api.example.com/api/webhooks/shopify/orders","href":"/api-reference/chat-widget/webhooks/api-webhooks-shopify-orders-create"}]},{"group":"Live chat","pages":[{"title":"Take over a native conversation","api":"POST https://api.example.com/api/admin/live-chat/{id}/claim","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-claim-create"},{"title":"Read a native operator conversation","api":"GET https://api.example.com/api/admin/live-chat/{id}","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-get"},{"title":"Renew a native operator claim","api":"POST https://api.example.com/api/admin/live-chat/{id}/heartbeat","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-heartbeat-create"},{"title":"Send a native operator reply","api":"POST https://api.example.com/api/admin/live-chat/{id}/messages","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-messages-create"},{"title":"Save a private operator note","api":"POST https://api.example.com/api/admin/live-chat/{id}/notes","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-notes-create"},{"title":"Read private operator notes","api":"GET https://api.example.com/api/admin/live-chat/{id}/notes","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-notes-get"},{"title":"Return a native conversation to AI","api":"POST https://api.example.com/api/admin/live-chat/{id}/release","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-release-create"},{"title":"Resolve a native conversation","api":"POST https://api.example.com/api/admin/live-chat/{id}/resolve","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-by-resolve-create"},{"title":"List native operator conversations","api":"GET https://api.example.com/api/admin/live-chat","href":"/api-reference/chat-widget/live-chat/api-admin-live-chat-list"}]},{"group":"Admin","pages":[{"title":"Revoke an admin key","api":"DELETE https://api.example.com/api/admin/keys/{id}","href":"/api-reference/chat-widget/admin/api-admin-keys-by-delete"},{"title":"Create an admin key","api":"POST https://api.example.com/api/admin/keys","href":"/api-reference/chat-widget/admin/api-admin-keys-create"},{"title":"List admin keys","api":"GET https://api.example.com/api/admin/keys","href":"/api-reference/chat-widget/admin/api-admin-keys-list"},{"title":"Revoke an OAuth grant","api":"DELETE https://api.example.com/api/admin/oauth/grants/{id}","href":"/api-reference/chat-widget/admin/api-admin-oauth-grants-by-delete"},{"title":"List OAuth grants (MCP connector)","api":"GET https://api.example.com/api/admin/oauth/grants","href":"/api-reference/chat-widget/admin/api-admin-oauth-grants-list"},{"title":"Org record and counts","api":"GET https://api.example.com/api/admin/org","href":"/api-reference/chat-widget/admin/api-admin-org-list"},{"title":"Site-scoped thread analytics","api":"GET https://api.example.com/api/admin/sites/{id}/analytics","href":"/api-reference/chat-widget/admin/api-admin-sites-by-analytics-get"},{"title":"Draft and published config","api":"GET https://api.example.com/api/admin/sites/{id}/config","href":"/api-reference/chat-widget/admin/api-admin-sites-by-config-get"},{"title":"Publish the draft","api":"POST https://api.example.com/api/admin/sites/{id}/config/publish","href":"/api-reference/chat-widget/admin/api-admin-sites-by-config-publish-create"},{"title":"Roll back to a version","api":"POST https://api.example.com/api/admin/sites/{id}/config/rollback","href":"/api-reference/chat-widget/admin/api-admin-sites-by-config-rollback-create"},{"title":"Save the draft config","api":"PUT https://api.example.com/api/admin/sites/{id}/config","href":"/api-reference/chat-widget/admin/api-admin-sites-by-config-update"},{"title":"Read one config version","api":"GET https://api.example.com/api/admin/sites/{id}/config/versions/{version}","href":"/api-reference/chat-widget/admin/api-admin-sites-by-config-versions-by-get"},{"title":"List config versions","api":"GET https://api.example.com/api/admin/sites/{id}/config/versions","href":"/api-reference/chat-widget/admin/api-admin-sites-by-config-versions-get"},{"title":"Delete a site","api":"DELETE https://api.example.com/api/admin/sites/{id}","href":"/api-reference/chat-widget/admin/api-admin-sites-by-delete"},{"title":"Get a site","api":"GET https://api.example.com/api/admin/sites/{id}","href":"/api-reference/chat-widget/admin/api-admin-sites-by-get"},{"title":"Install on a Shopify store","api":"POST https://api.example.com/api/admin/sites/{id}/install/shopify","href":"/api-reference/chat-widget/admin/api-admin-sites-by-install-shopify-create"},{"title":"Generate the install snippet","api":"POST https://api.example.com/api/admin/sites/{id}/install/snippet","href":"/api-reference/chat-widget/admin/api-admin-sites-by-install-snippet-create"},{"title":"Update a site","api":"PATCH https://api.example.com/api/admin/sites/{id}","href":"/api-reference/chat-widget/admin/api-admin-sites-by-update"},{"title":"Verify the live install","api":"GET https://api.example.com/api/admin/sites/{id}/verify","href":"/api-reference/chat-widget/admin/api-admin-sites-by-verify-get"},{"title":"Create a site","api":"POST https://api.example.com/api/admin/sites","href":"/api-reference/chat-widget/admin/api-admin-sites-create"},{"title":"List sites","api":"GET https://api.example.com/api/admin/sites","href":"/api-reference/chat-widget/admin/api-admin-sites-list"}]}]},{"tab":"Voice","icon":"phone","groups":[{"group":"Overview","pages":[{"title":"Voice API","href":"/api-reference/voice/overview"},{"title":"Voice API history","href":"/api-reference/voice/history"}]},{"group":"Calls","pages":[{"title":"Incoming Call","api":"POST https://api.voice.stateset.com/api/v1/incoming-call-sip","href":"/api-reference/voice/calls/incoming-call-sip-create"},{"title":"Make Call","api":"POST https://api.voice.stateset.com/api/v1/make-call","href":"/api-reference/voice/calls/make-call-create"},{"title":"Outbound Call","api":"POST https://api.voice.stateset.com/api/v1/outbound-call-sip","href":"/api-reference/voice/calls/outbound-call-sip-create"},{"title":"Start Translation Call","api":"POST https://api.voice.stateset.com/api/v1/voice/translation-calls","href":"/api-reference/voice/calls/voice-translation-calls-create"}]},{"group":"Voice outcomes","pages":[{"title":"Get Voice Outcome","api":"GET https://api.voice.stateset.com/api/v1/voice-outcomes/{id}","href":"/api-reference/voice/voice_sessions/voice-outcomes-by-get"},{"title":"Get Voice Outcome By Stream","api":"GET https://api.voice.stateset.com/api/v1/voice-outcomes/by-stream/{stream_sid}","href":"/api-reference/voice/voice_sessions/voice-outcomes-by-stream-by-get"},{"title":"List Voice Outcomes","api":"GET https://api.voice.stateset.com/api/v1/voice-outcomes","href":"/api-reference/voice/voice_sessions/voice-outcomes-list"},{"title":"Get Voice Outcome Stats","api":"GET https://api.voice.stateset.com/api/v1/voice-outcomes/stats","href":"/api-reference/voice/voice_sessions/voice-outcomes-stats-list"},{"title":"Get Voice Outcome Timeseries","api":"GET https://api.voice.stateset.com/api/v1/voice-outcomes/timeseries","href":"/api-reference/voice/voice_sessions/voice-outcomes-timeseries-list"},{"title":"Get Voice Session Eval By Session","api":"GET https://api.voice.stateset.com/api/v1/voice-session-evals/by-session/{session_id}","href":"/api-reference/voice/voice_sessions/voice-session-evals-by-session-by-get"},{"title":"List Voice Session Evals","api":"GET https://api.voice.stateset.com/api/v1/voice-session-evals","href":"/api-reference/voice/voice_sessions/voice-session-evals-list"},{"title":"Get Voice Session Eval Stats","api":"GET https://api.voice.stateset.com/api/v1/voice-session-evals/stats","href":"/api-reference/voice/voice_sessions/voice-session-evals-stats-list"},{"title":"Get a voice session by UUID","api":"GET https://api.voice.stateset.com/api/v1/voice-sessions/{id}","href":"/api-reference/voice/voice_sessions/voice-sessions-by-get"},{"title":"Look up a voice session by Twilio stream ID","api":"GET https://api.voice.stateset.com/api/v1/voice-sessions/by-stream/{stream_id}","href":"/api-reference/voice/voice_sessions/voice-sessions-by-stream-by-get"},{"title":"Create a voice session in the phone-server store.","api":"POST https://api.voice.stateset.com/api/v1/voice-sessions","href":"/api-reference/voice/voice_sessions/voice-sessions-create"},{"title":"List persisted voice sessions","api":"GET https://api.voice.stateset.com/api/v1/voice-sessions","href":"/api-reference/voice/voice_sessions/voice-sessions-list"}]},{"group":"Sessions","pages":[{"title":"Session Action","api":"POST https://api.voice.stateset.com/api/v1/sessions/{stream_sid}/actions/{action}","href":"/api-reference/voice/sessions/sessions-by-actions-by-create"},{"title":"List Sessions","api":"GET https://api.voice.stateset.com/api/v1/sessions","href":"/api-reference/voice/sessions/sessions-list"}]},{"group":"Call logs","pages":[{"title":"Get a single call log by ID","api":"GET https://api.voice.stateset.com/api/v1/call-logs/{id}","href":"/api-reference/voice/call_logs/call-logs-by-get"},{"title":"Aggregate per-turn latency percentiles across recent calls.","api":"GET https://api.voice.stateset.com/api/v1/call-logs/latency","href":"/api-reference/voice/call_logs/call-logs-latency-list"},{"title":"List call logs for the authenticated tenant","api":"GET https://api.voice.stateset.com/api/v1/call-logs","href":"/api-reference/voice/call_logs/call-logs-list"},{"title":"Get call statistics for the authenticated tenant","api":"GET https://api.voice.stateset.com/api/v1/call-logs/stats","href":"/api-reference/voice/call_logs/call-logs-stats-list"}]},{"group":"Automations","pages":[{"title":"Send a Loop followup email","api":"POST https://api.voice.stateset.com/api/v1/automations/email/loop-followup","href":"/api-reference/voice/automation/automations-email-loop-followup-create"},{"title":"Escalate a call to a human agent","api":"POST https://api.voice.stateset.com/api/v1/automations/escalate-call","href":"/api-reference/voice/automation/automations-escalate-call-create"},{"title":"Escalate a call using Twilio call bridge","api":"POST https://api.voice.stateset.com/api/v1/automations/escalate-call-with-bridge","href":"/api-reference/voice/automation/automations-escalate-call-with-bridge-create"},{"title":"Send an issue intake SMS","api":"POST https://api.voice.stateset.com/api/v1/automations/sms/issue-intake","href":"/api-reference/voice/automation/automations-sms-issue-intake-create"},{"title":"Send a phone order confirmation SMS","api":"POST https://api.voice.stateset.com/api/v1/automations/sms/phone-order","href":"/api-reference/voice/automation/automations-sms-phone-order-create"},{"title":"Send a post-call survey SMS","api":"POST https://api.voice.stateset.com/api/v1/automations/sms/post-call-survey","href":"/api-reference/voice/automation/automations-sms-post-call-survey-create"},{"title":"Send a tracking SMS to the customer","api":"POST https://api.voice.stateset.com/api/v1/automations/sms/tracking","href":"/api-reference/voice/automation/automations-sms-tracking-create"},{"title":"Send a troubleshooting SMS to the customer","api":"POST https://api.voice.stateset.com/api/v1/automations/sms/troubleshooting","href":"/api-reference/voice/automation/automations-sms-troubleshooting-create"},{"title":"Check if current time is within business hours","api":"POST https://api.voice.stateset.com/api/v1/automations/voice/business-hours","href":"/api-reference/voice/automation/automations-voice-business-hours-create"},{"title":"Evaluate whether a call needs escalation","api":"POST https://api.voice.stateset.com/api/v1/automations/voice/escalation-need","href":"/api-reference/voice/automation/automations-voice-escalation-need-create"},{"title":"Record a voice session evaluation","api":"POST https://api.voice.stateset.com/api/v1/automations/voice/evaluation","href":"/api-reference/voice/automation/automations-voice-evaluation-create"},{"title":"Retrieve a voice session evaluation","api":"POST https://api.voice.stateset.com/api/v1/automations/voice/get-eval","href":"/api-reference/voice/automation/automations-voice-get-eval-create"},{"title":"Test Function","api":"POST https://api.voice.stateset.com/test-function","href":"/api-reference/voice/automation/test-function-create"},{"title":"Tools","api":"GET https://api.voice.stateset.com/tools","href":"/api-reference/voice/automation/tools-list"}]},{"group":"Operations","pages":[{"title":"Acknowledge Callback Task","api":"POST https://api.voice.stateset.com/api/v1/callback-tasks/{id}/acknowledge","href":"/api-reference/voice/operations/callback-tasks-by-acknowledge-create"},{"title":"Assign Callback Task","api":"POST https://api.voice.stateset.com/api/v1/callback-tasks/{id}/assign","href":"/api-reference/voice/operations/callback-tasks-by-assign-create"},{"title":"Claim Callback Task","api":"POST https://api.voice.stateset.com/api/v1/callback-tasks/{id}/claim","href":"/api-reference/voice/operations/callback-tasks-by-claim-create"},{"title":"Get Callback Task","api":"GET https://api.voice.stateset.com/api/v1/callback-tasks/{id}","href":"/api-reference/voice/operations/callback-tasks-by-get"},{"title":"Release Callback Task","api":"POST https://api.voice.stateset.com/api/v1/callback-tasks/{id}/release","href":"/api-reference/voice/operations/callback-tasks-by-release-create"},{"title":"Snooze Callback Task","api":"POST https://api.voice.stateset.com/api/v1/callback-tasks/{id}/snooze","href":"/api-reference/voice/operations/callback-tasks-by-snooze-create"},{"title":"Unsnooze Callback Task","api":"POST https://api.voice.stateset.com/api/v1/callback-tasks/{id}/unsnooze","href":"/api-reference/voice/operations/callback-tasks-by-unsnooze-create"},{"title":"Update Callback Task","api":"PATCH https://api.voice.stateset.com/api/v1/callback-tasks/{id}","href":"/api-reference/voice/operations/callback-tasks-by-update"},{"title":"Create Callback Task","api":"POST https://api.voice.stateset.com/api/v1/callback-tasks","href":"/api-reference/voice/operations/callback-tasks-create"},{"title":"List Callback Tasks","api":"GET https://api.voice.stateset.com/api/v1/callback-tasks","href":"/api-reference/voice/operations/callback-tasks-list"},{"title":"Upsert Operator Queue","api":"PUT https://api.voice.stateset.com/api/v1/operator-queues/{queue_key}","href":"/api-reference/voice/operations/operator-queues-by-update"},{"title":"List Operator Queues","api":"GET https://api.voice.stateset.com/api/v1/operator-queues","href":"/api-reference/voice/operations/operator-queues-list"},{"title":"List Operator Queue Stats","api":"GET https://api.voice.stateset.com/api/v1/operator-queues/stats","href":"/api-reference/voice/operations/operator-queues-stats-list"},{"title":"List Supervisor Actions","api":"GET https://api.voice.stateset.com/api/v1/supervisor-actions","href":"/api-reference/voice/operations/supervisor-actions-list"}]},{"group":"Customer portal","pages":[{"title":"Get agents","api":"GET https://api.voice.stateset.com/api/v1/customer/agent","href":"/api-reference/voice/customer/customer-agent-list"},{"title":"Update Agent","api":"PATCH https://api.voice.stateset.com/api/v1/customer/agent","href":"/api-reference/voice/customer/customer-agent-update"},{"title":"Customer Session Status","api":"GET https://api.voice.stateset.com/api/v1/customer/auth/session","href":"/api-reference/voice/customer/customer-auth-session-list"},{"title":"Create Checkout","api":"POST https://api.voice.stateset.com/api/v1/customer/billing/checkout","href":"/api-reference/voice/customer/customer-billing-checkout-create"},{"title":"List Calls","api":"GET https://api.voice.stateset.com/api/v1/customer/calls","href":"/api-reference/voice/customer/customer-calls-list"},{"title":"Customer Me","api":"GET https://api.voice.stateset.com/api/v1/customer/me","href":"/api-reference/voice/customer/customer-me-list"},{"title":"Purchase","api":"POST https://api.voice.stateset.com/api/v1/customer/numbers","href":"/api-reference/voice/customer/customer-numbers-create"},{"title":"Search","api":"GET https://api.voice.stateset.com/api/v1/customer/numbers/search","href":"/api-reference/voice/customer/customer-numbers-search-list"}]},{"group":"Logs","pages":[{"title":"Logs Ws","api":"GET https://api.voice.stateset.com/api/v1/logs","href":"/api-reference/voice/logs/logs-list"},{"title":"Logs Stats","api":"GET https://api.voice.stateset.com/api/v1/logs/stats","href":"/api-reference/voice/logs/logs-stats-list"}]},{"group":"Voice","pages":[{"title":"List Voice Options","api":"GET https://api.voice.stateset.com/api/v1/voice/voice-options","href":"/api-reference/voice/voice/voice-voice-options-list"}]},{"group":"Media","pages":[{"title":"Handler","api":"GET https://api.voice.stateset.com/media-stream","href":"/api-reference/voice/media/media-stream-list"}]},{"group":"Billing","pages":[{"title":"Handle Webhook","api":"POST https://api.voice.stateset.com/api/v1/stripe/webhook","href":"/api-reference/voice/billing/stripe-webhook-create"}]},{"group":"Health","pages":[{"title":"General health check endpoint","api":"GET https://api.voice.stateset.com/health","href":"/api-reference/voice/health/health-list"},{"title":"Root","api":"GET https://api.voice.stateset.com/status","href":"/api-reference/voice/health/status-list"}]}]},{"tab":"Sandbox","icon":"box","groups":[{"group":"Overview","pages":[{"title":"Sandbox core API","href":"/api-reference/sandbox/overview"}]},{"group":"Sandboxes","pages":[{"title":"Register a new organization","api":"POST https://api.sandbox.stateset.app/api/v1/register","href":"/api-reference/sandbox/register-create"},{"title":"List sandboxes for the authenticated organization","api":"GET https://api.sandbox.stateset.app/api/v1/sandboxes","href":"/api-reference/sandbox/sandboxes-list"}]},{"group":"Create","pages":[{"title":"Create a new sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/create","href":"/api-reference/sandbox/sandbox-create-create"},{"title":"Create sandbox from a template","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/create-from-template","href":"/api-reference/sandbox/sandbox-create-from-template-create"}]},{"group":"Lifecycle","pages":[{"title":"Delete a sandbox (alias for stop)","api":"DELETE https://api.sandbox.stateset.app/api/v1/sandbox/{id}","href":"/api-reference/sandbox/sandbox-by-delete"},{"title":"Extend sandbox expiration window","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/extend","href":"/api-reference/sandbox/sandbox-by-extend-create"},{"title":"Get sandbox details","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}","href":"/api-reference/sandbox/sandbox-by-get"},{"title":"Pause a running sandbox (snapshot mode: durable only; filesystem kept, memory…","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/pause","href":"/api-reference/sandbox/sandbox-by-pause-create"},{"title":"Resume a paused sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/resume","href":"/api-reference/sandbox/sandbox-by-resume-create"},{"title":"Get sandbox status (lightweight)","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/status","href":"/api-reference/sandbox/sandbox-by-status-get"},{"title":"Stop and delete a sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/stop","href":"/api-reference/sandbox/sandbox-by-stop-create"}]},{"group":"Execute","pages":[{"title":"Execute a command in a sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/execute","href":"/api-reference/sandbox/sandbox-by-execute-create"},{"title":"Get execution details","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions/{executionId}","href":"/api-reference/sandbox/sandbox-by-executions-by-get"},{"title":"Stream execution output via SSE","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions/{executionId}/stream","href":"/api-reference/sandbox/sandbox-by-executions-by-stream-get"},{"title":"List executions for a sandbox","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions","href":"/api-reference/sandbox/sandbox-by-executions-get"}]},{"group":"Files","pages":[{"title":"Copy a file or directory","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/copy","href":"/api-reference/sandbox/sandbox-by-files-copy-create"},{"title":"Delete a file or directory from the sandbox","api":"DELETE https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files","href":"/api-reference/sandbox/sandbox-by-files-delete"},{"title":"Download a file from sandbox","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/download","href":"/api-reference/sandbox/sandbox-by-files-download-get"},{"title":"Read a file from a sandbox","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files","href":"/api-reference/sandbox/sandbox-by-files-get"},{"title":"Find files matching a glob pattern","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/glob","href":"/api-reference/sandbox/sandbox-by-files-glob-create"},{"title":"List files in a sandbox directory","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/list","href":"/api-reference/sandbox/sandbox-by-files-list-get"},{"title":"Create a directory in the sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/mkdir","href":"/api-reference/sandbox/sandbox-by-files-mkdir-create"},{"title":"Move or rename a file","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/move","href":"/api-reference/sandbox/sandbox-by-files-move-create"},{"title":"Watch for file changes via SSE","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/watch","href":"/api-reference/sandbox/sandbox-by-files-watch-get"},{"title":"Write files to a sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files","href":"/api-reference/sandbox/sandbox-by-files-create"}]},{"group":"Desktop","pages":[{"title":"Perform a keyboard action (type, key, hotkey)","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/keyboard","href":"/api-reference/sandbox/sandbox-by-keyboard-create"},{"title":"Perform a mouse action (click, move, drag, double-click)","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/mouse","href":"/api-reference/sandbox/sandbox-by-mouse-create"},{"title":"Get screen dimensions of the sandbox desktop","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screen","href":"/api-reference/sandbox/sandbox-by-screen-get"},{"title":"Capture a screenshot with options (format, quality, region)","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot","href":"/api-reference/sandbox/sandbox-by-screenshot-create"},{"title":"Capture a screenshot of the sandbox desktop","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot","href":"/api-reference/sandbox/sandbox-by-screenshot-get"}]},{"group":"Tunnels","pages":[{"title":"Create a tunnel","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/tunnels","href":"/api-reference/sandbox/sandbox-by-tunnels-create"},{"title":"List tunnels","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/tunnels","href":"/api-reference/sandbox/sandbox-by-tunnels-get"},{"title":"Close a tunnel","api":"DELETE https://api.sandbox.stateset.app/api/v1/tunnels/{id}","href":"/api-reference/sandbox/tunnels-by-delete"}]},{"group":"Inference","pages":[{"title":"Proxy an LLM inference request","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/inference","href":"/api-reference/sandbox/sandbox-by-inference-create"}]},{"group":"Secrets","pages":[{"title":"Delete a secret","api":"DELETE https://api.sandbox.stateset.app/api/v1/secrets/{name}","href":"/api-reference/sandbox/secrets-by-delete"},{"title":"Update a secret","api":"PUT https://api.sandbox.stateset.app/api/v1/secrets/{name}","href":"/api-reference/sandbox/secrets-by-update"},{"title":"Create a new secret","api":"POST https://api.sandbox.stateset.app/api/v1/secrets","href":"/api-reference/sandbox/secrets-create"},{"title":"List secrets","api":"GET https://api.sandbox.stateset.app/api/v1/secrets","href":"/api-reference/sandbox/secrets-list"}]},{"group":"API keys","pages":[{"title":"Revoke an API key","api":"DELETE https://api.sandbox.stateset.app/api/v1/api-keys/{id}","href":"/api-reference/sandbox/api-keys-by-delete"},{"title":"Create a new API key","api":"POST https://api.sandbox.stateset.app/api/v1/api-keys","href":"/api-reference/sandbox/api-keys-create"},{"title":"List API keys","api":"GET https://api.sandbox.stateset.app/api/v1/api-keys","href":"/api-reference/sandbox/api-keys-list"}]},{"group":"Usage","pages":[{"title":"Get current billing period usage","api":"GET https://api.sandbox.stateset.app/api/v1/usage/current","href":"/api-reference/sandbox/usage-current-list"},{"title":"Get usage history","api":"GET https://api.sandbox.stateset.app/api/v1/usage/history","href":"/api-reference/sandbox/usage-history-list"}]},{"group":"Webhooks","pages":[{"title":"Register a webhook endpoint","api":"POST https://api.sandbox.stateset.app/api/v1/webhooks","href":"/api-reference/sandbox/webhooks-create"},{"title":"List registered webhooks","api":"GET https://api.sandbox.stateset.app/api/v1/webhooks","href":"/api-reference/sandbox/webhooks-list"}]},{"group":"System","pages":[{"title":"Public service status (no auth required)","api":"GET https://api.sandbox.stateset.app/api/status","href":"/api-reference/sandbox/api-status-list"},{"title":"Health check","api":"GET https://api.sandbox.stateset.app/health","href":"/api-reference/sandbox/health-list"},{"title":"Readiness check","api":"GET https://api.sandbox.stateset.app/ready","href":"/api-reference/sandbox/ready-list"}]},{"group":"History","pages":[{"title":"Sandbox API history","href":"/api-reference/sandbox/history"}]},{"group":"Processes","pages":[{"title":"Kill a supervised process (TERM, then KILL after grace_seconds) and stop…","api":"DELETE https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}","href":"/api-reference/sandbox/sandbox-by-processes-by-delete"},{"title":"Get a supervised process","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}","href":"/api-reference/sandbox/sandbox-by-processes-by-get"},{"title":"Read or follow a process log by absolute byte offset","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/logs","href":"/api-reference/sandbox/sandbox-by-processes-by-logs-get"},{"title":"Read a bounded worker result; incomplete snapshots are safe to read again","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/result","href":"/api-reference/sandbox/sandbox-by-processes-by-result-get"},{"title":"Signal a supervised process group","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/signal","href":"/api-reference/sandbox/sandbox-by-processes-by-signal-create"},{"title":"Write to a supervised process stdin","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/stdin","href":"/api-reference/sandbox/sandbox-by-processes-by-stdin-create"},{"title":"Start a supervised background process","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes","href":"/api-reference/sandbox/sandbox-by-processes-create"},{"title":"List supervised processes","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes","href":"/api-reference/sandbox/sandbox-by-processes-get"}]},{"group":"Task registry","pages":[{"title":"Read server-registered task metadata","api":"GET https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}","href":"/api-reference/sandbox/agent-tasks-by-get"},{"title":"Root owner revokes a task-family grant","api":"DELETE https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}/grants/{principal}","href":"/api-reference/sandbox/agent-tasks-by-grants-by-delete"},{"title":"Root owner reviews current task-family access grants","api":"GET https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}/grants","href":"/api-reference/sandbox/agent-tasks-by-grants-get"},{"title":"Root owner grants viewer or operator access to the task family","api":"PUT https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}/grants","href":"/api-reference/sandbox/agent-tasks-by-grants-update"},{"title":"Register private task metadata with server-checked parent lineage","api":"POST https://api.sandbox.stateset.app/api/v1/agent-tasks","href":"/api-reference/sandbox/agent-tasks-create"},{"title":"List only task families this principal can read","api":"GET https://api.sandbox.stateset.app/api/v1/agent-tasks","href":"/api-reference/sandbox/agent-tasks-list"}]},{"group":"Recovery and branching","pages":[{"title":"Request process-group cancellation from any controller replica","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions/{executionId}/cancel","href":"/api-reference/sandbox/sandbox-by-executions-by-cancel-create"},{"title":"Fork a sandbox from a durable checkpoint","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/fork","href":"/api-reference/sandbox/sandbox-by-fork-create"},{"title":"Restore a sandbox into a different isolation tier","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/promote","href":"/api-reference/sandbox/sandbox-by-promote-create"},{"title":"Delegate a subset of sandbox scopes for at most five minutes","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/self/token","href":"/api-reference/sandbox/sandbox-self-token-create"}]}]},{"tab":"Sync Server","icon":"refresh-cw","groups":[{"group":"Overview","pages":[{"title":"Sync Server API","href":"/api-reference/sync/overview"},{"title":"Sync Server API history","href":"/api-reference/sync/history"}]},{"group":"Sync","pages":[{"title":"Trigger a comprehensive sync across one or more channels.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/all","href":"/api-reference/sync/sync/v1-tenants-by-sync-all-create"},{"title":"Trigger Amazon order sync","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/amazon","href":"/api-reference/sync/sync/v1-tenants-by-sync-amazon-create"},{"title":"Trigger multiple sync channels in a single API call.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/batch","href":"/api-reference/sync/sync/v1-tenants-by-sync-batch-create"},{"title":"Trigger DCL order synchronization","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/dcl","href":"/api-reference/sync/sync/v1-tenants-by-sync-dcl-create"},{"title":"Trigger eBay order sync","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/ebay","href":"/api-reference/sync/sync/v1-tenants-by-sync-ebay-create"},{"title":"Trigger Etsy order sync","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/etsy","href":"/api-reference/sync/sync/v1-tenants-by-sync-etsy-create"},{"title":"Trigger Fishbowl / Tri-Pac order submission, shipment, receipt, and inventory…","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/fishbowl","href":"/api-reference/sync/sync/v1-tenants-by-sync-fishbowl-create"},{"title":"Trigger inventory sync across all platforms","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/inventory","href":"/api-reference/sync/sync/v1-tenants-by-sync-inventory-create"},{"title":"Trigger NetSuite order synchronization","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/netsuite","href":"/api-reference/sync/sync/v1-tenants-by-sync-netsuite-create"},{"title":"Build and dry-run a typed commerce sync plan without side effects.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/plan/dry-run","href":"/api-reference/sync/sync/v1-tenants-by-sync-plan-dry-run-create"},{"title":"Execute a typed commerce sync plan using the configured tenant orchestrators.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/plan/execute","href":"/api-reference/sync/sync/v1-tenants-by-sync-plan-execute-create"},{"title":"Queue a typed commerce sync plan for background execution.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/plan/queue","href":"/api-reference/sync/sync/v1-tenants-by-sync-plan-queue-create"},{"title":"Trigger return/refund processing sync.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/returns","href":"/api-reference/sync/sync/v1-tenants-by-sync-returns-create"},{"title":"Sync a trigger shopify","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/shopify","href":"/api-reference/sync/sync/v1-tenants-by-sync-shopify-create"},{"title":"Trigger Shopware order sync","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/shopware","href":"/api-reference/sync/sync/v1-tenants-by-sync-shopware-create"},{"title":"Trigger StateSet API ERP order synchronization","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/stateset-api","href":"/api-reference/sync/sync/v1-tenants-by-sync-stateset-api-create"},{"title":"Trigger TikTok order sync","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/tiktok","href":"/api-reference/sync/sync/v1-tenants-by-sync-tiktok-create"},{"title":"Trigger Walmart order sync","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/walmart","href":"/api-reference/sync/sync/v1-tenants-by-sync-walmart-create"},{"title":"Trigger WooCommerce order sync","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/woocommerce","href":"/api-reference/sync/sync/v1-tenants-by-sync-woocommerce-create"}]},{"group":"Jobs","pages":[{"title":"Cancel a queued job (operator tooling).","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/jobs/{job_id}/cancel","href":"/api-reference/sync/jobs/v1-tenants-by-jobs-by-cancel-create"},{"title":"Get status of a background job","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/jobs/{job_id}","href":"/api-reference/sync/jobs/v1-tenants-by-jobs-by-get"},{"title":"Manually retry a failed/cancelled job (operator tooling).","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/jobs/{job_id}/retry","href":"/api-reference/sync/jobs/v1-tenants-by-jobs-by-retry-create"},{"title":"List background jobs for a tenant","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/jobs","href":"/api-reference/sync/jobs/v1-tenants-by-jobs-get"},{"title":"Summarize job state counts for a tenant (dashboard helper).","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/jobs/summary","href":"/api-reference/sync/jobs/v1-tenants-by-jobs-summary-get"},{"title":"Job throughput analytics for dashboard charts.","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/jobs/throughput","href":"/api-reference/sync/jobs/v1-tenants-by-jobs-throughput-get"}]},{"group":"Orders","pages":[{"title":"Create multiple orders in one request.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/orders/batch","href":"/api-reference/sync/orders/v1-tenants-by-orders-batch-create"},{"title":"Delete an order","api":"DELETE https://api.sync.stateset.com/v1/tenants/{tenant_id}/orders/{order_id}","href":"/api-reference/sync/orders/v1-tenants-by-orders-by-delete"},{"title":"Update fulfillment status for an order","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/orders/{order_id}/fulfillment","href":"/api-reference/sync/orders/v1-tenants-by-orders-by-fulfillment-create"},{"title":"Get a single order by ID","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/orders/{order_id}","href":"/api-reference/sync/orders/v1-tenants-by-orders-by-get"},{"title":"Update tracking information for an order","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/orders/{order_id}/tracking","href":"/api-reference/sync/orders/v1-tenants-by-orders-by-tracking-create"},{"title":"Create a new order in StateSet","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/orders","href":"/api-reference/sync/orders/v1-tenants-by-orders-create"},{"title":"List orders with filtering and pagination","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/orders","href":"/api-reference/sync/orders/v1-tenants-by-orders-get"}]},{"group":"Inventory","pages":[{"title":"List inventory adjustments (audit trail)","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/inventory/adjustments","href":"/api-reference/sync/inventory/v1-tenants-by-inventory-adjustments-get"},{"title":"Check low stock alerts","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/inventory/alerts","href":"/api-reference/sync/inventory/v1-tenants-by-inventory-alerts-get"},{"title":"Get consolidated inventory across all locations","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/inventory","href":"/api-reference/sync/inventory/v1-tenants-by-inventory-get"},{"title":"Release inventory reservation","api":"DELETE https://api.sync.stateset.com/v1/tenants/{tenant_id}/inventory/reservations/{reservation_id}","href":"/api-reference/sync/inventory/v1-tenants-by-inventory-reservations-by-delete"},{"title":"Reserve inventory for an order","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/inventory/reservations","href":"/api-reference/sync/inventory/v1-tenants-by-inventory-reservations-create"}]},{"group":"Products","pages":[{"title":"Generate or publish a product catalog feed for ChatGPT, TikTok Shop, Google…","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/products/catalog-feed","href":"/api-reference/sync/products/v1-tenants-by-products-catalog-feed-create"},{"title":"Trigger a product sync from a source platform.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/sync/products","href":"/api-reference/sync/products/v1-tenants-by-sync-products-create"}]},{"group":"Cart","pages":[{"title":"Create an order in Cart.com","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/cart/orders","href":"/api-reference/sync/cart/v1-tenants-by-cart-orders-create"}]},{"group":"Webhooks","pages":[{"title":"Handle incoming ACP (Agentic Commerce Protocol) webhooks","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/acp/orders","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-acp-orders-create"},{"title":"Handle incoming Amazon SNS webhooks.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/amazon","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-amazon-create"},{"title":"Delete/deactivate a webhook","api":"DELETE https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/by-id/{webhook_id}","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-by-id-by-delete"},{"title":"Handle incoming eBay webhooks.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/ebay","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-ebay-create"},{"title":"Handle incoming Etsy webhooks.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/etsy","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-etsy-create"},{"title":"List registered webhooks for a tenant","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-get"},{"title":"Register a new webhook","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/register","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-register-create"},{"title":"Handle incoming Shopify webhooks","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/shopify","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-shopify-create"},{"title":"Handle incoming Shopware webhooks.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/shopware","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-shopware-create"},{"title":"Handle incoming TikTok Shop webhooks.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/tiktok","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-tiktok-create"},{"title":"Handle incoming Walmart Marketplace webhooks.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/walmart","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-walmart-create"},{"title":"Handle incoming WooCommerce webhooks.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhooks/woocommerce","href":"/api-reference/sync/webhooks/v1-tenants-by-webhooks-woocommerce-create"}]},{"group":"Webhook events","pages":[{"title":"Get a single webhook event (includes payload).","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhook-events/{webhook_id}","href":"/api-reference/sync/webhook_events/v1-tenants-by-webhook-events-by-get"},{"title":"Replay a webhook event (operator tooling).","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhook-events/{webhook_id}/replay","href":"/api-reference/sync/webhook_events/v1-tenants-by-webhook-events-by-replay-create"},{"title":"List webhook events for a tenant (most recent first).","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhook-events","href":"/api-reference/sync/webhook_events/v1-tenants-by-webhook-events-get"},{"title":"Replay specific webhook events by id (operator tooling).","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhook-events/replay-by-id","href":"/api-reference/sync/webhook_events/v1-tenants-by-webhook-events-replay-by-id-create"},{"title":"Replay multiple webhook events in one request (operator tooling).","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhook-events/replay","href":"/api-reference/sync/webhook_events/v1-tenants-by-webhook-events-replay-create"},{"title":"Summarize webhook event state counts for a tenant (dashboard helper).","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/webhook-events/summary","href":"/api-reference/sync/webhook_events/v1-tenants-by-webhook-events-summary-get"}]},{"group":"Schedules","pages":[{"title":"Delete a schedule.","api":"DELETE https://api.sync.stateset.com/v1/tenants/{tenant_id}/schedules/{schedule_id}","href":"/api-reference/sync/schedules/v1-tenants-by-schedules-by-delete"},{"title":"Update an existing schedule.","api":"PATCH https://api.sync.stateset.com/v1/tenants/{tenant_id}/schedules/{schedule_id}","href":"/api-reference/sync/schedules/v1-tenants-by-schedules-by-update"},{"title":"Create a schedule for a tenant.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/schedules","href":"/api-reference/sync/schedules/v1-tenants-by-schedules-create"},{"title":"List schedules for a tenant.","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/schedules","href":"/api-reference/sync/schedules/v1-tenants-by-schedules-get"}]},{"group":"Integrations","pages":[{"title":"List integrations for a tenant, including last sync + circuit breaker snapshots.","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/integrations","href":"/api-reference/sync/integrations/v1-tenants-by-integrations-get"},{"title":"Run health checks for configured integrations for a tenant.","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/integrations/health","href":"/api-reference/sync/integrations/v1-tenants-by-integrations-health-get"}]},{"group":"NetSuite","pages":[{"title":"Create a NetSuite cash sale","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/netsuite/cash-sales","href":"/api-reference/sync/netsuite/v1-tenants-by-netsuite-cash-sales-create"},{"title":"Batch update custom fields on NetSuite orders","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/netsuite/custom-fields/batch","href":"/api-reference/sync/netsuite/v1-tenants-by-netsuite-custom-fields-batch-create"},{"title":"Create a NetSuite item fulfillment","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/netsuite/item-fulfillments","href":"/api-reference/sync/netsuite/v1-tenants-by-netsuite-item-fulfillments-create"},{"title":"Create a NetSuite sales order","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/netsuite/sales-orders","href":"/api-reference/sync/netsuite/v1-tenants-by-netsuite-sales-orders-create"},{"title":"Search NetSuite sales orders","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/netsuite/sales-orders/search","href":"/api-reference/sync/netsuite/v1-tenants-by-netsuite-sales-orders-search-create"},{"title":"Execute a SuiteQL query against NetSuite","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/netsuite/suiteql","href":"/api-reference/sync/netsuite/v1-tenants-by-netsuite-suiteql-create"}]},{"group":"DCL","pages":[{"title":"Create a batch of orders in DCL","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/dcl/batches","href":"/api-reference/sync/dcl/v1-tenants-by-dcl-batches-create"},{"title":"Fetch PO receipts from DCL","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/dcl/po-receipts","href":"/api-reference/sync/dcl/v1-tenants-by-dcl-po-receipts-create"},{"title":"Create an item receipt in NetSuite from a DCL PO receipt","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/dcl/po-receipts/item-receipts","href":"/api-reference/sync/dcl/v1-tenants-by-dcl-po-receipts-item-receipts-create"},{"title":"Fetch tracking information from DCL","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/dcl/tracking","href":"/api-reference/sync/dcl/v1-tenants-by-dcl-tracking-create"}]},{"group":"ACP","pages":[{"title":"Process ACP order asynchronously as a background job","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/acp/orders/async","href":"/api-reference/sync/acp/v1-tenants-by-acp-orders-async-create"},{"title":"Batch process multiple ACP orders","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/acp/orders/batch","href":"/api-reference/sync/acp/v1-tenants-by-acp-orders-batch-create"},{"title":"Process an ACP order - creates in StateSet and routes to fulfillment/ERP","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/acp/orders","href":"/api-reference/sync/acp/v1-tenants-by-acp-orders-create"}]},{"group":"Agent","pages":[{"title":"Execute a tool by name with parameters.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/agent/execute","href":"/api-reference/sync/agent/v1-tenants-by-agent-execute-create"},{"title":"Handle a JSON-RPC 2.0 request against the MCP surface for a tenant.","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/mcp","href":"/api-reference/sync/agent/v1-tenants-by-mcp-create"}]},{"group":"Audit","pages":[{"title":"List audit-log entries scoped to the caller's tenant.","api":"GET https://api.sync.stateset.com/v1/tenants/{tenant_id}/audit-logs","href":"/api-reference/sync/audit/v1-tenants-by-audit-logs-get"}]},{"group":"Shopify","pages":[{"title":"Register Shopify webhooks for order events","api":"POST https://api.sync.stateset.com/v1/tenants/{tenant_id}/shopify/webhooks/register","href":"/api-reference/sync/shopify/v1-tenants-by-shopify-webhooks-register-create"}]}]},{"tab":"Temporal Engine","icon":"workflow","groups":[{"group":"Overview","pages":[{"title":"Temporal Engine API","href":"/api-reference/temporal/overview"},{"title":"Temporal Engine API history","href":"/api-reference/temporal/history"}]},{"group":"Workflows","pages":[{"title":"Cancel active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-cancel-create"},{"title":"Enqueue active horizon agent task","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/enqueue","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-enqueue-create"},{"title":"Extend active horizon agent budget","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/extend-budget","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-extend-budget-create"},{"title":"Pause active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/pause","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-pause-create"},{"title":"Reprioritize active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/reprioritize","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-reprioritize-create"},{"title":"Resume active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/resume","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-resume-create"},{"title":"Query active horizon agent status","api":"GET https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-status-get"},{"title":"Steer active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/steer","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-steer-create"},{"title":"Terminate active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/{workflow_id}/terminate","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-by-terminate-create"},{"title":"Start active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/start","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-start-create"},{"title":"Validate active horizon agent","api":"POST https://api.workstream.stateset.com/v1/workflows/active-horizon-agent/validate","href":"/api-reference/temporal/workflows/v1-workflows-active-horizon-agent-validate-create"},{"title":"Cancel workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-by-cancel-create"},{"title":"Stream workflow events","api":"GET https://api.workstream.stateset.com/v1/workflows/{workflow_id}/events","href":"/api-reference/temporal/workflows/v1-workflows-by-events-get"},{"title":"Send review signal","api":"POST https://api.workstream.stateset.com/v1/workflows/{workflow_id}/signal/review","href":"/api-reference/temporal/workflows/v1-workflows-by-signal-review-create"},{"title":"Query workflow status","api":"GET https://api.workstream.stateset.com/v1/workflows/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-by-status-get"},{"title":"Terminate workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/{workflow_id}/terminate","href":"/api-reference/temporal/workflows/v1-workflows-by-terminate-create"},{"title":"Start cohort fanout workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/cohort-fanout/start","href":"/api-reference/temporal/workflows/v1-workflows-cohort-fanout-start-create"},{"title":"Cancel connector","api":"POST https://api.workstream.stateset.com/v1/workflows/connector/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-connector-by-cancel-create"},{"title":"Query connector status","api":"GET https://api.workstream.stateset.com/v1/workflows/connector/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-connector-by-status-get"},{"title":"Terminate connector","api":"POST https://api.workstream.stateset.com/v1/workflows/connector/{workflow_id}/terminate","href":"/api-reference/temporal/workflows/v1-workflows-connector-by-terminate-create"},{"title":"Start connector workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/connector/start","href":"/api-reference/temporal/workflows/v1-workflows-connector-start-create"},{"title":"Cancel delivery exception callback","api":"POST https://api.workstream.stateset.com/v1/workflows/delivery-exception-callback/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-delivery-exception-callback-by-cancel-create"},{"title":"Query delivery exception callback status","api":"GET https://api.workstream.stateset.com/v1/workflows/delivery-exception-callback/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-delivery-exception-callback-by-status-get"},{"title":"Start delivery exception callback","api":"POST https://api.workstream.stateset.com/v1/workflows/delivery-exception-callback/start","href":"/api-reference/temporal/workflows/v1-workflows-delivery-exception-callback-start-create"},{"title":"Order fulfillment cancel","api":"POST https://api.workstream.stateset.com/v1/workflows/order-fulfillment/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-order-fulfillment-by-cancel-create"},{"title":"Order fulfillment review","api":"POST https://api.workstream.stateset.com/v1/workflows/order-fulfillment/{workflow_id}/review","href":"/api-reference/temporal/workflows/v1-workflows-order-fulfillment-by-review-create"},{"title":"Order fulfillment status","api":"GET https://api.workstream.stateset.com/v1/workflows/order-fulfillment/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-order-fulfillment-by-status-get"},{"title":"Start order fulfillment","api":"POST https://api.workstream.stateset.com/v1/workflows/order-fulfillment/start","href":"/api-reference/temporal/workflows/v1-workflows-order-fulfillment-start-create"},{"title":"Start payment recovery workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/payment-recovery/start","href":"/api-reference/temporal/workflows/v1-workflows-payment-recovery-start-create"},{"title":"Cancel rav2","api":"POST https://api.workstream.stateset.com/v1/workflows/response-automation-v2/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-response-automation-v2-by-cancel-create"},{"title":"Restart rav2","api":"POST https://api.workstream.stateset.com/v1/workflows/response-automation-v2/{workflow_id}/restart","href":"/api-reference/temporal/workflows/v1-workflows-response-automation-v2-by-restart-create"},{"title":"Send rav2 review signal","api":"POST https://api.workstream.stateset.com/v1/workflows/response-automation-v2/{workflow_id}/review","href":"/api-reference/temporal/workflows/v1-workflows-response-automation-v2-by-review-create"},{"title":"Query rav2 status","api":"GET https://api.workstream.stateset.com/v1/workflows/response-automation-v2/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-response-automation-v2-by-status-get"},{"title":"Terminate rav2","api":"POST https://api.workstream.stateset.com/v1/workflows/response-automation-v2/{workflow_id}/terminate","href":"/api-reference/temporal/workflows/v1-workflows-response-automation-v2-by-terminate-create"},{"title":"Start rav2 workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/response-automation-v2/start","href":"/api-reference/temporal/workflows/v1-workflows-response-automation-v2-start-create"},{"title":"Start workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/response/start","href":"/api-reference/temporal/workflows/v1-workflows-response-start-create"},{"title":"Return workflow cancel","api":"POST https://api.workstream.stateset.com/v1/workflows/return/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-return-by-cancel-create"},{"title":"Return workflow inspection","api":"POST https://api.workstream.stateset.com/v1/workflows/return/{workflow_id}/inspection","href":"/api-reference/temporal/workflows/v1-workflows-return-by-inspection-create"},{"title":"Return workflow receipt","api":"POST https://api.workstream.stateset.com/v1/workflows/return/{workflow_id}/receipt","href":"/api-reference/temporal/workflows/v1-workflows-return-by-receipt-create"},{"title":"Return workflow review","api":"POST https://api.workstream.stateset.com/v1/workflows/return/{workflow_id}/review","href":"/api-reference/temporal/workflows/v1-workflows-return-by-review-create"},{"title":"Return workflow status","api":"GET https://api.workstream.stateset.com/v1/workflows/return/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-return-by-status-get"},{"title":"Start return lifecycle workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/return-lifecycle/start","href":"/api-reference/temporal/workflows/v1-workflows-return-lifecycle-start-create"},{"title":"Start return workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/return/start","href":"/api-reference/temporal/workflows/v1-workflows-return-start-create"},{"title":"Cancel sandbox agent loop","api":"POST https://api.workstream.stateset.com/v1/workflows/sandbox-agent-loop/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-sandbox-agent-loop-by-cancel-create"},{"title":"Query sandbox agent loop status","api":"GET https://api.workstream.stateset.com/v1/workflows/sandbox-agent-loop/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-sandbox-agent-loop-by-status-get"},{"title":"Terminate sandbox agent loop","api":"POST https://api.workstream.stateset.com/v1/workflows/sandbox-agent-loop/{workflow_id}/terminate","href":"/api-reference/temporal/workflows/v1-workflows-sandbox-agent-loop-by-terminate-create"},{"title":"Start sandbox agent loop","api":"POST https://api.workstream.stateset.com/v1/workflows/sandbox-agent-loop/start","href":"/api-reference/temporal/workflows/v1-workflows-sandbox-agent-loop-start-create"},{"title":"Cancel snooze","api":"POST https://api.workstream.stateset.com/v1/workflows/snooze/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-snooze-by-cancel-create"},{"title":"Query snooze status","api":"GET https://api.workstream.stateset.com/v1/workflows/snooze/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-snooze-by-status-get"},{"title":"Terminate snooze","api":"POST https://api.workstream.stateset.com/v1/workflows/snooze/{workflow_id}/terminate","href":"/api-reference/temporal/workflows/v1-workflows-snooze-by-terminate-create"},{"title":"Start retention workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/subscription-retention/start","href":"/api-reference/temporal/workflows/v1-workflows-subscription-retention-start-create"},{"title":"Trigger retention workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/subscription-retention/trigger","href":"/api-reference/temporal/workflows/v1-workflows-subscription-retention-trigger-create"},{"title":"Start support followup workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/support-followup/start","href":"/api-reference/temporal/workflows/v1-workflows-support-followup-start-create"},{"title":"Cancel warranty","api":"POST https://api.workstream.stateset.com/v1/workflows/warranty-automation-v2/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-warranty-automation-v2-by-cancel-create"},{"title":"Send warranty review signal","api":"POST https://api.workstream.stateset.com/v1/workflows/warranty-automation-v2/{workflow_id}/review","href":"/api-reference/temporal/workflows/v1-workflows-warranty-automation-v2-by-review-create"},{"title":"Query warranty status","api":"GET https://api.workstream.stateset.com/v1/workflows/warranty-automation-v2/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-warranty-automation-v2-by-status-get"},{"title":"Start warranty workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/warranty-automation-v2/start","href":"/api-reference/temporal/workflows/v1-workflows-warranty-automation-v2-start-create"},{"title":"Trigger warranty workflow","api":"POST https://api.workstream.stateset.com/v1/workflows/warranty-automation-v2/trigger","href":"/api-reference/temporal/workflows/v1-workflows-warranty-automation-v2-trigger-create"},{"title":"Wholesale order cancel","api":"POST https://api.workstream.stateset.com/v1/workflows/wholesale-order/{workflow_id}/cancel","href":"/api-reference/temporal/workflows/v1-workflows-wholesale-order-by-cancel-create"},{"title":"Wholesale order po change","api":"POST https://api.workstream.stateset.com/v1/workflows/wholesale-order/{workflow_id}/po-change","href":"/api-reference/temporal/workflows/v1-workflows-wholesale-order-by-po-change-create"},{"title":"Wholesale order review","api":"POST https://api.workstream.stateset.com/v1/workflows/wholesale-order/{workflow_id}/review","href":"/api-reference/temporal/workflows/v1-workflows-wholesale-order-by-review-create"},{"title":"Wholesale order shipment","api":"POST https://api.workstream.stateset.com/v1/workflows/wholesale-order/{workflow_id}/shipment","href":"/api-reference/temporal/workflows/v1-workflows-wholesale-order-by-shipment-create"},{"title":"Wholesale order status","api":"GET https://api.workstream.stateset.com/v1/workflows/wholesale-order/{workflow_id}/status","href":"/api-reference/temporal/workflows/v1-workflows-wholesale-order-by-status-get"},{"title":"Start wholesale order","api":"POST https://api.workstream.stateset.com/v1/workflows/wholesale-order/start","href":"/api-reference/temporal/workflows/v1-workflows-wholesale-order-start-create"}]},{"group":"Brands","pages":[{"title":"Activate brand","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/activate","href":"/api-reference/temporal/brands/v1-brands-by-activate-create"},{"title":"Revoke brand api key","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/api-keys/{key_id}/revoke","href":"/api-reference/temporal/brands/v1-brands-by-api-keys-by-revoke-create"},{"title":"Create brand api key","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/api-keys","href":"/api-reference/temporal/brands/v1-brands-by-api-keys-create"},{"title":"List brand api keys","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/api-keys","href":"/api-reference/temporal/brands/v1-brands-by-api-keys-get"},{"title":"Get brand billing contract","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/contract","href":"/api-reference/temporal/brands/v1-brands-by-billing-contract-get"},{"title":"Upsert brand billing contract","api":"PUT https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/contract","href":"/api-reference/temporal/brands/v1-brands-by-billing-contract-update"},{"title":"Get brand billing state","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/billing","href":"/api-reference/temporal/brands/v1-brands-by-billing-get"},{"title":"Close brand billing period","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/periods/{period_id}/close","href":"/api-reference/temporal/brands/v1-brands-by-billing-periods-by-close-create"},{"title":"List brand billing periods","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/periods","href":"/api-reference/temporal/brands/v1-brands-by-billing-periods-get"},{"title":"List brand rated outcomes","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/rated-outcomes","href":"/api-reference/temporal/brands/v1-brands-by-billing-rated-outcomes-get"},{"title":"Get brand billing reconciliation","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/reconciliation","href":"/api-reference/temporal/brands/v1-brands-by-billing-reconciliation-get"},{"title":"Sync brand billing events","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/sync","href":"/api-reference/temporal/brands/v1-brands-by-billing-sync-create"},{"title":"Upsert brand billing profile","api":"PUT https://api.workstream.stateset.com/v1/brands/{brand_id}/billing","href":"/api-reference/temporal/brands/v1-brands-by-billing-update"},{"title":"Apply brand config","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/config/apply","href":"/api-reference/temporal/brands/v1-brands-by-config-apply-create"},{"title":"Config assist","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/config/assist","href":"/api-reference/temporal/brands/v1-brands-by-config-assist-create"},{"title":"Config draft","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/config/draft","href":"/api-reference/temporal/brands/v1-brands-by-config-draft-create"},{"title":"Check brand config drift","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/config/drift","href":"/api-reference/temporal/brands/v1-brands-by-config-drift-get"},{"title":"Config evaluate","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/config/evaluate","href":"/api-reference/temporal/brands/v1-brands-by-config-evaluate-create"},{"title":"Config evaluate golden","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/config/evaluate-golden","href":"/api-reference/temporal/brands/v1-brands-by-config-evaluate-golden-create"},{"title":"Get effective brand config","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/config","href":"/api-reference/temporal/brands/v1-brands-by-config-get"},{"title":"Simulate skip check","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/config/simulate-skip","href":"/api-reference/temporal/brands/v1-brands-by-config-simulate-skip-create"},{"title":"Get brand config version","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/config/versions/{version}","href":"/api-reference/temporal/brands/v1-brands-by-config-versions-by-get"},{"title":"List brand config versions","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/config/versions","href":"/api-reference/temporal/brands/v1-brands-by-config-versions-get"},{"title":"Check connector health","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/connectors/{connector_id}/health","href":"/api-reference/temporal/brands/v1-brands-by-connectors-by-health-create"},{"title":"List brand connectors","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/connectors","href":"/api-reference/temporal/brands/v1-brands-by-connectors-get"},{"title":"Probe connector config","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/connectors/probe","href":"/api-reference/temporal/brands/v1-brands-by-connectors-probe-create"},{"title":"Check brand readiness","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/connectors/readiness","href":"/api-reference/temporal/brands/v1-brands-by-connectors-readiness-get"},{"title":"Resolve dlq item","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/dispatch-dlq/{dlq_id}/resolve","href":"/api-reference/temporal/brands/v1-brands-by-dispatch-dlq-by-resolve-create"},{"title":"Retry dlq item","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/dispatch-dlq/{dlq_id}/retry","href":"/api-reference/temporal/brands/v1-brands-by-dispatch-dlq-by-retry-create"},{"title":"List dispatch dlq","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/dispatch-dlq","href":"/api-reference/temporal/brands/v1-brands-by-dispatch-dlq-get"},{"title":"Brand eval cases","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/eval-cases","href":"/api-reference/temporal/brands/v1-brands-by-eval-cases-get"},{"title":"Get a v1 brands brand ID","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}","href":"/api-reference/temporal/brands/v1-brands-by-get"},{"title":"List brand golden cases","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/golden-cases","href":"/api-reference/temporal/brands/v1-brands-by-golden-cases-get"},{"title":"Get brand migration state","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/migration","href":"/api-reference/temporal/brands/v1-brands-by-migration-get"},{"title":"Update brand migration state","api":"PATCH https://api.workstream.stateset.com/v1/brands/{brand_id}/migration","href":"/api-reference/temporal/brands/v1-brands-by-migration-update"},{"title":"Get onboarding run","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/onboarding/{run_id}","href":"/api-reference/temporal/brands/v1-brands-by-onboarding-by-get"},{"title":"Update onboarding run","api":"PATCH https://api.workstream.stateset.com/v1/brands/{brand_id}/onboarding/{run_id}","href":"/api-reference/temporal/brands/v1-brands-by-onboarding-by-update"},{"title":"Create onboarding run","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/onboarding","href":"/api-reference/temporal/brands/v1-brands-by-onboarding-create"},{"title":"List onboarding runs","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/onboarding","href":"/api-reference/temporal/brands/v1-brands-by-onboarding-get"},{"title":"Transition brand outcome","api":"PATCH https://api.workstream.stateset.com/v1/brands/{brand_id}/outcomes/{outcome_id}","href":"/api-reference/temporal/brands/v1-brands-by-outcomes-by-update"},{"title":"Record brand outcome","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/outcomes","href":"/api-reference/temporal/brands/v1-brands-by-outcomes-create"},{"title":"List brand outcomes","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/outcomes","href":"/api-reference/temporal/brands/v1-brands-by-outcomes-get"},{"title":"Get brand quality scorecard","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/outcomes/scorecard","href":"/api-reference/temporal/brands/v1-brands-by-outcomes-scorecard-get"},{"title":"Get brand outcome summary","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/outcomes/summary","href":"/api-reference/temporal/brands/v1-brands-by-outcomes-summary-get"},{"title":"Get brand outcome trend","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/outcomes/trend","href":"/api-reference/temporal/brands/v1-brands-by-outcomes-trend-get"},{"title":"Get brand parity dashboard","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/parity","href":"/api-reference/temporal/brands/v1-brands-by-parity-get"},{"title":"Pending reviews","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/reviews/pending","href":"/api-reference/temporal/brands/v1-brands-by-reviews-pending-get"},{"title":"Scheduler api (/v1/brands/{brand_id}/scheduled-jobs)","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/scheduled-jobs","href":"/api-reference/temporal/brands/v1-brands-by-scheduled-jobs-create"},{"title":"Scheduler api","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/scheduled-jobs","href":"/api-reference/temporal/brands/v1-brands-by-scheduled-jobs-get"},{"title":"Record csat","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/tickets/{ticket_id}/csat","href":"/api-reference/temporal/brands/v1-brands-by-tickets-by-csat-create"},{"title":"Get brand trial report","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/trial-report","href":"/api-reference/temporal/brands/v1-brands-by-trial-report-get"},{"title":"Update brand","api":"PATCH https://api.workstream.stateset.com/v1/brands/{brand_id}","href":"/api-reference/temporal/brands/v1-brands-by-update"},{"title":"Validate brand","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/validate","href":"/api-reference/temporal/brands/v1-brands-by-validate-create"},{"title":"Ingest warranty webhook","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_slug}/warranty/inbound","href":"/api-reference/temporal/brands/v1-brands-by-warranty-inbound-create"},{"title":"Delete workflow binding","api":"DELETE https://api.workstream.stateset.com/v1/brands/{brand_id}/workflow-bindings/{workflow_type}","href":"/api-reference/temporal/brands/v1-brands-by-workflow-bindings-by-delete"},{"title":"Upsert workflow binding","api":"PUT https://api.workstream.stateset.com/v1/brands/{brand_id}/workflow-bindings/{workflow_type}","href":"/api-reference/temporal/brands/v1-brands-by-workflow-bindings-by-update"},{"title":"List workflow bindings","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/workflow-bindings","href":"/api-reference/temporal/brands/v1-brands-by-workflow-bindings-get"},{"title":"Create workflow draft","api":"POST https://api.workstream.stateset.com/v1/brands/{brand_id}/workflow-drafts","href":"/api-reference/temporal/brands/v1-brands-by-workflow-drafts-create"},{"title":"List workflow drafts","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/workflow-drafts","href":"/api-reference/temporal/brands/v1-brands-by-workflow-drafts-get"},{"title":"Get brand improvement breakdown","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/workflows/breakdown","href":"/api-reference/temporal/brands/v1-brands-by-workflows-breakdown-get"},{"title":"Get brand workflow run","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/workflows/{workflow_id}","href":"/api-reference/temporal/brands/v1-brands-by-workflows-by-get"},{"title":"List brand workflows","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/workflows","href":"/api-reference/temporal/brands/v1-brands-by-workflows-get"},{"title":"List brand skip samples","api":"GET https://api.workstream.stateset.com/v1/brands/{brand_id}/workflows/skip-samples","href":"/api-reference/temporal/brands/v1-brands-by-workflows-skip-samples-get"},{"title":"Create brand","api":"POST https://api.workstream.stateset.com/v1/brands","href":"/api-reference/temporal/brands/v1-brands-create"},{"title":"List brands","api":"GET https://api.workstream.stateset.com/v1/brands","href":"/api-reference/temporal/brands/v1-brands-list"}]},{"group":"Fleet","pages":[{"title":"List fleet billing profiles","api":"GET https://api.workstream.stateset.com/v1/fleet/billing","href":"/api-reference/temporal/fleet/v1-fleet-billing-list"},{"title":"List fleet billing periods","api":"GET https://api.workstream.stateset.com/v1/fleet/billing/periods","href":"/api-reference/temporal/fleet/v1-fleet-billing-periods-list"},{"title":"Get fleet billing reconciliation","api":"GET https://api.workstream.stateset.com/v1/fleet/billing/reconciliation","href":"/api-reference/temporal/fleet/v1-fleet-billing-reconciliation-list"},{"title":"List fleet dispatch dlq","api":"GET https://api.workstream.stateset.com/v1/fleet/dispatch-dlq","href":"/api-reference/temporal/fleet/v1-fleet-dispatch-dlq-list"},{"title":"List fleet outcomes","api":"GET https://api.workstream.stateset.com/v1/fleet/outcomes","href":"/api-reference/temporal/fleet/v1-fleet-outcomes-list"},{"title":"Get fleet outcome summary","api":"GET https://api.workstream.stateset.com/v1/fleet/outcomes/summary","href":"/api-reference/temporal/fleet/v1-fleet-outcomes-summary-list"},{"title":"Get fleet quality scorecard","api":"GET https://api.workstream.stateset.com/v1/fleet/scorecard","href":"/api-reference/temporal/fleet/v1-fleet-scorecard-list"},{"title":"List fleet workflows","api":"GET https://api.workstream.stateset.com/v1/fleet/workflows","href":"/api-reference/temporal/fleet/v1-fleet-workflows-list"}]},{"group":"Connectors","pages":[{"title":"List connector capabilities","api":"GET https://api.workstream.stateset.com/v1/connector-capabilities","href":"/api-reference/temporal/connectors/v1-connector-capabilities-list"}]},{"group":"Scheduler","pages":[{"title":"Scheduler api (/v1/scheduled-jobs/run-due)","api":"POST https://api.workstream.stateset.com/v1/scheduled-jobs/run-due","href":"/api-reference/temporal/scheduler/v1-scheduled-jobs-run-due-create"}]},{"group":"Workflow templates","pages":[{"title":"Get workflow template","api":"GET https://api.workstream.stateset.com/v1/workflow-templates/{template_key}/{version}","href":"/api-reference/temporal/workflow-templates/v1-workflow-templates-by-by-get"},{"title":"Update workflow template","api":"PATCH https://api.workstream.stateset.com/v1/workflow-templates/{template_key}/{version}","href":"/api-reference/temporal/workflow-templates/v1-workflow-templates-by-by-update"},{"title":"Get latest workflow template","api":"GET https://api.workstream.stateset.com/v1/workflow-templates/{template_key}","href":"/api-reference/temporal/workflow-templates/v1-workflow-templates-by-get"},{"title":"Create workflow template","api":"POST https://api.workstream.stateset.com/v1/workflow-templates","href":"/api-reference/temporal/workflow-templates/v1-workflow-templates-create"},{"title":"List workflow templates","api":"GET https://api.workstream.stateset.com/v1/workflow-templates","href":"/api-reference/temporal/workflow-templates/v1-workflow-templates-list"}]},{"group":"Workflow drafts","pages":[{"title":"Get workflow draft","api":"GET https://api.workstream.stateset.com/v1/workflow-drafts/{draft_id}","href":"/api-reference/temporal/workflow-drafts/v1-workflow-drafts-by-get"},{"title":"List workflow draft releases","api":"GET https://api.workstream.stateset.com/v1/workflow-drafts/{draft_id}/releases","href":"/api-reference/temporal/workflow-drafts/v1-workflow-drafts-by-releases-get"},{"title":"Update workflow draft","api":"PATCH https://api.workstream.stateset.com/v1/workflow-drafts/{draft_id}","href":"/api-reference/temporal/workflow-drafts/v1-workflow-drafts-by-update"}]},{"group":"Workflow releases","pages":[{"title":"Approve workflow release","api":"POST https://api.workstream.stateset.com/v1/workflow-releases/{release_id}/approve","href":"/api-reference/temporal/workflow-releases/v1-workflow-releases-by-approve-create"},{"title":"List workflow release events","api":"GET https://api.workstream.stateset.com/v1/workflow-releases/{release_id}/events","href":"/api-reference/temporal/workflow-releases/v1-workflow-releases-by-events-get"},{"title":"Verify workflow release test","api":"POST https://api.workstream.stateset.com/v1/workflow-releases/{release_id}/verify-test","href":"/api-reference/temporal/workflow-releases/v1-workflow-releases-by-verify-test-create"}]},{"group":"Policy sets","pages":[{"title":"Get policy set","api":"GET https://api.workstream.stateset.com/v1/policy-sets/{policy_set_key}/{version}","href":"/api-reference/temporal/policy-sets/v1-policy-sets-by-by-get"},{"title":"Update policy set","api":"PATCH https://api.workstream.stateset.com/v1/policy-sets/{policy_set_key}/{version}","href":"/api-reference/temporal/policy-sets/v1-policy-sets-by-by-update"},{"title":"Get latest policy set","api":"GET https://api.workstream.stateset.com/v1/policy-sets/{policy_set_key}","href":"/api-reference/temporal/policy-sets/v1-policy-sets-by-get"},{"title":"Create policy set","api":"POST https://api.workstream.stateset.com/v1/policy-sets","href":"/api-reference/temporal/policy-sets/v1-policy-sets-create"},{"title":"List policy sets","api":"GET https://api.workstream.stateset.com/v1/policy-sets","href":"/api-reference/temporal/policy-sets/v1-policy-sets-list"}]},{"group":"Dispatch","pages":[{"title":"Run dispatch guard","api":"POST https://api.workstream.stateset.com/v1/dispatch/guard","href":"/api-reference/temporal/dispatch/v1-dispatch-guard-create"},{"title":"Get dispatch health dashboard","api":"GET https://api.workstream.stateset.com/v1/dispatch/health","href":"/api-reference/temporal/dispatch/v1-dispatch-health-list"}]},{"group":"Onboarding","pages":[{"title":"Onboarding (/v1/onboarding/{brand_id}/connect)","api":"POST https://api.workstream.stateset.com/v1/onboarding/{brand_id}/connect","href":"/api-reference/temporal/onboarding/v1-onboarding-by-connect-create"},{"title":"Onboarding","api":"POST https://api.workstream.stateset.com/v1/onboarding/{brand_id}/test","href":"/api-reference/temporal/onboarding/v1-onboarding-by-test-create"}]},{"group":"Bootstrap","pages":[{"title":"Bootstrap brand","api":"POST https://api.workstream.stateset.com/v1/bootstrap/brands","href":"/api-reference/temporal/bootstrap/v1-bootstrap-brands-create"},{"title":"List bootstrap templates","api":"GET https://api.workstream.stateset.com/v1/bootstrap/templates","href":"/api-reference/temporal/bootstrap/v1-bootstrap-templates-list"}]},{"group":"Claim","pages":[{"title":"Claim","api":"POST https://api.workstream.stateset.com/v1/claim/start","href":"/api-reference/temporal/claim/v1-claim-start-create"},{"title":"Claim (/v1/claim/verify)","api":"POST https://api.workstream.stateset.com/v1/claim/verify","href":"/api-reference/temporal/claim/v1-claim-verify-create"}]},{"group":"MCP","pages":[{"title":"Mcp","api":"POST https://api.workstream.stateset.com/v1/mcp","href":"/api-reference/temporal/mcp/v1-mcp-create"},{"title":"Mcp (/v1/mcp/workstream)","api":"POST https://api.workstream.stateset.com/v1/mcp/workstream","href":"/api-reference/temporal/mcp/v1-mcp-workstream-create"}]},{"group":"Health","pages":[{"title":"Health","api":"GET https://api.workstream.stateset.com/health","href":"/api-reference/temporal/health/health-list"},{"title":"Healthz","api":"GET https://api.workstream.stateset.com/healthz","href":"/api-reference/temporal/health/healthz-list"},{"title":"Metrics endpoint","api":"GET https://api.workstream.stateset.com/metrics","href":"/api-reference/temporal/health/metrics-list"},{"title":"Readyz","api":"GET https://api.workstream.stateset.com/readyz","href":"/api-reference/temporal/health/readyz-list"}]}]},{"tab":"EDI","icon":"file-text","groups":[{"group":"Overview","pages":[{"title":"EDI API","href":"/api-reference/edi/overview"},{"title":"EDI API history","href":"/api-reference/edi/history"}]},{"group":"Partners and mappings","pages":[{"title":"Removes this workspace's credentials for a live adapter.","api":"DELETE https://api.edi.stateset.com/v1/adapters/{name}/connection","href":"/api-reference/edi/partners/v1-adapters-by-connection-delete"},{"title":"This workspace's connection metadata for one live adapter.","api":"GET https://api.edi.stateset.com/v1/adapters/{name}/connection","href":"/api-reference/edi/partners/v1-adapters-by-connection-get"},{"title":"Stores (or rotates) this workspace's credentials for a live adapter…","api":"PUT https://api.edi.stateset.com/v1/adapters/{name}/connection","href":"/api-reference/edi/partners/v1-adapters-by-connection-update"},{"title":"Verify connection","api":"POST https://api.edi.stateset.com/v1/adapters/{name}/connection/verify","href":"/api-reference/edi/partners/v1-adapters-by-connection-verify-create"},{"title":"Delivers a canonical event through an explicitly selected live adapter…","api":"POST https://api.edi.stateset.com/v1/adapters/{name}/execute","href":"/api-reference/edi/partners/v1-adapters-by-execute-create"},{"title":"Every live-adapter connection this workspace has configured (metadata only),…","api":"GET https://api.edi.stateset.com/v1/adapters/connections","href":"/api-reference/edi/partners/v1-adapters-connections-list"},{"title":"The packaged back-end integration catalog (ERP/WMS/TMS/e-commerce/carrier),…","api":"GET https://api.edi.stateset.com/v1/adapters","href":"/api-reference/edi/partners/v1-adapters-list"},{"title":"Plans the back-end actions a canonical event would trigger across every…","api":"POST https://api.edi.stateset.com/v1/adapters/plan","href":"/api-reference/edi/partners/v1-adapters-plan-create"},{"title":"Certify a connector manifest: validate it, then instantiate a sample partner…","api":"POST https://api.edi.stateset.com/v1/connector-sdk/certify","href":"/api-reference/edi/partners/v1-connector-sdk-certify-create"},{"title":"Validate a connector manifest (SDK) without persisting — structure, a supported…","api":"POST https://api.edi.stateset.com/v1/connector-sdk/validate","href":"/api-reference/edi/partners/v1-connector-sdk-validate-create"},{"title":"Returns one retailer connector, including its starter validation guide.","api":"GET https://api.edi.stateset.com/v1/connectors/{name}","href":"/api-reference/edi/partners/v1-connectors-by-get"},{"title":"Creates (or updates) a trading partner from a retailer connector, filling in…","api":"POST https://api.edi.stateset.com/v1/connectors/{name}/partners/{id}","href":"/api-reference/edi/partners/v1-connectors-by-partners-by-create"},{"title":"Lists the built-in retailer connectors, optionally filtered by vertical.","api":"GET https://api.edi.stateset.com/v1/connectors","href":"/api-reference/edi/partners/v1-connectors-list"},{"title":"Transform","api":"POST https://api.edi.stateset.com/v1/mappings/{partner_id}/{name}/{version}/transform","href":"/api-reference/edi/partners/v1-mappings-by-by-by-transform-create"},{"title":"Publish","api":"POST https://api.edi.stateset.com/v1/mappings/{partner_id}/{name}","href":"/api-reference/edi/partners/v1-mappings-by-by-create"},{"title":"Versions","api":"GET https://api.edi.stateset.com/v1/mappings/{partner_id}/{name}","href":"/api-reference/edi/partners/v1-mappings-by-by-get"},{"title":"Preview","api":"POST https://api.edi.stateset.com/v1/mappings/preview","href":"/api-reference/edi/partners/v1-mappings-preview-create"},{"title":"All onboarding records for the tenant, newest activity first.","api":"GET https://api.edi.stateset.com/v1/onboarding","href":"/api-reference/edi/partners/v1-onboarding-list"},{"title":"Issues (or rotates) a partner API key. The plaintext is returned exactly once…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/api-key","href":"/api-reference/edi/partners/v1-partners-by-api-key-create"},{"title":"Runs a certification test pack against a partner: every sample interchange is…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/certification/run","href":"/api-reference/edi/partners/v1-partners-by-certification-run-create"},{"title":"Runs the prebuilt retail-baseline certification pack — generated for this…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/certification/run-standard","href":"/api-reference/edi/partners/v1-partners-by-certification-run-standard-create"},{"title":"Get a partner","api":"GET https://api.edi.stateset.com/v1/partners/{id}","href":"/api-reference/edi/partners/v1-partners-by-get"},{"title":"Field-level diff between two guide versions.","api":"GET https://api.edi.stateset.com/v1/partners/{id}/guide/diff","href":"/api-reference/edi/partners/v1-partners-by-guide-diff-get"},{"title":"Get a partner guide","api":"GET https://api.edi.stateset.com/v1/partners/{id}/guide","href":"/api-reference/edi/partners/v1-partners-by-guide-get"},{"title":"Rolls a partner's guide back to an earlier version: restores that version's…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/guide/rollback/{version}","href":"/api-reference/edi/partners/v1-partners-by-guide-rollback-by-create"},{"title":"Captures the partner's current implementation guide (validation + overlay) as…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/guide/snapshot","href":"/api-reference/edi/partners/v1-partners-by-guide-snapshot-create"},{"title":"Publish partner guide","api":"PUT https://api.edi.stateset.com/v1/partners/{id}/guide","href":"/api-reference/edi/partners/v1-partners-by-guide-update"},{"title":"Validates a partner's current guide (validation rules + overlay) without…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/guide/validate","href":"/api-reference/edi/partners/v1-partners-by-guide-validate-create"},{"title":"Lists a partner's guide versions (oldest first).","api":"GET https://api.edi.stateset.com/v1/partners/{id}/guide/versions","href":"/api-reference/edi/partners/v1-partners-by-guide-versions-get"},{"title":"stateset-mail managed mailbox readiness for a partner transport mailbox.","api":"GET https://api.edi.stateset.com/v1/partners/{id}/network-mailbox","href":"/api-reference/edi/partners/v1-partners-by-network-mailbox-get"},{"title":"Sets or clears the blocker on a partner's onboarding.","api":"POST https://api.edi.stateset.com/v1/partners/{id}/onboarding/blocker","href":"/api-reference/edi/partners/v1-partners-by-onboarding-blocker-create"},{"title":"One partner's onboarding record.","api":"GET https://api.edi.stateset.com/v1/partners/{id}/onboarding","href":"/api-reference/edi/partners/v1-partners-by-onboarding-get"},{"title":"Starts onboarding for a partner at the connected stage (idempotent).","api":"POST https://api.edi.stateset.com/v1/partners/{id}/onboarding/start","href":"/api-reference/edi/partners/v1-partners-by-onboarding-start-create"},{"title":"Transitions a partner's onboarding to a new stage (one step forward, or any…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/onboarding/transition","href":"/api-reference/edi/partners/v1-partners-by-onboarding-transition-create"},{"title":"Replace a partner's companion-guide **overlay** (extra segments + element…","api":"PUT https://api.edi.stateset.com/v1/partners/{id}/overlay","href":"/api-reference/edi/partners/v1-partners-by-overlay-update"},{"title":"Publishes a partner's guide+map to the shared library as a reusable template…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/publish-template","href":"/api-reference/edi/partners/v1-partners-by-publish-template-create"},{"title":"Record readiness evidence","api":"POST https://api.edi.stateset.com/v1/partners/{id}/readiness/evidence","href":"/api-reference/edi/partners/v1-partners-by-readiness-evidence-create"},{"title":"Partner readiness","api":"GET https://api.edi.stateset.com/v1/partners/{id}/readiness","href":"/api-reference/edi/partners/v1-partners-by-readiness-get"},{"title":"Upsert a partner","api":"PUT https://api.edi.stateset.com/v1/partners/{id}","href":"/api-reference/edi/partners/v1-partners-by-update"},{"title":"Poll a partner's file-backed VAN inbound mailbox.","api":"POST https://api.edi.stateset.com/v1/partners/{id}/van/poll","href":"/api-reference/edi/partners/v1-partners-by-van-poll-create"},{"title":"File-backed VAN mailbox status for a partner.","api":"GET https://api.edi.stateset.com/v1/partners/{id}/van/status","href":"/api-reference/edi/partners/v1-partners-by-van-status-get"},{"title":"Delete an item","api":"DELETE https://api.edi.stateset.com/v1/partners/{id}/xref/items/{xref_id}","href":"/api-reference/edi/partners/v1-partners-by-xref-items-by-delete"},{"title":"Update an item","api":"PUT https://api.edi.stateset.com/v1/partners/{id}/xref/items/{xref_id}","href":"/api-reference/edi/partners/v1-partners-by-xref-items-by-update"},{"title":"Create an item","api":"POST https://api.edi.stateset.com/v1/partners/{id}/xref/items","href":"/api-reference/edi/partners/v1-partners-by-xref-items-create"},{"title":"Export items","api":"GET https://api.edi.stateset.com/v1/partners/{id}/xref/items/export","href":"/api-reference/edi/partners/v1-partners-by-xref-items-export-get"},{"title":"List items","api":"GET https://api.edi.stateset.com/v1/partners/{id}/xref/items","href":"/api-reference/edi/partners/v1-partners-by-xref-items-get"},{"title":"Bulk CSV import (header row required; columns partner_item_id, upc, buyer_part,…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/xref/items/import","href":"/api-reference/edi/partners/v1-partners-by-xref-items-import-create"},{"title":"Delete a location","api":"DELETE https://api.edi.stateset.com/v1/partners/{id}/xref/locations/{xref_id}","href":"/api-reference/edi/partners/v1-partners-by-xref-locations-by-delete"},{"title":"Update a location","api":"PUT https://api.edi.stateset.com/v1/partners/{id}/xref/locations/{xref_id}","href":"/api-reference/edi/partners/v1-partners-by-xref-locations-by-update"},{"title":"Create a location","api":"POST https://api.edi.stateset.com/v1/partners/{id}/xref/locations","href":"/api-reference/edi/partners/v1-partners-by-xref-locations-create"},{"title":"Export locations","api":"GET https://api.edi.stateset.com/v1/partners/{id}/xref/locations/export","href":"/api-reference/edi/partners/v1-partners-by-xref-locations-export-get"},{"title":"List locations","api":"GET https://api.edi.stateset.com/v1/partners/{id}/xref/locations","href":"/api-reference/edi/partners/v1-partners-by-xref-locations-get"},{"title":"Bulk CSV import (columns partner_location_id, location_id, ship_to,…","api":"POST https://api.edi.stateset.com/v1/partners/{id}/xref/locations/import","href":"/api-reference/edi/partners/v1-partners-by-xref-locations-import-create"},{"title":"List partners","api":"GET https://api.edi.stateset.com/v1/partners","href":"/api-reference/edi/partners/v1-partners-list"},{"title":"One shared partner template.","api":"GET https://api.edi.stateset.com/v1/templates/{id}","href":"/api-reference/edi/partners/v1-templates-by-get"},{"title":"Inherits a shared template into the caller's tenant: creates a trading partner…","api":"POST https://api.edi.stateset.com/v1/templates/{template_id}/instantiate/{partner_id}","href":"/api-reference/edi/partners/v1-templates-by-instantiate-by-create"},{"title":"Browses the cross-tenant template library (most-reused first) with a…","api":"GET https://api.edi.stateset.com/v1/templates","href":"/api-reference/edi/partners/v1-templates-list"},{"title":"Revokes (deletes) a tenant API key. The key stops authenticating immediately…","api":"DELETE https://api.edi.stateset.com/v1/tenants/{id}/api-keys/{key_id}","href":"/api-reference/edi/partners/v1-tenants-by-api-keys-by-delete"},{"title":"Mints a tenant-scoped API key for external REST callers. The key authenticates…","api":"POST https://api.edi.stateset.com/v1/tenants/{id}/api-keys","href":"/api-reference/edi/partners/v1-tenants-by-api-keys-create"},{"title":"Lists a tenant's API keys (metadata only — hashes are never returned)…","api":"GET https://api.edi.stateset.com/v1/tenants/{id}/api-keys","href":"/api-reference/edi/partners/v1-tenants-by-api-keys-get"},{"title":"Get a tenant","api":"GET https://api.edi.stateset.com/v1/tenants/{id}","href":"/api-reference/edi/partners/v1-tenants-by-get"},{"title":"Provisions (or updates) a tenant. Used by the dashboard gateway to create a…","api":"POST https://api.edi.stateset.com/v1/tenants","href":"/api-reference/edi/partners/v1-tenants-create"},{"title":"Lists tenants. Admin-only; the platform operator sees the full catalog.","api":"GET https://api.edi.stateset.com/v1/tenants","href":"/api-reference/edi/partners/v1-tenants-list"},{"title":"Bootstrap workspace","api":"POST https://api.edi.stateset.com/v1/workspace/bootstrap","href":"/api-reference/edi/partners/v1-workspace-bootstrap-create"},{"title":"Workspace","api":"GET https://api.edi.stateset.com/v1/workspace","href":"/api-reference/edi/partners/v1-workspace-list"}]},{"group":"Order preparation","pages":[{"title":"History","api":"GET https://api.edi.stateset.com/v1/automation/auto-855/{job_id}/history","href":"/api-reference/edi/orders/v1-automation-auto-855-by-history-get"},{"title":"Retry an order","api":"POST https://api.edi.stateset.com/v1/automation/auto-855/{job_id}/retry","href":"/api-reference/edi/orders/v1-automation-auto-855-by-retry-create"},{"title":"Jobs","api":"GET https://api.edi.stateset.com/v1/automation/auto-855","href":"/api-reference/edi/orders/v1-automation-auto-855-list"},{"title":"Preview an order response","api":"POST https://api.edi.stateset.com/v1/operations/orders/{partner_id}/{po_number}/preview/{set}","href":"/api-reference/edi/orders/v1-operations-orders-by-by-preview-by-create"}]},{"group":"Connections","pages":[{"title":"Ftps save","api":"POST https://api.edi.stateset.com/v1/connections/ftps/{partner_id}","href":"/api-reference/edi/connections/v1-connections-ftps-by-create"},{"title":"Ftps retire","api":"POST https://api.edi.stateset.com/v1/connections/ftps/{connection_id}/retire","href":"/api-reference/edi/connections/v1-connections-ftps-by-retire-create"},{"title":"Ftps state","api":"PATCH https://api.edi.stateset.com/v1/connections/ftps/{connection_id}/state","href":"/api-reference/edi/connections/v1-connections-ftps-by-state-update"},{"title":"Ftps deliveries","api":"GET https://api.edi.stateset.com/v1/connections/ftps/deliveries","href":"/api-reference/edi/connections/v1-connections-ftps-deliveries-list"},{"title":"List ftps","api":"GET https://api.edi.stateset.com/v1/connections/ftps","href":"/api-reference/edi/connections/v1-connections-ftps-list"},{"title":"Set state (/v1/connections/mail/{connection_id}/state)","api":"PATCH https://api.edi.stateset.com/v1/connections/mail/{connection_id}/state","href":"/api-reference/edi/connections/v1-connections-mail-by-state-update"},{"title":"Save (/v1/connections/mail)","api":"POST https://api.edi.stateset.com/v1/connections/mail","href":"/api-reference/edi/connections/v1-connections-mail-create"},{"title":"List connections","api":"GET https://api.edi.stateset.com/v1/connections/mail","href":"/api-reference/edi/connections/v1-connections-mail-list"},{"title":"Managed","api":"POST https://api.edi.stateset.com/v1/connections/mail/managed","href":"/api-reference/edi/connections/v1-connections-mail-managed-create"},{"title":"Provisioning","api":"GET https://api.edi.stateset.com/v1/connections/mail/provisioning","href":"/api-reference/edi/connections/v1-connections-mail-provisioning-list"},{"title":"Sftp save","api":"POST https://api.edi.stateset.com/v1/connections/sftp/{partner_id}","href":"/api-reference/edi/connections/v1-connections-sftp-by-create"},{"title":"Sftp retire","api":"POST https://api.edi.stateset.com/v1/connections/sftp/{connection_id}/retire","href":"/api-reference/edi/connections/v1-connections-sftp-by-retire-create"},{"title":"Sftp state","api":"PATCH https://api.edi.stateset.com/v1/connections/sftp/{connection_id}/state","href":"/api-reference/edi/connections/v1-connections-sftp-by-state-update"},{"title":"Sftp deliveries","api":"GET https://api.edi.stateset.com/v1/connections/sftp/deliveries","href":"/api-reference/edi/connections/v1-connections-sftp-deliveries-list"},{"title":"List SFTPs","api":"GET https://api.edi.stateset.com/v1/connections/sftp","href":"/api-reference/edi/connections/v1-connections-sftp-list"},{"title":"Save (/v1/connections/sync)","api":"POST https://api.edi.stateset.com/v1/connections/sync","href":"/api-reference/edi/connections/v1-connections-sync-create"},{"title":"Inspect the original Sync outcome","api":"GET https://api.edi.stateset.com/v1/connections/sync/deliveries/{event_id}/outcome","href":"/api-reference/edi/connections/v1-connections-sync-deliveries-by-outcome-get"},{"title":"Deliveries (/v1/connections/sync/deliveries)","api":"GET https://api.edi.stateset.com/v1/connections/sync/deliveries","href":"/api-reference/edi/connections/v1-connections-sync-deliveries-list"},{"title":"List connections (/v1/connections/sync)","api":"GET https://api.edi.stateset.com/v1/connections/sync","href":"/api-reference/edi/connections/v1-connections-sync-list"},{"title":"Purge","api":"DELETE https://api.edi.stateset.com/v1/hosted-sftp/files/{file_id}","href":"/api-reference/edi/connections/v1-hosted-sftp-files-by-delete"},{"title":"Retry a connection","api":"POST https://api.edi.stateset.com/v1/hosted-sftp/files/{file_id}/retry","href":"/api-reference/edi/connections/v1-hosted-sftp-files-by-retry-create"},{"title":"Files","api":"GET https://api.edi.stateset.com/v1/hosted-sftp/files","href":"/api-reference/edi/connections/v1-hosted-sftp-files-list"},{"title":"Provision","api":"POST https://api.edi.stateset.com/v1/hosted-sftp/mailboxes/{partner_id}","href":"/api-reference/edi/connections/v1-hosted-sftp-mailboxes-by-create"},{"title":"Revoke key","api":"POST https://api.edi.stateset.com/v1/hosted-sftp/mailboxes/{mailbox_id}/revoke-key","href":"/api-reference/edi/connections/v1-hosted-sftp-mailboxes-by-revoke-key-create"},{"title":"Set state (/v1/hosted-sftp/mailboxes/{mailbox_id}/state)","api":"PATCH https://api.edi.stateset.com/v1/hosted-sftp/mailboxes/{mailbox_id}/state","href":"/api-reference/edi/connections/v1-hosted-sftp-mailboxes-by-state-update"},{"title":"List connections (/v1/hosted-sftp/mailboxes)","api":"GET https://api.edi.stateset.com/v1/hosted-sftp/mailboxes","href":"/api-reference/edi/connections/v1-hosted-sftp-mailboxes-list"}]},{"group":"Inbound","pages":[{"title":"Receive an EDI email","api":"POST https://api.edi.stateset.com/v1/as1/inbound","href":"/api-reference/edi/inbound/v1-as1-inbound-create"},{"title":"Inbound AS2: return a synchronous receipt, or durably queue an authenticated…","api":"POST https://api.edi.stateset.com/v1/as2","href":"/api-reference/edi/inbound/v1-as2-create"},{"title":"For","api":"POST https://api.edi.stateset.com/v1/edi/inbound/{partner_id}","href":"/api-reference/edi/inbound/v1-edi-inbound-by-create"},{"title":"Inbound","api":"POST https://api.edi.stateset.com/v1/edi/inbound","href":"/api-reference/edi/inbound/v1-edi-inbound-create"},{"title":"Dry-run validation against a specific partner's implementation guide.","api":"POST https://api.edi.stateset.com/v1/edi/validate/{partner_id}","href":"/api-reference/edi/inbound/v1-edi-validate-by-create"},{"title":"Dry-run validation against the ISA- or UNB-resolved partner's guide.","api":"POST https://api.edi.stateset.com/v1/edi/validate","href":"/api-reference/edi/inbound/v1-edi-validate-create"},{"title":"Runs a retailer sandbox scenario for a **test** partner: synthesizes the…","api":"POST https://api.edi.stateset.com/v1/sandbox/{partner_id}/scenarios/{scenario}","href":"/api-reference/edi/inbound/v1-sandbox-by-scenarios-by-create"}]},{"group":"Outbound and labels","pages":[{"title":"Generates a commercial invoice / customs document from a canonical…","api":"POST https://api.edi.stateset.com/v1/commercial-invoice/{partner_id}","href":"/api-reference/edi/outbound/v1-commercial-invoice-by-create"},{"title":"Generates a CN22/CN23 postal customs declaration from a commercial-invoice…","api":"POST https://api.edi.stateset.com/v1/customs/postal/{partner_id}","href":"/api-reference/edi/outbound/v1-customs-postal-by-create"},{"title":"204","api":"POST https://api.edi.stateset.com/v1/edi/outbound/204/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-204-by-create"},{"title":"270","api":"POST https://api.edi.stateset.com/v1/edi/outbound/270/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-270-by-create"},{"title":"753","api":"POST https://api.edi.stateset.com/v1/edi/outbound/753/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-753-by-create"},{"title":"810","api":"POST https://api.edi.stateset.com/v1/edi/outbound/810/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-810-by-create"},{"title":"Publishes an outbound 832 price/sales catalog to a partner.","api":"POST https://api.edi.stateset.com/v1/edi/outbound/832/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-832-by-create"},{"title":"Send inventory advice (846)","api":"POST https://api.edi.stateset.com/v1/edi/outbound/846/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-846-by-create"},{"title":"855","api":"POST https://api.edi.stateset.com/v1/edi/outbound/855/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-855-by-create"},{"title":"856","api":"POST https://api.edi.stateset.com/v1/edi/outbound/856/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-856-by-create"},{"title":"Send a purchase-order change acknowledgment (865)","api":"POST https://api.edi.stateset.com/v1/edi/outbound/865/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-865-by-create"},{"title":"940","api":"POST https://api.edi.stateset.com/v1/edi/outbound/940/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-940-by-create"},{"title":"943","api":"POST https://api.edi.stateset.com/v1/edi/outbound/943/{partner_id}","href":"/api-reference/edi/outbound/v1-edi-outbound-943-by-create"},{"title":"Runs the outbound pre-send compliance check against the stored PO(s) and the…","api":"POST https://api.edi.stateset.com/v1/edi/outbound/{set}/{partner_id}/check","href":"/api-reference/edi/outbound/v1-edi-outbound-by-by-check-create"},{"title":"Edifact outbound desadv","api":"POST https://api.edi.stateset.com/v1/edifact/outbound/desadv/{partner_id}","href":"/api-reference/edi/outbound/v1-edifact-outbound-desadv-by-create"},{"title":"Edifact outbound invoic","api":"POST https://api.edi.stateset.com/v1/edifact/outbound/invoic/{partner_id}","href":"/api-reference/edi/outbound/v1-edifact-outbound-invoic-by-create"},{"title":"Edifact outbound invrpt","api":"POST https://api.edi.stateset.com/v1/edifact/outbound/invrpt/{partner_id}","href":"/api-reference/edi/outbound/v1-edifact-outbound-invrpt-by-create"},{"title":"Generates a Peppol BIS Billing 3.0 UBL e-invoice from a canonical invoice…","api":"POST https://api.edi.stateset.com/v1/einvoice/ubl/{partner_id}","href":"/api-reference/edi/outbound/v1-einvoice-ubl-by-create"},{"title":"Validates a Peppol-BIS invoice payload against the BIS Billing 3.0 business…","api":"POST https://api.edi.stateset.com/v1/einvoice/ubl/{partner_id}/validate","href":"/api-reference/edi/outbound/v1-einvoice-ubl-by-validate-create"},{"title":"Accepts a typed ERP/Sync event and sends the matching order document from the…","api":"POST https://api.edi.stateset.com/v1/erp/events","href":"/api-reference/edi/outbound/v1-erp-events-create"},{"title":"Generates one UCC-128 GS1-128 label per carton from an 856 ASN's carton…","api":"POST https://api.edi.stateset.com/v1/labels/856/{partner_id}/cartons","href":"/api-reference/edi/outbound/v1-labels-856-by-cartons-create"},{"title":"Generates a UCC-128 shipping label (SSCC-18 + ZPL) from an 856 ASN body…","api":"POST https://api.edi.stateset.com/v1/labels/856/{partner_id}","href":"/api-reference/edi/outbound/v1-labels-856-by-create"},{"title":"Generates GS1 labels at a specific pack **level** — carton (SSCC, AI 00), inner…","api":"POST https://api.edi.stateset.com/v1/labels/856/{partner_id}/level/{level}","href":"/api-reference/edi/outbound/v1-labels-856-by-level-by-create"},{"title":"Send a reviewed order document","api":"POST https://api.edi.stateset.com/v1/orders/{po_number}/{set}/{partner_id}","href":"/api-reference/edi/outbound/v1-orders-by-by-by-create"},{"title":"Returns a pre-filled 855/856/810 request body built from the stored 850 (with…","api":"GET https://api.edi.stateset.com/v1/orders/{po_number}/drafts/{set}","href":"/api-reference/edi/outbound/v1-orders-by-drafts-by-get"},{"title":"Generates a packing slip (printable HTML + ZPL summary label) from an 856 ASN…","api":"POST https://api.edi.stateset.com/v1/packing-slip/856/{partner_id}","href":"/api-reference/edi/outbound/v1-packing-slip-856-by-create"},{"title":"Same canonical 856 → ASN as [packing_slip_856], but streams the **native PDF**…","api":"POST https://api.edi.stateset.com/v1/packing-slip/856/{partner_id}/pdf","href":"/api-reference/edi/outbound/v1-packing-slip-856-by-pdf-create"},{"title":"Allocates fresh SSCC-18 codes from the tenant's durable, monotonic serial…","api":"POST https://api.edi.stateset.com/v1/sscc/allocate","href":"/api-reference/edi/outbound/v1-sscc-allocate-create"}]},{"group":"Operations and recovery","pages":[{"title":"Per-partner analytics as a CSV download.","api":"GET https://api.edi.stateset.com/v1/analytics/export","href":"/api-reference/edi/operations/v1-analytics-export-list"},{"title":"Operational analytics: volume, error rate, throughput trend, and document…","api":"GET https://api.edi.stateset.com/v1/analytics","href":"/api-reference/edi/operations/v1-analytics-list"},{"title":"WS-1 acceptance evidence: for each packaged retail connector, instantiate the…","api":"GET https://api.edi.stateset.com/v1/artifacts/conformance","href":"/api-reference/edi/operations/v1-artifacts-conformance-list"},{"title":"Rotates the AS2 signing/decryption identity without a restart…","api":"POST https://api.edi.stateset.com/v1/as2/identity","href":"/api-reference/edi/operations/v1-as2-identity-create"},{"title":"Receives an **asynchronous MDN**: a partner POSTs the receipt for a message we…","api":"POST https://api.edi.stateset.com/v1/as2/mdn","href":"/api-reference/edi/operations/v1-as2-mdn-create"},{"title":"Retry an as2 receipt","api":"POST https://api.edi.stateset.com/v1/as2/receipts/{id}/retry","href":"/api-reference/edi/operations/v1-as2-receipts-by-retry-create"},{"title":"Tenant-scoped receipt callback delivery status.","api":"GET https://api.edi.stateset.com/v1/as2/receipts","href":"/api-reference/edi/operations/v1-as2-receipts-list"},{"title":"Immutable tenant-scoped operator actions, newest first.","api":"GET https://api.edi.stateset.com/v1/audit","href":"/api-reference/edi/operations/v1-audit-list"},{"title":"Business-level reconciliation across PO / ASN / 945 / invoice / payment.","api":"GET https://api.edi.stateset.com/v1/business-reconciliation","href":"/api-reference/edi/operations/v1-business-reconciliation-list"},{"title":"History (/v1/callback-deliveries/{id}/history)","api":"GET https://api.edi.stateset.com/v1/callback-deliveries/{id}/history","href":"/api-reference/edi/operations/v1-callback-deliveries-by-history-get"},{"title":"Retry an operation","api":"POST https://api.edi.stateset.com/v1/callback-deliveries/{id}/retry","href":"/api-reference/edi/operations/v1-callback-deliveries-by-retry-create"},{"title":"Deliveries","api":"GET https://api.edi.stateset.com/v1/callback-deliveries","href":"/api-reference/edi/operations/v1-callback-deliveries-list"},{"title":"Revoke","api":"POST https://api.edi.stateset.com/v1/callbacks/{id}/revisions/{version}/revoke","href":"/api-reference/edi/operations/v1-callbacks-by-revisions-by-revoke-create"},{"title":"Set state","api":"PUT https://api.edi.stateset.com/v1/callbacks/{id}/state","href":"/api-reference/edi/operations/v1-callbacks-by-state-update"},{"title":"Save","api":"PUT https://api.edi.stateset.com/v1/callbacks/{id}","href":"/api-reference/edi/operations/v1-callbacks-by-update"},{"title":"List operations","api":"GET https://api.edi.stateset.com/v1/callbacks","href":"/api-reference/edi/operations/v1-callbacks-list"},{"title":"Ingests an 832 price/sales catalog into the partner's item master, bumping a…","api":"POST https://api.edi.stateset.com/v1/catalog/ingest/{partner_id}","href":"/api-reference/edi/operations/v1-catalog-ingest-by-create"},{"title":"The item master (assortment) for the tenant, optionally by partner.","api":"GET https://api.edi.stateset.com/v1/catalog","href":"/api-reference/edi/operations/v1-catalog-list"},{"title":"Permanently discards one dead-lettered event — the deliberate way to give up on…","api":"POST https://api.edi.stateset.com/v1/deadletter/{event_id}/discard","href":"/api-reference/edi/operations/v1-deadletter-by-discard-create"},{"title":"Events the sequencer permanently rejected and that were moved out of the active…","api":"GET https://api.edi.stateset.com/v1/deadletter","href":"/api-reference/edi/operations/v1-deadletter-list"},{"title":"Replays every dead-lettered event back into the active outbox so the next flush…","api":"POST https://api.edi.stateset.com/v1/deadletter/replay","href":"/api-reference/edi/operations/v1-deadletter-replay-create"},{"title":"Assigns a root-cause category to a deduction.","api":"POST https://api.edi.stateset.com/v1/deductions/{id}/categorize","href":"/api-reference/edi/operations/v1-deductions-by-categorize-create"},{"title":"Opens a dispute on a deduction.","api":"POST https://api.edi.stateset.com/v1/deductions/{id}/dispute","href":"/api-reference/edi/operations/v1-deductions-by-dispute-create"},{"title":"Attaches supporting evidence (a note + optional link) to a deduction — the…","api":"POST https://api.edi.stateset.com/v1/deductions/{id}/evidence","href":"/api-reference/edi/operations/v1-deductions-by-evidence-create"},{"title":"One deduction with its dispute history.","api":"GET https://api.edi.stateset.com/v1/deductions/{id}","href":"/api-reference/edi/operations/v1-deductions-by-get"},{"title":"Resolves a deduction to a terminal outcome (recovered / denied / written off).","api":"POST https://api.edi.stateset.com/v1/deductions/{id}/resolve","href":"/api-reference/edi/operations/v1-deductions-by-resolve-create"},{"title":"Captures a deduction (from an inbound 812 or keyed by an operator)…","api":"POST https://api.edi.stateset.com/v1/deductions","href":"/api-reference/edi/operations/v1-deductions-create"},{"title":"Lists deductions for the tenant with an exposure/recovery summary.","api":"GET https://api.edi.stateset.com/v1/deductions","href":"/api-reference/edi/operations/v1-deductions-list"},{"title":"Export a tenant-scoped AS2 transmission and its authenticated receipt…","api":"GET https://api.edi.stateset.com/v1/deliveries/{id}/evidence","href":"/api-reference/edi/operations/v1-deliveries-by-evidence-get"},{"title":"Re-drives a failed (or stuck) AS2 delivery: resets it to pending and due now so…","api":"POST https://api.edi.stateset.com/v1/deliveries/{id}/redeliver","href":"/api-reference/edi/operations/v1-deliveries-by-redeliver-create"},{"title":"Outbound AS2 deliveries and their status (pending / delivered / failed), scoped…","api":"GET https://api.edi.stateset.com/v1/deliveries","href":"/api-reference/edi/operations/v1-deliveries-list"},{"title":"Tenant-scoped Mail submission receipts. Request bodies and bindings are omitted.","api":"GET https://api.edi.stateset.com/v1/deliveries/mail","href":"/api-reference/edi/operations/v1-deliveries-mail-list"},{"title":"Bulk re-drives every **failed** delivery (optionally for one partner) back to…","api":"POST https://api.edi.stateset.com/v1/deliveries/redeliver-bulk","href":"/api-reference/edi/operations/v1-deliveries-redeliver-bulk-create"},{"title":"Compliance evidence bundle for one document and its related order chain.","api":"GET https://api.edi.stateset.com/v1/documents/{id}/evidence","href":"/api-reference/edi/operations/v1-documents-by-evidence-get"},{"title":"Document detail","api":"GET https://api.edi.stateset.com/v1/documents/{id}","href":"/api-reference/edi/operations/v1-documents-by-get"},{"title":"Reprocesses a stored **inbound** document: re-runs validation, translation, and…","api":"POST https://api.edi.stateset.com/v1/documents/{id}/reprocess","href":"/api-reference/edi/operations/v1-documents-by-reprocess-create"},{"title":"Paged: data stays a plain array (newest first) and page carries {total, limit,…","api":"GET https://api.edi.stateset.com/v1/documents","href":"/api-reference/edi/operations/v1-documents-list"},{"title":"Manual document entry for partners without back-end integration: an operator…","api":"POST https://api.edi.stateset.com/v1/documents/manual","href":"/api-reference/edi/operations/v1-documents-manual-create"},{"title":"Bulk-reprocesses stored **inbound** documents matching a filter — e.g…","api":"POST https://api.edi.stateset.com/v1/documents/reprocess-bulk","href":"/api-reference/edi/operations/v1-documents-reprocess-bulk-create"},{"title":"Parses arbitrary X12 and returns the envelope structure — a debugging aid.","api":"POST https://api.edi.stateset.com/v1/edi/parse","href":"/api-reference/edi/operations/v1-edi-parse-create"},{"title":"Compliance evidence bundle for a PO / shipment / invoice reference.","api":"GET https://api.edi.stateset.com/v1/evidence/{reference}","href":"/api-reference/edi/operations/v1-evidence-by-get"},{"title":"3PL / fulfillment scorecard: fill rate, perfect-order rate, and at-risk orders…","api":"GET https://api.edi.stateset.com/v1/fulfillment","href":"/api-reference/edi/operations/v1-fulfillment-list"},{"title":"Captures an inbound sales lead from the public checker / landing page…","api":"POST https://api.edi.stateset.com/v1/leads","href":"/api-reference/edi/operations/v1-leads-create"},{"title":"Lists recent captured leads (operator view). Leads come from the public…","api":"GET https://api.edi.stateset.com/v1/leads","href":"/api-reference/edi/operations/v1-leads-list"},{"title":"Order lifecycle trace for one PO / shipment / invoice reference.","api":"GET https://api.edi.stateset.com/v1/lifecycle/{reference}","href":"/api-reference/edi/operations/v1-lifecycle-by-get"},{"title":"Evaluates monitoring and **fires** every critical alert through the configured…","api":"POST https://api.edi.stateset.com/v1/monitoring/evaluate","href":"/api-reference/edi/operations/v1-monitoring-evaluate-create"},{"title":"Real-time monitoring snapshot: per-partner acknowledgment SLA status,…","api":"GET https://api.edi.stateset.com/v1/monitoring","href":"/api-reference/edi/operations/v1-monitoring-list"},{"title":"Trading-network readiness across partners in the selected tenant.","api":"GET https://api.edi.stateset.com/v1/network/readiness","href":"/api-reference/edi/operations/v1-network-readiness-list"},{"title":"Case snapshot","api":"GET https://api.edi.stateset.com/v1/operations/exceptions/{kind}/{id}","href":"/api-reference/edi/operations/v1-operations-exceptions-by-by-get"},{"title":"History (/v1/operations/exceptions/{kind}/{id}/history)","api":"GET https://api.edi.stateset.com/v1/operations/exceptions/{kind}/{id}/history","href":"/api-reference/edi/operations/v1-operations-exceptions-by-by-history-get"},{"title":"Update a case","api":"PATCH https://api.edi.stateset.com/v1/operations/exceptions/{kind}/{id}","href":"/api-reference/edi/operations/v1-operations-exceptions-by-by-update"},{"title":"Exceptions","api":"GET https://api.edi.stateset.com/v1/operations/exceptions","href":"/api-reference/edi/operations/v1-operations-exceptions-list"},{"title":"Inspect a partner-scoped order","api":"GET https://api.edi.stateset.com/v1/operations/orders/{partner_id}/{po_number}","href":"/api-reference/edi/operations/v1-operations-orders-by-by-get"},{"title":"Orders","api":"GET https://api.edi.stateset.com/v1/operations/orders","href":"/api-reference/edi/operations/v1-operations-orders-list"},{"title":"Outbox flush","api":"POST https://api.edi.stateset.com/v1/outbox/flush","href":"/api-reference/edi/operations/v1-outbox-flush-create"},{"title":"Outbox","api":"GET https://api.edi.stateset.com/v1/outbox","href":"/api-reference/edi/operations/v1-outbox-list"},{"title":"Acknowledgment status of outbound documents (matched against inbound 997s).","api":"GET https://api.edi.stateset.com/v1/reconciliation","href":"/api-reference/edi/operations/v1-reconciliation-list"},{"title":"Replays a document set from the stream: re-derives the VES events for every…","api":"POST https://api.edi.stateset.com/v1/replay/{reference}","href":"/api-reference/edi/operations/v1-replay-by-create"},{"title":"Returns the auto-generated certification pack for a retailer profile — the…","api":"GET https://api.edi.stateset.com/v1/retailer-profiles/{key}/certification-pack","href":"/api-reference/edi/operations/v1-retailer-profiles-by-certification-pack-get"},{"title":"Free compliance checker: validate a raw X12 file against a retailer's published…","api":"POST https://api.edi.stateset.com/v1/retailer-profiles/{key}/check","href":"/api-reference/edi/operations/v1-retailer-profiles-by-check-create"},{"title":"Returns a ready-to-edit, guide-compliant sample 850 for a retailer profile —…","api":"GET https://api.edi.stateset.com/v1/retailer-profiles/{key}/sample","href":"/api-reference/edi/operations/v1-retailer-profiles-by-sample-get"},{"title":"Lists the built-in retailer companion-guide profiles (Walmart, Target, Amazon,…","api":"GET https://api.edi.stateset.com/v1/retailer-profiles","href":"/api-reference/edi/operations/v1-retailer-profiles-list"},{"title":"Returns the Ed25519 public key used to sign VES events, plus a ready-made…","api":"GET https://api.edi.stateset.com/v1/signing-key","href":"/api-reference/edi/operations/v1-signing-key-list"},{"title":"Per-partner operational status board: volume, compliance rate, open exceptions,…","api":"GET https://api.edi.stateset.com/v1/status-board","href":"/api-reference/edi/operations/v1-status-board-list"},{"title":"Transport operations center: AS2/SFTP/VAN/cert/MDN go-live posture.","api":"GET https://api.edi.stateset.com/v1/transport/operations","href":"/api-reference/edi/operations/v1-transport-operations-list"},{"title":"The tenant's consumption ledger rollup — documents processed and generated,…","api":"GET https://api.edi.stateset.com/v1/usage","href":"/api-reference/edi/operations/v1-usage-list"},{"title":"Supported VAN providers and whether the local file-backed VAN is enabled.","api":"GET https://api.edi.stateset.com/v1/van/providers","href":"/api-reference/edi/operations/v1-van-providers-list"},{"title":"Independently verifies the Ed25519 signatures on a set of VES events…","api":"POST https://api.edi.stateset.com/v1/verify","href":"/api-reference/edi/operations/v1-verify-create"},{"title":"X12 capability discovery: the transaction sets the gateway can parse inbound…","api":"GET https://api.edi.stateset.com/v1/x12/capabilities","href":"/api-reference/edi/operations/v1-x12-capabilities-list"}]},{"group":"System","pages":[{"title":"Health","api":"GET https://api.edi.stateset.com/health","href":"/api-reference/edi/system/health-list"},{"title":"Liveness probe: is the process up and the async runtime responsive? This…","api":"GET https://api.edi.stateset.com/live","href":"/api-reference/edi/system/live-list"},{"title":"Capabilities","api":"GET https://api.edi.stateset.com/v1/capabilities","href":"/api-reference/edi/system/v1-capabilities-list"}]}]},{"tab":"NSR","icon":"brain","groups":[{"group":"Overview","pages":[{"title":"NSR API","href":"/api-reference/nsr/overview"},{"title":"NSR API history","href":"/api-reference/nsr/history"}]},{"group":"Verified decisions","pages":[{"title":"Decide over a batch of requests in one call — for enterprises scoring whole","api":"POST https://api.nsr.stateset.com/v1/decisions/batch","href":"/api-reference/nsr/verified-decisions/v1-decisions-batch-create"},{"title":"Look up one recent decision by the decision_id from the API response or","api":"GET https://api.nsr.stateset.com/v1/decisions/{id}","href":"/api-reference/nsr/verified-decisions/v1-decisions-by-get"},{"title":"Record the real-world outcome of a past decision — the write side of the","api":"POST https://api.nsr.stateset.com/v1/decisions/{id}/outcome","href":"/api-reference/nsr/verified-decisions/v1-decisions-by-outcome-create"},{"title":"The reliability curve: how well the engine's reported confidence predicts","api":"GET https://api.nsr.stateset.com/v1/decisions/calibration","href":"/api-reference/nsr/verified-decisions/v1-decisions-calibration-list"},{"title":"Produce an auditable, policy-grounded decision with a proof chain.","api":"POST https://api.nsr.stateset.com/v1/decisions","href":"/api-reference/nsr/verified-decisions/v1-decisions-create"},{"title":"Policy impact handler","api":"POST https://api.nsr.stateset.com/v1/decisions/impact","href":"/api-reference/nsr/verified-decisions/v1-decisions-impact-create"},{"title":"Record a decision's real-world outcome by the client's correlation key","api":"POST https://api.nsr.stateset.com/v1/decisions/outcome-by-ref","href":"/api-reference/nsr/verified-decisions/v1-decisions-outcome-by-ref-create"},{"title":"Most recent decisions for the org, newest first. Ephemeral in-memory","api":"GET https://api.nsr.stateset.com/v1/decisions/recent","href":"/api-reference/nsr/verified-decisions/v1-decisions-recent-list"},{"title":"Refusal coverage gaps: how often each missing premise blocked a decision","api":"GET https://api.nsr.stateset.com/v1/decisions/refusal-gaps","href":"/api-reference/nsr/verified-decisions/v1-decisions-refusal-gaps-list"},{"title":"Integration roadmap: the org's refusal gaps as a prioritized, actionable","api":"GET https://api.nsr.stateset.com/v1/decisions/refusal-roadmap","href":"/api-reference/nsr/verified-decisions/v1-decisions-refusal-roadmap-list"},{"title":"Per-rule cited-vs-noise usage over a window — the demotion signal. A rule","api":"GET https://api.nsr.stateset.com/v1/decisions/rule-stats","href":"/api-reference/nsr/verified-decisions/v1-decisions-rule-stats-list"},{"title":"Aggregate decision stats over a window: outcome counts, billable volume,","api":"GET https://api.nsr.stateset.com/v1/decisions/stats","href":"/api-reference/nsr/verified-decisions/v1-decisions-stats-list"},{"title":"Independently verify a self-contained proof bundle against nothing but","api":"POST https://api.nsr.stateset.com/v1/proofs/verify","href":"/api-reference/nsr/verified-decisions/v1-proofs-verify-create"}]},{"group":"Knowledge base","pages":[{"title":"Get a specific evidence node and trace its full dependency chain","api":"GET https://api.nsr.stateset.com/api/v1/evidence/{id}/chain","href":"/api-reference/nsr/knowledge-base/evidence-by-chain-get"},{"title":"Delete one evidence node by ID.","api":"DELETE https://api.nsr.stateset.com/api/v1/evidence/{id}","href":"/api-reference/nsr/knowledge-base/evidence-by-delete"},{"title":"Retrieve one evidence node by ID.","api":"GET https://api.nsr.stateset.com/api/v1/evidence/{id}","href":"/api-reference/nsr/knowledge-base/evidence-by-get"},{"title":"Update one evidence node by ID.","api":"PATCH https://api.nsr.stateset.com/api/v1/evidence/{id}","href":"/api-reference/nsr/knowledge-base/evidence-by-update"},{"title":"Create an evidence node.","api":"POST https://api.nsr.stateset.com/api/v1/evidence","href":"/api-reference/nsr/knowledge-base/evidence-create"},{"title":"Query evidence by claim or entity","api":"GET https://api.nsr.stateset.com/api/v1/evidence","href":"/api-reference/nsr/knowledge-base/evidence-list"},{"title":"Get evidence graph stats","api":"GET https://api.nsr.stateset.com/api/v1/evidence/stats","href":"/api-reference/nsr/knowledge-base/evidence-stats-list"},{"title":"Handler for GET /api/v1/kb/diff","api":"GET https://api.nsr.stateset.com/api/v1/kb/diff","href":"/api-reference/nsr/knowledge-base/kb-diff-list"},{"title":"Perform graph analysis on the knowledge base","api":"POST https://api.nsr.stateset.com/api/v1/kb/graph","href":"/api-reference/nsr/knowledge-base/kb-graph-create"},{"title":"Handler for GET /api/v1/kb/history","api":"GET https://api.nsr.stateset.com/api/v1/kb/history","href":"/api-reference/nsr/knowledge-base/kb-history-list"},{"title":"Handler for GET /api/v1/kb/snapshot","api":"GET https://api.nsr.stateset.com/api/v1/kb/snapshot","href":"/api-reference/nsr/knowledge-base/kb-snapshot-list"},{"title":"Get detailed knowledge base statistics","api":"GET https://api.nsr.stateset.com/api/v1/kb/stats","href":"/api-reference/nsr/knowledge-base/kb-stats-list"},{"title":"Execute a knowledge base query","api":"POST https://api.nsr.stateset.com/api/v1/query","href":"/api-reference/nsr/knowledge-base/query-create"},{"title":"Delete a source by ID.","api":"DELETE https://api.nsr.stateset.com/api/v1/sources/{id}","href":"/api-reference/nsr/knowledge-base/sources-by-delete"},{"title":"Retrieve a single source by ID.","api":"GET https://api.nsr.stateset.com/api/v1/sources/{id}","href":"/api-reference/nsr/knowledge-base/sources-by-get"},{"title":"Update an existing source.","api":"PATCH https://api.nsr.stateset.com/api/v1/sources/{id}","href":"/api-reference/nsr/knowledge-base/sources-by-update"},{"title":"Create a new evidence source record.","api":"POST https://api.nsr.stateset.com/api/v1/sources","href":"/api-reference/nsr/knowledge-base/sources-create"},{"title":"List all registered evidence sources.","api":"GET https://api.nsr.stateset.com/api/v1/sources","href":"/api-reference/nsr/knowledge-base/sources-list"}]},{"group":"Entities","pages":[{"title":"Batch create entities","api":"POST https://api.nsr.stateset.com/api/v1/entities/batch","href":"/api-reference/nsr/entities/entities-batch-create"},{"title":"Batch delete entities","api":"DELETE https://api.nsr.stateset.com/api/v1/entities/batch","href":"/api-reference/nsr/entities/entities-batch-delete"},{"title":"Delete an entity by ID","api":"DELETE https://api.nsr.stateset.com/api/v1/entities/{id}","href":"/api-reference/nsr/entities/entities-by-delete"},{"title":"Retrieve an entity by its unique identifier.","api":"GET https://api.nsr.stateset.com/api/v1/entities/{id}","href":"/api-reference/nsr/entities/entities-by-get"},{"title":"Soft delete an entity (archives for audit trail)","api":"DELETE https://api.nsr.stateset.com/api/v1/entities/{id}/soft","href":"/api-reference/nsr/entities/entities-by-soft-delete"},{"title":"Update an entity","api":"PATCH https://api.nsr.stateset.com/api/v1/entities/{id}","href":"/api-reference/nsr/entities/entities-by-update"},{"title":"Create a new entity in the knowledge graph.","api":"POST https://api.nsr.stateset.com/api/v1/entities","href":"/api-reference/nsr/entities/entities-create"},{"title":"List all entities in the knowledge base with pagination.","api":"GET https://api.nsr.stateset.com/api/v1/entities","href":"/api-reference/nsr/entities/entities-list"},{"title":"Search for entities matching a query pattern.","api":"GET https://api.nsr.stateset.com/api/v1/entities/search","href":"/api-reference/nsr/entities/entities-search-list"}]},{"group":"Triples","pages":[{"title":"Batch create triples","api":"POST https://api.nsr.stateset.com/api/v1/triples/batch","href":"/api-reference/nsr/triples/triples-batch-create"},{"title":"Detach an evidence node from a triple.","api":"DELETE https://api.nsr.stateset.com/api/v1/triples/{triple_id}/evidence/{evidence_id}","href":"/api-reference/nsr/triples/triples-by-evidence-by-delete"},{"title":"Attach an existing evidence node to a triple.","api":"POST https://api.nsr.stateset.com/api/v1/triples/{triple_id}/evidence","href":"/api-reference/nsr/triples/triples-by-evidence-create"},{"title":"Get evidence linked to a triple.","api":"GET https://api.nsr.stateset.com/api/v1/triples/{triple_id}/evidence","href":"/api-reference/nsr/triples/triples-by-evidence-get"},{"title":"Get all triples where the specified entity is the subject.","api":"GET https://api.nsr.stateset.com/api/v1/triples/{subject_id}","href":"/api-reference/nsr/triples/triples-by-get"},{"title":"Create a new triple (fact) in the knowledge base.","api":"POST https://api.nsr.stateset.com/api/v1/triples","href":"/api-reference/nsr/triples/triples-create"},{"title":"Delete a triple (fact)","api":"DELETE https://api.nsr.stateset.com/api/v1/triples","href":"/api-reference/nsr/triples/triples-delete"},{"title":"Update a triple's confidence","api":"PATCH https://api.nsr.stateset.com/api/v1/triples","href":"/api-reference/nsr/triples/triples-update"}]},{"group":"Types","pages":[{"title":"Generate type constraints prompt for LLM","api":"GET https://api.nsr.stateset.com/api/v1/types/constraints-prompt","href":"/api-reference/nsr/types/types-constraints-prompt-list"},{"title":"List available primitive types","api":"GET https://api.nsr.stateset.com/api/v1/types","href":"/api-reference/nsr/types/types-list"},{"title":"Delete a predicate signature","api":"DELETE https://api.nsr.stateset.com/api/v1/types/predicates/{name}","href":"/api-reference/nsr/types/types-predicates-by-delete"},{"title":"Get a specific predicate signature","api":"GET https://api.nsr.stateset.com/api/v1/types/predicates/{name}","href":"/api-reference/nsr/types/types-predicates-by-get"},{"title":"Register a new predicate signature","api":"POST https://api.nsr.stateset.com/api/v1/types/predicates","href":"/api-reference/nsr/types/types-predicates-create"},{"title":"List all registered predicates","api":"GET https://api.nsr.stateset.com/api/v1/types/predicates","href":"/api-reference/nsr/types/types-predicates-list"},{"title":"Check if one type is a subtype of another","api":"GET https://api.nsr.stateset.com/api/v1/types/subtypes/{subtype}/{supertype}","href":"/api-reference/nsr/types/types-subtypes-by-by-get"},{"title":"Register a subtype relationship","api":"POST https://api.nsr.stateset.com/api/v1/types/subtypes","href":"/api-reference/nsr/types/types-subtypes-create"},{"title":"Validate a fact against the type registry","api":"POST https://api.nsr.stateset.com/api/v1/types/validate","href":"/api-reference/nsr/types/types-validate-create"}]},{"group":"Beliefs","pages":[{"title":"Get explanation for a belief","api":"GET https://api.nsr.stateset.com/api/v1/beliefs/{proposition}/explain","href":"/api-reference/nsr/beliefs/beliefs-by-explain-get"},{"title":"Get a belief by proposition","api":"GET https://api.nsr.stateset.com/api/v1/beliefs/{proposition}","href":"/api-reference/nsr/beliefs/beliefs-by-get"},{"title":"Get history of revisions for a belief","api":"GET https://api.nsr.stateset.com/api/v1/beliefs/{proposition}/history","href":"/api-reference/nsr/beliefs/beliefs-by-history-get"},{"title":"Check if two beliefs are conflicting","api":"POST https://api.nsr.stateset.com/api/v1/beliefs/conflicts","href":"/api-reference/nsr/beliefs/beliefs-conflicts-create"},{"title":"Contradict a belief (decrease confidence)","api":"POST https://api.nsr.stateset.com/api/v1/beliefs/contradict","href":"/api-reference/nsr/beliefs/beliefs-contradict-create"},{"title":"Add a new belief","api":"POST https://api.nsr.stateset.com/api/v1/beliefs","href":"/api-reference/nsr/beliefs/beliefs-create"},{"title":"Refute a belief (set confidence to zero)","api":"POST https://api.nsr.stateset.com/api/v1/beliefs/refute/{proposition}","href":"/api-reference/nsr/beliefs/beliefs-refute-by-create"},{"title":"Support a belief (increase confidence)","api":"POST https://api.nsr.stateset.com/api/v1/beliefs/support","href":"/api-reference/nsr/beliefs/beliefs-support-create"}]},{"group":"Constraints","pages":[{"title":"Delete a constraint","api":"DELETE https://api.nsr.stateset.com/api/v1/constraints/{id}","href":"/api-reference/nsr/constraints/constraints-by-delete"},{"title":"Get a specific constraint by ID","api":"GET https://api.nsr.stateset.com/api/v1/constraints/{id}","href":"/api-reference/nsr/constraints/constraints-by-get"},{"title":"Create a new constraint","api":"POST https://api.nsr.stateset.com/api/v1/constraints","href":"/api-reference/nsr/constraints/constraints-create"},{"title":"List all constraints","api":"GET https://api.nsr.stateset.com/api/v1/constraints","href":"/api-reference/nsr/constraints/constraints-list"},{"title":"Validate facts against all constraints","api":"POST https://api.nsr.stateset.com/api/v1/constraints/validate","href":"/api-reference/nsr/constraints/constraints-validate-create"}]},{"group":"Rules","pages":[{"title":"Batch create rules","api":"POST https://api.nsr.stateset.com/api/v1/rules/batch","href":"/api-reference/nsr/rules/rules-batch-create"},{"title":"Batch delete rules","api":"POST https://api.nsr.stateset.com/api/v1/rules/batch-delete","href":"/api-reference/nsr/rules/rules-batch-delete-create"},{"title":"Delete a rule by ID","api":"DELETE https://api.nsr.stateset.com/api/v1/rules/{id}","href":"/api-reference/nsr/rules/rules-by-delete"},{"title":"Get a single rule by ID","api":"GET https://api.nsr.stateset.com/api/v1/rules/{id}","href":"/api-reference/nsr/rules/rules-by-get"},{"title":"Soft delete a rule (archives for audit trail)","api":"DELETE https://api.nsr.stateset.com/api/v1/rules/{id}/soft","href":"/api-reference/nsr/rules/rules-by-soft-delete"},{"title":"Update a rule by ID","api":"PATCH https://api.nsr.stateset.com/api/v1/rules/{id}","href":"/api-reference/nsr/rules/rules-by-update"},{"title":"Create (or upsert) an organization policy rule.","api":"POST https://api.nsr.stateset.com/api/v1/rules","href":"/api-reference/nsr/rules/rules-create"},{"title":"Dry-run lint check for a proposed rule without inserting it.","api":"POST https://api.nsr.stateset.com/api/v1/rules/lint","href":"/api-reference/nsr/rules/rules-lint-create"},{"title":"List all rules","api":"GET https://api.nsr.stateset.com/api/v1/rules","href":"/api-reference/nsr/rules/rules-list"}]},{"group":"NSR-L","pages":[{"title":"Assert facts and rules from NSR-L code","api":"POST https://api.nsr.stateset.com/api/v1/nsrl/assert","href":"/api-reference/nsr/nsr-l/nsrl-assert-create"},{"title":"Execute NSR-L code (facts, rules, queries)","api":"POST https://api.nsr.stateset.com/api/v1/nsrl/execute","href":"/api-reference/nsr/nsr-l/nsrl-execute-create"},{"title":"Parse NSR-L code without executing","api":"POST https://api.nsr.stateset.com/api/v1/nsrl/parse","href":"/api-reference/nsr/nsr-l/nsrl-parse-create"},{"title":"Fetch the persisted NSR-L program for the current org.","api":"GET https://api.nsr.stateset.com/api/v1/nsrl/program","href":"/api-reference/nsr/nsr-l/nsrl-program-list"},{"title":"Replace the current NSR-L program (creates a new version).","api":"PUT https://api.nsr.stateset.com/api/v1/nsrl/program","href":"/api-reference/nsr/nsr-l/nsrl-program-update"},{"title":"Prove a query using classical resolution theorem proving over the current NSR-L…","api":"POST https://api.nsr.stateset.com/api/v1/nsrl/prove","href":"/api-reference/nsr/nsr-l/nsrl-prove-create"},{"title":"Fetch a specific program version.","api":"GET https://api.nsr.stateset.com/api/v1/nsrl/versions/{id}","href":"/api-reference/nsr/nsr-l/nsrl-versions-by-get"},{"title":"Roll back to a previous program version.","api":"POST https://api.nsr.stateset.com/api/v1/nsrl/versions/{id}/rollback","href":"/api-reference/nsr/nsr-l/nsrl-versions-by-rollback-create"},{"title":"List program versions for the current org.","api":"GET https://api.nsr.stateset.com/api/v1/nsrl/versions","href":"/api-reference/nsr/nsr-l/nsrl-versions-list"}]},{"group":"Reasoning","pages":[{"title":"Handler for POST /api/v1/agents/llm/generate","api":"POST https://api.nsr.stateset.com/api/v1/agents/llm/generate","href":"/api-reference/nsr/reasoning/agents-llm-generate-create"},{"title":"Recursive chat execute actions handler","api":"POST https://api.nsr.stateset.com/api/v2/nsr/chat/executions/{receipt_id}","href":"/api-reference/nsr/reasoning/api-v2-nsr-chat-executions-by-create"},{"title":"Recursive chat solve handler","api":"POST https://api.nsr.stateset.com/api/v2/nsr/chat/solve","href":"/api-reference/nsr/reasoning/api-v2-nsr-chat-solve-create"},{"title":"Recursive chat solve stream handler","api":"POST https://api.nsr.stateset.com/api/v2/nsr/chat/solve/stream","href":"/api-reference/nsr/reasoning/api-v2-nsr-chat-solve-stream-create"},{"title":"Perform backward chaining to prove a goal","api":"POST https://api.nsr.stateset.com/api/v1/backward-chain","href":"/api-reference/nsr/reasoning/backward-chain-create"},{"title":"Handler for POST /api/v1/compile","api":"POST https://api.nsr.stateset.com/api/v1/compile","href":"/api-reference/nsr/reasoning/compile-create"},{"title":"Handler for GET /api/v1/events","api":"GET https://api.nsr.stateset.com/api/v1/events","href":"/api-reference/nsr/reasoning/events-list"},{"title":"Generate an explanation for a query","api":"POST https://api.nsr.stateset.com/api/v1/explain","href":"/api-reference/nsr/reasoning/explain-create"},{"title":"Forward chaining endpoint with parameters","api":"POST https://api.nsr.stateset.com/api/v1/forward-chain","href":"/api-reference/nsr/reasoning/forward-chain-create"},{"title":"Handler for POST /api/v1/rag/query","api":"POST https://api.nsr.stateset.com/api/v1/rag/query","href":"/api-reference/nsr/reasoning/rag-query-create"},{"title":"Execute a reasoning query using the NSR engine.","api":"POST https://api.nsr.stateset.com/api/v1/reason","href":"/api-reference/nsr/reasoning/reason-create"},{"title":"Induce candidate rules from labeled examples.","api":"POST https://api.nsr.stateset.com/api/v1/reason/induce-rules","href":"/api-reference/nsr/reasoning/reason-induce-rules-create"},{"title":"Reason at time handler","api":"GET https://api.nsr.stateset.com/api/v1/reason","href":"/api-reference/nsr/reasoning/reason-list"},{"title":"Strategy stats handler","api":"GET https://api.nsr.stateset.com/api/v1/reason/strategy-stats","href":"/api-reference/nsr/reasoning/reason-strategy-stats-list"},{"title":"Handler for POST /api/v1/reason/stream","api":"POST https://api.nsr.stateset.com/api/v1/reason/stream","href":"/api-reference/nsr/reasoning/reason-stream-create"},{"title":"Handler for GET /api/v1/reason/stream?query=...\u0026strategy=...","api":"GET https://api.nsr.stateset.com/api/v1/reason/stream","href":"/api-reference/nsr/reasoning/reason-stream-list"},{"title":"Handler for POST /api/v1/validate","api":"POST https://api.nsr.stateset.com/api/v1/validate","href":"/api-reference/nsr/reasoning/validate-create"},{"title":"Handler for POST /api/v1/validate_ir","api":"POST https://api.nsr.stateset.com/api/v1/validate_ir","href":"/api-reference/nsr/reasoning/validate_ir-create"}]},{"group":"NSR Machine","pages":[{"title":"Evaluate the NSR Machine on test examples","api":"POST https://api.nsr.stateset.com/api/v1/nsr/evaluate","href":"/api-reference/nsr/nsr-machine/nsr-evaluate-create"},{"title":"Toggle a feature on or off","api":"POST https://api.nsr.stateset.com/api/v1/nsr/features","href":"/api-reference/nsr/nsr-machine/nsr-features-create"},{"title":"List all features and their status","api":"GET https://api.nsr.stateset.com/api/v1/nsr/features","href":"/api-reference/nsr/nsr-machine/nsr-features-list"},{"title":"Branch from a parent thought to multiple children","api":"POST https://api.nsr.stateset.com/api/v1/nsr/got/branch","href":"/api-reference/nsr/nsr-machine/nsr-got-branch-create"},{"title":"Connect two thoughts in the graph","api":"POST https://api.nsr.stateset.com/api/v1/nsr/got/connect","href":"/api-reference/nsr/nsr-machine/nsr-got-connect-create"},{"title":"Get Graph of Thoughts status","api":"GET https://api.nsr.stateset.com/api/v1/nsr/got","href":"/api-reference/nsr/nsr-machine/nsr-got-list"},{"title":"Add a thought to the reasoning graph","api":"POST https://api.nsr.stateset.com/api/v1/nsr/got/thoughts","href":"/api-reference/nsr/nsr-machine/nsr-got-thoughts-create"},{"title":"List/search Graph-of-Thoughts nodes","api":"GET https://api.nsr.stateset.com/api/v1/nsr/got/thoughts","href":"/api-reference/nsr/nsr-machine/nsr-got-thoughts-list"},{"title":"Perform inference using the NSR Machine","api":"POST https://api.nsr.stateset.com/api/v1/nsr/infer","href":"/api-reference/nsr/nsr-machine/nsr-infer-create"},{"title":"Perform ensemble inference with input dropout for confidence calibration","api":"POST https://api.nsr.stateset.com/api/v1/nsr/infer/ensemble","href":"/api-reference/nsr/nsr-machine/nsr-infer-ensemble-create"},{"title":"Get the program for a symbol","api":"GET https://api.nsr.stateset.com/api/v1/nsr/programs/{symbol_id}","href":"/api-reference/nsr/nsr-machine/nsr-programs-by-get"},{"title":"Set a program for a symbol","api":"POST https://api.nsr.stateset.com/api/v1/nsr/programs","href":"/api-reference/nsr/nsr-machine/nsr-programs-create"},{"title":"Evaluate a program with optional arguments","api":"POST https://api.nsr.stateset.com/api/v1/nsr/programs/evaluate","href":"/api-reference/nsr/nsr-machine/nsr-programs-evaluate-create"},{"title":"Get strategy recommendation for a task","api":"POST https://api.nsr.stateset.com/api/v1/nsr/recommend-strategy","href":"/api-reference/nsr/nsr-machine/nsr-recommend-strategy-create"},{"title":"Get NSR Machine statistics","api":"GET https://api.nsr.stateset.com/api/v1/nsr/stats","href":"/api-reference/nsr/nsr-machine/nsr-stats-list"},{"title":"Add multiple symbols at once","api":"POST https://api.nsr.stateset.com/api/v1/nsr/symbols/batch","href":"/api-reference/nsr/nsr-machine/nsr-symbols-batch-create"},{"title":"Add a symbol to the NSR Machine vocabulary","api":"POST https://api.nsr.stateset.com/api/v1/nsr/symbols","href":"/api-reference/nsr/nsr-machine/nsr-symbols-create"},{"title":"List all symbols in the vocabulary","api":"GET https://api.nsr.stateset.com/api/v1/nsr/symbols","href":"/api-reference/nsr/nsr-machine/nsr-symbols-list"},{"title":"Train the NSR Machine on examples","api":"POST https://api.nsr.stateset.com/api/v1/nsr/train","href":"/api-reference/nsr/nsr-machine/nsr-train-create"},{"title":"Get uncertainty estimation","api":"GET https://api.nsr.stateset.com/api/v1/nsr/uncertainty","href":"/api-reference/nsr/nsr-machine/nsr-uncertainty-list"},{"title":"Batch validate responses using NSR-L rules + text signals.","api":"POST https://api.nsr.stateset.com/api/v1/nsr/validate/batch","href":"/api-reference/nsr/nsr-machine/nsr-validate-batch-create"},{"title":"Validate a response using NSR-L rules + text signals.","api":"POST https://api.nsr.stateset.com/api/v1/nsr/validate","href":"/api-reference/nsr/nsr-machine/nsr-validate-create"},{"title":"Create multiple validation cases in one request.","api":"POST https://api.nsr.stateset.com/api/v1/nsr/validation/cases/batch","href":"/api-reference/nsr/nsr-machine/nsr-validation-cases-batch-create"},{"title":"Replay a stored validation case and persist the run.","api":"POST https://api.nsr.stateset.com/api/v1/nsr/validation/cases/{id}/replay","href":"/api-reference/nsr/nsr-machine/nsr-validation-cases-by-replay-create"},{"title":"Create a single validation case.","api":"POST https://api.nsr.stateset.com/api/v1/nsr/validation/cases","href":"/api-reference/nsr/nsr-machine/nsr-validation-cases-create"},{"title":"List persisted validation cases.","api":"GET https://api.nsr.stateset.com/api/v1/nsr/validation/cases","href":"/api-reference/nsr/nsr-machine/nsr-validation-cases-list"},{"title":"List validation runs for the current org.","api":"GET https://api.nsr.stateset.com/api/v1/nsr/validation/runs","href":"/api-reference/nsr/nsr-machine/nsr-validation-runs-list"},{"title":"Bind two VSA vectors (role-filler composition)","api":"POST https://api.nsr.stateset.com/api/v1/nsr/vsa/bind","href":"/api-reference/nsr/nsr-machine/nsr-vsa-bind-create"},{"title":"Bundle multiple VSA vectors (superposition/set union)","api":"POST https://api.nsr.stateset.com/api/v1/nsr/vsa/bundle","href":"/api-reference/nsr/nsr-machine/nsr-vsa-bundle-create"},{"title":"Classify input features using VSA similarity against feature-based class…","api":"POST https://api.nsr.stateset.com/api/v1/nsr/vsa/classify","href":"/api-reference/nsr/nsr-machine/nsr-vsa-classify-create"},{"title":"Encode a symbol or add a concept to VSA","api":"POST https://api.nsr.stateset.com/api/v1/nsr/vsa/encode","href":"/api-reference/nsr/nsr-machine/nsr-vsa-encode-create"},{"title":"Get VSA status","api":"GET https://api.nsr.stateset.com/api/v1/nsr/vsa","href":"/api-reference/nsr/nsr-machine/nsr-vsa-list"},{"title":"Query VSA cleanup memory","api":"POST https://api.nsr.stateset.com/api/v1/nsr/vsa/query","href":"/api-reference/nsr/nsr-machine/nsr-vsa-query-create"},{"title":"PolicyEvaluate","api":"POST https://api.nsr.stateset.com/api/v1/policy/evaluate","href":"/api-reference/nsr/nsr-machine/policy-evaluate-create"},{"title":"PolicyInfer","api":"POST https://api.nsr.stateset.com/api/v1/policy/infer","href":"/api-reference/nsr/nsr-machine/policy-infer-create"},{"title":"SandboxPolicyEvaluate","api":"POST https://api.nsr.stateset.com/api/v1/policy/sandbox/evaluate","href":"/api-reference/nsr/nsr-machine/policy-sandbox-evaluate-create"},{"title":"PolicyTrain","api":"POST https://api.nsr.stateset.com/api/v1/policy/train","href":"/api-reference/nsr/nsr-machine/policy-train-create"},{"title":"PolicyVocabInit","api":"POST https://api.nsr.stateset.com/api/v1/policy/vocab/init","href":"/api-reference/nsr/nsr-machine/policy-vocab-init-create"}]},{"group":"Machines","pages":[{"title":"Activate a machine handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/activate","href":"/api-reference/nsr/machines/machines-activate-create"},{"title":"Compile machine seed handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/compile","href":"/api-reference/nsr/machines/machines-compile-create"},{"title":"Evaluate machine handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/evaluate","href":"/api-reference/nsr/machines/machines-evaluate-create"},{"title":"Evaluate seed machine handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/evaluate-seed","href":"/api-reference/nsr/machines/machines-evaluate-seed-create"},{"title":"Infer machine handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/infer","href":"/api-reference/nsr/machines/machines-infer-create"},{"title":"List machines handlers","api":"GET https://api.nsr.stateset.com/api/v1/machines","href":"/api-reference/nsr/machines/machines-list"},{"title":"Provision machine handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/provision","href":"/api-reference/nsr/machines/machines-provision-create"},{"title":"Seed machine handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/seed","href":"/api-reference/nsr/machines/machines-seed-create"},{"title":"Machine status handler","api":"GET https://api.nsr.stateset.com/api/v1/machines/status","href":"/api-reference/nsr/machines/machines-status-list"},{"title":"Train machine handler","api":"POST https://api.nsr.stateset.com/api/v1/machines/train","href":"/api-reference/nsr/machines/machines-train-create"}]},{"group":"Flywheel","pages":[{"title":"Flywheel review candidate handler","api":"POST https://api.nsr.stateset.com/api/v1/flywheel/candidates/{id}/review","href":"/api-reference/nsr/flywheel/flywheel-candidates-by-review-create"},{"title":"Flywheel candidates handler","api":"GET https://api.nsr.stateset.com/api/v1/flywheel/candidates","href":"/api-reference/nsr/flywheel/flywheel-candidates-list"},{"title":"Flywheel curve handler","api":"GET https://api.nsr.stateset.com/api/v1/flywheel/curve","href":"/api-reference/nsr/flywheel/flywheel-curve-list"},{"title":"Noise-based rule demotion — the pruning counterpart of evidence-based","api":"POST https://api.nsr.stateset.com/api/v1/flywheel/demote-noisy","href":"/api-reference/nsr/flywheel/flywheel-demote-noisy-create"},{"title":"Flywheel events handler","api":"GET https://api.nsr.stateset.com/api/v1/flywheel/events","href":"/api-reference/nsr/flywheel/flywheel-events-list"},{"title":"Flywheel feedback handler","api":"POST https://api.nsr.stateset.com/api/v1/flywheel/feedback","href":"/api-reference/nsr/flywheel/flywheel-feedback-create"},{"title":"Flywheel process handler","api":"POST https://api.nsr.stateset.com/api/v1/flywheel/process","href":"/api-reference/nsr/flywheel/flywheel-process-create"},{"title":"Flywheel stats handler","api":"GET https://api.nsr.stateset.com/api/v1/flywheel/stats","href":"/api-reference/nsr/flywheel/flywheel-stats-list"},{"title":"Flywheel train handler","api":"POST https://api.nsr.stateset.com/api/v1/flywheel/train","href":"/api-reference/nsr/flywheel/flywheel-train-create"}]},{"group":"Macros","pages":[{"title":"Upload a whole library in one call.","api":"POST https://api.nsr.stateset.com/api/v1/macros/batch","href":"/api-reference/nsr/macros/macros-batch-create"},{"title":"Delete a macro.","api":"DELETE https://api.nsr.stateset.com/api/v1/macros/{id}","href":"/api-reference/nsr/macros/macros-by-delete"},{"title":"Fetch one macro by id.","api":"GET https://api.nsr.stateset.com/api/v1/macros/{id}","href":"/api-reference/nsr/macros/macros-by-get"},{"title":"Render a macro against a context — the dry run before sending.","api":"POST https://api.nsr.stateset.com/api/v1/macros/{id}/render","href":"/api-reference/nsr/macros/macros-by-render-create"},{"title":"Update macro metadata — approve it, bind it to a rule, toggle auto-send.","api":"PATCH https://api.nsr.stateset.com/api/v1/macros/{id}","href":"/api-reference/nsr/macros/macros-by-update"},{"title":"Create or replace a macro.","api":"POST https://api.nsr.stateset.com/api/v1/macros","href":"/api-reference/nsr/macros/macros-create"},{"title":"List this org's macros.","api":"GET https://api.nsr.stateset.com/api/v1/macros","href":"/api-reference/nsr/macros/macros-list"}]},{"group":"Templates","pages":[{"title":"Apply a template handler","api":"POST https://api.nsr.stateset.com/api/v1/templates/{slug}/apply","href":"/api-reference/nsr/templates/templates-by-apply-create"},{"title":"Get a template handler","api":"GET https://api.nsr.stateset.com/api/v1/templates/{slug}","href":"/api-reference/nsr/templates/templates-by-get"},{"title":"List templates handlers","api":"GET https://api.nsr.stateset.com/api/v1/templates","href":"/api-reference/nsr/templates/templates-list"}]},{"group":"Answer","pages":[{"title":"Answer a queue of tickets in one call.","api":"POST https://api.nsr.stateset.com/api/v1/answer/batch","href":"/api-reference/nsr/answer/answer-batch-create"},{"title":"Answer one ticket.","api":"POST https://api.nsr.stateset.com/api/v1/answer","href":"/api-reference/nsr/answer/answer-create"}]},{"group":"Conversations","pages":[{"title":"Delete a conversation handler","api":"DELETE https://api.nsr.stateset.com/api/v1/conversations/{id}","href":"/api-reference/nsr/conversations/conversations-by-delete"},{"title":"Get a conversation with all its messages.","api":"GET https://api.nsr.stateset.com/api/v1/conversations/{id}","href":"/api-reference/nsr/conversations/conversations-by-get"},{"title":"Update a conversation (title and/or archive status).","api":"PATCH https://api.nsr.stateset.com/api/v1/conversations/{id}","href":"/api-reference/nsr/conversations/conversations-by-update"},{"title":"Create a new conversation.","api":"POST https://api.nsr.stateset.com/api/v1/conversations","href":"/api-reference/nsr/conversations/conversations-create"},{"title":"List conversations for the authenticated org.","api":"GET https://api.nsr.stateset.com/api/v1/conversations","href":"/api-reference/nsr/conversations/conversations-list"}]},{"group":"Sessions","pages":[{"title":"Update session context","api":"PATCH https://api.nsr.stateset.com/api/v1/sessions/{session_id}/context","href":"/api-reference/nsr/sessions/sessions-by-context-update"},{"title":"Get session info","api":"GET https://api.nsr.stateset.com/api/v1/sessions/{session_id}","href":"/api-reference/nsr/sessions/sessions-by-get"},{"title":"Get full session history","api":"GET https://api.nsr.stateset.com/api/v1/sessions/{session_id}/history","href":"/api-reference/nsr/sessions/sessions-by-history-get"},{"title":"Create a new session","api":"POST https://api.nsr.stateset.com/api/v1/sessions","href":"/api-reference/nsr/sessions/sessions-create"}]},{"group":"Ingestion","pages":[{"title":"Get a file content handler","api":"GET https://api.nsr.stateset.com/v1/files/{id}/content","href":"/api-reference/nsr/ingestion/v1-files-by-content-get"},{"title":"Get a file handler","api":"GET https://api.nsr.stateset.com/v1/files/{id}","href":"/api-reference/nsr/ingestion/v1-files-by-get"},{"title":"Create a file handler","api":"POST https://api.nsr.stateset.com/v1/files","href":"/api-reference/nsr/ingestion/v1-files-create"},{"title":"List files handlers","api":"GET https://api.nsr.stateset.com/v1/files","href":"/api-reference/nsr/ingestion/v1-files-list"},{"title":"Get an ingest job handler","api":"GET https://api.nsr.stateset.com/v1/ingest/jobs/{id}","href":"/api-reference/nsr/ingestion/v1-ingest-jobs-by-get"},{"title":"Create an ingest job handler","api":"POST https://api.nsr.stateset.com/v1/ingest/jobs","href":"/api-reference/nsr/ingestion/v1-ingest-jobs-create"},{"title":"List ingest jobs handlers","api":"GET https://api.nsr.stateset.com/v1/ingest/jobs","href":"/api-reference/nsr/ingestion/v1-ingest-jobs-list"}]},{"group":"Jobs","pages":[{"title":"Submit a batch inference job","api":"POST https://api.nsr.stateset.com/api/v1/jobs/batch-infer","href":"/api-reference/nsr/jobs/jobs-batch-infer-create"},{"title":"Cancel a running job","api":"POST https://api.nsr.stateset.com/api/v1/jobs/{job_id}/cancel","href":"/api-reference/nsr/jobs/jobs-by-cancel-create"},{"title":"Delete a completed job","api":"DELETE https://api.nsr.stateset.com/api/v1/jobs/{job_id}","href":"/api-reference/nsr/jobs/jobs-by-delete"},{"title":"Get job status","api":"GET https://api.nsr.stateset.com/api/v1/jobs/{job_id}","href":"/api-reference/nsr/jobs/jobs-by-get"},{"title":"List all jobs with filtering and pagination","api":"GET https://api.nsr.stateset.com/api/v1/jobs","href":"/api-reference/nsr/jobs/jobs-list"}]},{"group":"Model","pages":[{"title":"Delete a checkpoint","api":"DELETE https://api.nsr.stateset.com/api/v1/model/checkpoints/{checkpoint_id}","href":"/api-reference/nsr/model/model-checkpoints-by-delete"},{"title":"Get checkpoint details","api":"GET https://api.nsr.stateset.com/api/v1/model/checkpoints/{checkpoint_id}","href":"/api-reference/nsr/model/model-checkpoints-by-get"},{"title":"Load checkpoint (restore model state)","api":"POST https://api.nsr.stateset.com/api/v1/model/checkpoints/{checkpoint_id}/load","href":"/api-reference/nsr/model/model-checkpoints-by-load-create"},{"title":"Save model checkpoint","api":"POST https://api.nsr.stateset.com/api/v1/model/checkpoints","href":"/api-reference/nsr/model/model-checkpoints-create"},{"title":"List model checkpoints","api":"GET https://api.nsr.stateset.com/api/v1/model/checkpoints","href":"/api-reference/nsr/model/model-checkpoints-list"},{"title":"Compare two model checkpoints","api":"POST https://api.nsr.stateset.com/api/v1/model/compare","href":"/api-reference/nsr/model/model-compare-create"},{"title":"Export model","api":"POST https://api.nsr.stateset.com/api/v1/model/export","href":"/api-reference/nsr/model/model-export-create"},{"title":"Get current model information","api":"GET https://api.nsr.stateset.com/api/v1/model/info","href":"/api-reference/nsr/model/model-info-list"}]},{"group":"Provider compatibility","pages":[{"title":"OpenAI-compatible chat completions endpoint backed by the recursive v2","api":"POST https://api.nsr.stateset.com/v1/chat/completions","href":"/api-reference/nsr/provider-compatibility/v1-chat-completions-create"},{"title":"Anthropic-compatible token counting (POST /v1/messages/count_tokens).","api":"POST https://api.nsr.stateset.com/v1/messages/count_tokens","href":"/api-reference/nsr/provider-compatibility/v1-messages-count_tokens-create"},{"title":"Anthropic-compatible Messages endpoint backed by the recursive NSR solver.","api":"POST https://api.nsr.stateset.com/v1/messages","href":"/api-reference/nsr/provider-compatibility/v1-messages-create"},{"title":"OpenAI-compatible model catalog for the NSR chat facade.","api":"GET https://api.nsr.stateset.com/v1/models","href":"/api-reference/nsr/provider-compatibility/v1-models-list"},{"title":"Get a response handler","api":"GET https://api.nsr.stateset.com/v1/responses/{response_id}","href":"/api-reference/nsr/provider-compatibility/v1-responses-by-get"},{"title":"List response input items handlers","api":"GET https://api.nsr.stateset.com/v1/responses/{response_id}/input_items","href":"/api-reference/nsr/provider-compatibility/v1-responses-by-input_items-get"},{"title":"Nsr responses handler","api":"POST https://api.nsr.stateset.com/v1/responses","href":"/api-reference/nsr/provider-compatibility/v1-responses-create"}]},{"group":"Agents","pages":[{"title":"Get an agent handler","api":"GET https://api.nsr.stateset.com/api/v1/agents/{agent_name}","href":"/api-reference/nsr/agents/agents-by-get"},{"title":"Restart agent handler","api":"POST https://api.nsr.stateset.com/api/v1/agents/{agent_name}/restart","href":"/api-reference/nsr/agents/agents-by-restart-create"},{"title":"Start agent handler","api":"POST https://api.nsr.stateset.com/api/v1/agents/{agent_name}/start","href":"/api-reference/nsr/agents/agents-by-start-create"},{"title":"Stop agent handler","api":"POST https://api.nsr.stateset.com/api/v1/agents/{agent_name}/stop","href":"/api-reference/nsr/agents/agents-by-stop-create"},{"title":"List agents handlers","api":"GET https://api.nsr.stateset.com/api/v1/agents","href":"/api-reference/nsr/agents/agents-list"}]},{"group":"Sandbox","pages":[{"title":"Create an ephemeral sandbox pod.","api":"POST https://api.nsr.stateset.com/api/v1/sandbox/create","href":"/api-reference/nsr/sandbox/sandbox-create-create"},{"title":"Execute a command in an existing sandbox.","api":"POST https://api.nsr.stateset.com/api/v1/sandbox/execute","href":"/api-reference/nsr/sandbox/sandbox-execute-create"},{"title":"Execute code inline — creates a sandbox, runs the code, returns output.","api":"POST https://api.nsr.stateset.com/api/v1/sandbox/run","href":"/api-reference/nsr/sandbox/sandbox-run-create"}]},{"group":"Webhooks","pages":[{"title":"Delete a webhook handler","api":"DELETE https://api.nsr.stateset.com/api/v1/webhooks/{id}","href":"/api-reference/nsr/webhooks/webhooks-by-delete"},{"title":"List deliveries handlers","api":"GET https://api.nsr.stateset.com/api/v1/webhooks/{id}/deliveries","href":"/api-reference/nsr/webhooks/webhooks-by-deliveries-get"},{"title":"Get a webhook handler","api":"GET https://api.nsr.stateset.com/api/v1/webhooks/{id}","href":"/api-reference/nsr/webhooks/webhooks-by-get"},{"title":"Test webhook handler","api":"POST https://api.nsr.stateset.com/api/v1/webhooks/{id}/test","href":"/api-reference/nsr/webhooks/webhooks-by-test-create"},{"title":"Create a webhook handler","api":"POST https://api.nsr.stateset.com/api/v1/webhooks","href":"/api-reference/nsr/webhooks/webhooks-create"},{"title":"List webhooks handlers","api":"GET https://api.nsr.stateset.com/api/v1/webhooks","href":"/api-reference/nsr/webhooks/webhooks-list"}]},{"group":"Billing","pages":[{"title":"Create a checkout handler","api":"POST https://api.nsr.stateset.com/api/v1/billing/checkout","href":"/api-reference/nsr/billing/billing-checkout-create"},{"title":"Create a credit checkout handler","api":"POST https://api.nsr.stateset.com/api/v1/billing/credits/checkout","href":"/api-reference/nsr/billing/billing-credits-checkout-create"},{"title":"Get credits handlers","api":"GET https://api.nsr.stateset.com/api/v1/billing/credits","href":"/api-reference/nsr/billing/billing-credits-list"},{"title":"Purchase credits handler","api":"POST https://api.nsr.stateset.com/api/v1/billing/credits/purchase","href":"/api-reference/nsr/billing/billing-credits-purchase-create"},{"title":"List invoices handlers","api":"GET https://api.nsr.stateset.com/api/v1/billing/invoices","href":"/api-reference/nsr/billing/billing-invoices-list"},{"title":"List payment methods handlers","api":"GET https://api.nsr.stateset.com/api/v1/billing/payment-methods","href":"/api-reference/nsr/billing/billing-payment-methods-list"},{"title":"List plans handlers","api":"GET https://api.nsr.stateset.com/api/v1/billing/plans","href":"/api-reference/nsr/billing/billing-plans-list"},{"title":"Create a portal handler","api":"POST https://api.nsr.stateset.com/api/v1/billing/portal","href":"/api-reference/nsr/billing/billing-portal-create"},{"title":"Setup payment handler","api":"POST https://api.nsr.stateset.com/api/v1/billing/setup-payment","href":"/api-reference/nsr/billing/billing-setup-payment-create"},{"title":"Get subscription handlers","api":"GET https://api.nsr.stateset.com/api/v1/billing/subscription","href":"/api-reference/nsr/billing/billing-subscription-list"},{"title":"Get usage handlers","api":"GET https://api.nsr.stateset.com/api/v1/billing/usage","href":"/api-reference/nsr/billing/billing-usage-list"},{"title":"Stripe webhook handler","api":"POST https://api.nsr.stateset.com/api/v1/billing/webhooks/stripe","href":"/api-reference/nsr/billing/billing-webhooks-stripe-create"}]},{"group":"Metering / Marketplace","pages":[{"title":"AWS Marketplace SaaS onboarding: resolve the registration token to the","api":"POST https://api.nsr.stateset.com/v1/metering/aws/register","href":"/api-reference/nsr/metering-marketplace/v1-metering-aws-register-create"},{"title":"Azure Marketplace SaaS onboarding: resolve the marketplace token to the SaaS","api":"POST https://api.nsr.stateset.com/v1/metering/azure/register","href":"/api-reference/nsr/metering-marketplace/v1-metering-azure-register-create"},{"title":"Read an org's current entitlement (admin).","api":"GET https://api.nsr.stateset.com/v1/metering/entitlement/{org_id}","href":"/api-reference/nsr/metering-marketplace/v1-metering-entitlement-by-get"},{"title":"Link an org to its billing entitlement (admin). Idempotent — re-linking","api":"POST https://api.nsr.stateset.com/v1/metering/entitlement","href":"/api-reference/nsr/metering-marketplace/v1-metering-entitlement-create"},{"title":"GCP Marketplace Pub/Sub push endpoint. GCP delivers Procurement events here","api":"POST https://api.nsr.stateset.com/v1/metering/gcp/pubsub","href":"/api-reference/nsr/metering-marketplace/v1-metering-gcp-pubsub-create"}]},{"group":"Authentication","pages":[{"title":"Revoke an API key by id.","api":"DELETE https://api.nsr.stateset.com/api/v1/auth/keys/{id}","href":"/api-reference/nsr/authentication/auth-keys-by-delete"},{"title":"Create a new API key for the current org.","api":"POST https://api.nsr.stateset.com/api/v1/auth/keys","href":"/api-reference/nsr/authentication/auth-keys-create"},{"title":"List API keys for the current org.","api":"GET https://api.nsr.stateset.com/api/v1/auth/keys","href":"/api-reference/nsr/authentication/auth-keys-list"},{"title":"Authenticate a user and return a fresh API key.","api":"POST https://api.nsr.stateset.com/api/v1/auth/login","href":"/api-reference/nsr/authentication/auth-login-create"},{"title":"Return the current authenticated API session context.","api":"GET https://api.nsr.stateset.com/api/v1/auth/session","href":"/api-reference/nsr/authentication/auth-session-list"},{"title":"Create a new user account and return an API key.","api":"POST https://api.nsr.stateset.com/api/v1/auth/signup","href":"/api-reference/nsr/authentication/auth-signup-create"}]},{"group":"NSR","pages":[{"title":"Analyze a customer message and return a grounded recursive completion.","api":"POST https://api.nsr.stateset.com/api/v1/nsr/chat","href":"/api-reference/nsr/nsr/nsr-chat-create"},{"title":"Chat execute actions handler","api":"POST https://api.nsr.stateset.com/api/v1/nsr/chat/executions/{receipt_id}","href":"/api-reference/nsr/nsr/nsr-chat-executions-by-create"},{"title":"Chat stream handler","api":"POST https://api.nsr.stateset.com/api/v1/nsr/chat/stream","href":"/api-reference/nsr/nsr/nsr-chat-stream-create"}]},{"group":"Health","pages":[{"title":"Health check endpoint","api":"GET https://api.nsr.stateset.com/health","href":"/api-reference/nsr/health/health-list"},{"title":"Readiness probe for Kubernetes and orchestration systems","api":"GET https://api.nsr.stateset.com/ready","href":"/api-reference/nsr/health/ready-list"}]},{"group":"Audit","pages":[{"title":"Get deletion audit trail","api":"GET https://api.nsr.stateset.com/api/v1/audit/deletions","href":"/api-reference/nsr/audit/audit-deletions-list"}]},{"group":"Compliance","pages":[{"title":"Audit export handler","api":"GET https://api.nsr.stateset.com/api/v1/audit/export","href":"/api-reference/nsr/compliance/audit-export-list"}]},{"group":"Decisions","pages":[{"title":"Chronological NDJSON export of the org's durable decision log for","api":"GET https://api.nsr.stateset.com/v1/decisions/export","href":"/api-reference/nsr/decisions/v1-decisions-export-list"}]},{"group":"Gss","pages":[{"title":"Live GSS seed-pack metadata.","api":"GET https://api.nsr.stateset.com/api/v1/gss/seed","href":"/api-reference/nsr/gss/gss-seed-list"}]},{"group":"Platform","pages":[{"title":"Status handler","api":"GET https://api.nsr.stateset.com/api/v1/status","href":"/api-reference/nsr/platform/status-list"}]},{"group":"Replies","pages":[{"title":"Decide, then draft — one call.","api":"POST https://api.nsr.stateset.com/api/v1/replies","href":"/api-reference/nsr/replies/replies-create"}]}]},{"tab":"Computer Use","icon":"monitor","groups":[{"group":"Overview","pages":[{"title":"Computer Use API","href":"/api-reference/computer-use/overview"},{"title":"Computer Use API history","href":"/api-reference/computer-use/history"}]},{"group":"Jobs","pages":[{"title":"Get Job Artifacts","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/artifacts","href":"/api-reference/computer-use/jobs-by-artifacts-get"},{"title":"Cancel Job V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/cancel","href":"/api-reference/computer-use/jobs-by-cancel-create"},{"title":"Clone Job To Template V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/clone-to-template","href":"/api-reference/computer-use/jobs-by-clone-to-template-create"},{"title":"Get Job Cost Breakdown V1","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/cost-breakdown","href":"/api-reference/computer-use/jobs-by-cost-breakdown-get"},{"title":"Duplicate Job V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/duplicate","href":"/api-reference/computer-use/jobs-by-duplicate-create"},{"title":"Stream Job Events","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/events","href":"/api-reference/computer-use/jobs-by-events-get"},{"title":"Extend Job Budget V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/extend-budget","href":"/api-reference/computer-use/jobs-by-extend-budget-create"},{"title":"Get Job Status","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}","href":"/api-reference/computer-use/jobs-by-get"},{"title":"Raw conversation messages from the agent's checkpoint","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/messages","href":"/api-reference/computer-use/jobs-by-messages-get"},{"title":"Replay Job As New V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/replay-as-new","href":"/api-reference/computer-use/jobs-by-replay-as-new-create"},{"title":"Get Job Replay Screenshot","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/replay/{exec_id}/screenshot","href":"/api-reference/computer-use/jobs-by-replay-by-screenshot-get"},{"title":"Get Job Replay","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/replay","href":"/api-reference/computer-use/jobs-by-replay-get"},{"title":"Replay Job Webhook V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/replay-webhook","href":"/api-reference/computer-use/jobs-by-replay-webhook-create"},{"title":"Get Job Result","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/result","href":"/api-reference/computer-use/jobs-by-result-get"},{"title":"Retry Job V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/retry","href":"/api-reference/computer-use/jobs-by-retry-create"},{"title":"Update Job Tags V1","api":"PATCH https://api.computer.stateset.app/api/v1/jobs/{job_id}/tags","href":"/api-reference/computer-use/jobs-by-tags-update"},{"title":"Get Job Timeline V1","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/timeline","href":"/api-reference/computer-use/jobs-by-timeline-get"},{"title":"Get Job Transcript","api":"GET https://api.computer.stateset.app/api/v1/jobs/{job_id}/transcript","href":"/api-reference/computer-use/jobs-by-transcript-get"},{"title":"Block until the job reaches terminal status, or until timeout","api":"POST https://api.computer.stateset.app/api/v1/jobs/{job_id}/wait","href":"/api-reference/computer-use/jobs-by-wait-create"},{"title":"Cancel Jobs Batch V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/cancel-batch","href":"/api-reference/computer-use/jobs-cancel-batch-create"},{"title":"Cancel Jobs By Tag V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/cancel-by-tag","href":"/api-reference/computer-use/jobs-cancel-by-tag-create"},{"title":"Cleanup Jobs V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/cleanup","href":"/api-reference/computer-use/jobs-cleanup-create"},{"title":"Side-by-side comparison of two of the tenant's jobs","api":"GET https://api.computer.stateset.app/api/v1/jobs/diff","href":"/api-reference/computer-use/jobs-diff-list"},{"title":"Export jobs as CSV or JSONL","api":"GET https://api.computer.stateset.app/api/v1/jobs/export","href":"/api-reference/computer-use/jobs-export-list"},{"title":"Convenience: just queued / running / awaiting_approval jobs","api":"GET https://api.computer.stateset.app/api/v1/jobs/in-flight","href":"/api-reference/computer-use/jobs-in-flight-list"},{"title":"List Jobs V1","api":"GET https://api.computer.stateset.app/api/v1/jobs","href":"/api-reference/computer-use/jobs-list"},{"title":"Multi Tag Jobs V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/multi-tag","href":"/api-reference/computer-use/jobs-multi-tag-create"},{"title":"Preview Job V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/preview","href":"/api-reference/computer-use/jobs-preview-create"},{"title":"Retry Jobs Batch V1","api":"POST https://api.computer.stateset.app/api/v1/jobs/retry-batch","href":"/api-reference/computer-use/jobs-retry-batch-create"},{"title":"Get Job Stats V1","api":"GET https://api.computer.stateset.app/api/v1/jobs/stats","href":"/api-reference/computer-use/jobs-stats-list"}]},{"group":"Trigger","pages":[{"title":"Trigger Agent Batch","api":"POST https://api.computer.stateset.app/api/v1/trigger/batch","href":"/api-reference/computer-use/trigger-batch-create"},{"title":"Trigger Agent","api":"POST https://api.computer.stateset.app/api/v1/trigger","href":"/api-reference/computer-use/trigger-create"}]},{"group":"Templates","pages":[{"title":"Bulk Delete Templates V1","api":"POST https://api.computer.stateset.app/api/v1/templates/bulk-delete","href":"/api-reference/computer-use/templates-bulk-delete-create"},{"title":"Delete Template V1","api":"DELETE https://api.computer.stateset.app/api/v1/templates/{name}","href":"/api-reference/computer-use/templates-by-delete"},{"title":"Get Template V1","api":"GET https://api.computer.stateset.app/api/v1/templates/{name}","href":"/api-reference/computer-use/templates-by-get"},{"title":"Update Template V1","api":"PATCH https://api.computer.stateset.app/api/v1/templates/{name}","href":"/api-reference/computer-use/templates-by-update"},{"title":"Create Template V1","api":"POST https://api.computer.stateset.app/api/v1/templates","href":"/api-reference/computer-use/templates-create"},{"title":"Import Templates V1","api":"POST https://api.computer.stateset.app/api/v1/templates/import","href":"/api-reference/computer-use/templates-import-create"},{"title":"List Templates V1","api":"GET https://api.computer.stateset.app/api/v1/templates","href":"/api-reference/computer-use/templates-list"}]},{"group":"Skills","pages":[{"title":"Single skill by stable key","api":"GET https://api.computer.stateset.app/api/v1/skills/{key}","href":"/api-reference/computer-use/skills-by-get"},{"title":"Platform-wide skill catalog (read-only on v1)","api":"GET https://api.computer.stateset.app/api/v1/skills","href":"/api-reference/computer-use/skills-list"}]},{"group":"Custom agents","pages":[{"title":"Delete Custom Agent V1","api":"DELETE https://api.computer.stateset.app/api/v1/custom-agents/{agent_id}","href":"/api-reference/computer-use/custom-agents-by-delete"},{"title":"Get Custom Agent V1","api":"GET https://api.computer.stateset.app/api/v1/custom-agents/{agent_id}","href":"/api-reference/computer-use/custom-agents-by-get"},{"title":"Update Custom Agent V1","api":"PATCH https://api.computer.stateset.app/api/v1/custom-agents/{agent_id}","href":"/api-reference/computer-use/custom-agents-by-update"},{"title":"Create Custom Agent V1","api":"POST https://api.computer.stateset.app/api/v1/custom-agents","href":"/api-reference/computer-use/custom-agents-create"},{"title":"List Custom Agents V1","api":"GET https://api.computer.stateset.app/api/v1/custom-agents","href":"/api-reference/computer-use/custom-agents-list"}]},{"group":"Approvals","pages":[{"title":"Approve Approval V1","api":"POST https://api.computer.stateset.app/api/v1/approvals/{approval_id}/approve","href":"/api-reference/computer-use/approvals-by-approve-create"},{"title":"Reject Approval V1","api":"POST https://api.computer.stateset.app/api/v1/approvals/{approval_id}/reject","href":"/api-reference/computer-use/approvals-by-reject-create"},{"title":"List Approvals V1","api":"GET https://api.computer.stateset.app/api/v1/approvals","href":"/api-reference/computer-use/approvals-list"}]},{"group":"Approval policies","pages":[{"title":"Delete Approval Policy V1","api":"DELETE https://api.computer.stateset.app/api/v1/approval-policies/{policy_id}","href":"/api-reference/computer-use/approval-policies-by-delete"},{"title":"Update Approval Policy V1","api":"PATCH https://api.computer.stateset.app/api/v1/approval-policies/{policy_id}","href":"/api-reference/computer-use/approval-policies-by-update"},{"title":"Create Approval Policy V1","api":"POST https://api.computer.stateset.app/api/v1/approval-policies","href":"/api-reference/computer-use/approval-policies-create"},{"title":"List Approval Policies V1","api":"GET https://api.computer.stateset.app/api/v1/approval-policies","href":"/api-reference/computer-use/approval-policies-list"}]},{"group":"Outcomes","pages":[{"title":"Dispute an outcome","api":"POST https://api.computer.stateset.app/api/v1/outcomes/{outcome_id}/dispute","href":"/api-reference/computer-use/outcomes-by-dispute-create"},{"title":"List disputes for an outcome","api":"GET https://api.computer.stateset.app/api/v1/outcomes/{outcome_id}/disputes","href":"/api-reference/computer-use/outcomes-by-disputes-get"},{"title":"Get one tenant outcome","api":"GET https://api.computer.stateset.app/api/v1/outcomes/{outcome_id}","href":"/api-reference/computer-use/outcomes-by-get"},{"title":"List tenant outcomes","api":"GET https://api.computer.stateset.app/api/v1/outcomes","href":"/api-reference/computer-use/outcomes-list"},{"title":"Get tenant outcome statistics","api":"GET https://api.computer.stateset.app/api/v1/outcomes/stats","href":"/api-reference/computer-use/outcomes-stats-list"}]},{"group":"Usage","pages":[{"title":"Get Usage By Template V1","api":"GET https://api.computer.stateset.app/api/v1/usage/by-template","href":"/api-reference/computer-use/usage-by-template-list"},{"title":"Get Usage By Tool V1","api":"GET https://api.computer.stateset.app/api/v1/usage/by-tool","href":"/api-reference/computer-use/usage-by-tool-list"},{"title":"Get Usage V1","api":"GET https://api.computer.stateset.app/api/v1/usage","href":"/api-reference/computer-use/usage-list"},{"title":"Get Usage Trend V1","api":"GET https://api.computer.stateset.app/api/v1/usage/trend","href":"/api-reference/computer-use/usage-trend-list"}]},{"group":"Quota","pages":[{"title":"Get Quota V1","api":"GET https://api.computer.stateset.app/api/v1/quota","href":"/api-reference/computer-use/quota-list"}]},{"group":"Billing","pages":[{"title":"Get Billing Projection V1","api":"GET https://api.computer.stateset.app/api/v1/billing/projection","href":"/api-reference/computer-use/billing-projection-list"}]},{"group":"Webhooks","pages":[{"title":"Test Webhook V1","api":"POST https://api.computer.stateset.app/api/v1/webhook-test","href":"/api-reference/computer-use/webhook-test-create"},{"title":"Delete Webhook Endpoint V1","api":"DELETE https://api.computer.stateset.app/api/v1/webhooks/{endpoint_id}","href":"/api-reference/computer-use/webhooks-by-delete"},{"title":"List Webhook Deliveries V1","api":"GET https://api.computer.stateset.app/api/v1/webhooks/{endpoint_id}/deliveries","href":"/api-reference/computer-use/webhooks-by-deliveries-get"},{"title":"Get Webhook Endpoint V1","api":"GET https://api.computer.stateset.app/api/v1/webhooks/{endpoint_id}","href":"/api-reference/computer-use/webhooks-by-get"},{"title":"Mint a new signing secret in place; preserves delivery history.","api":"POST https://api.computer.stateset.app/api/v1/webhooks/{endpoint_id}/rotate-secret","href":"/api-reference/computer-use/webhooks-by-rotate-secret-create"},{"title":"Update Webhook Endpoint V1","api":"PATCH https://api.computer.stateset.app/api/v1/webhooks/{endpoint_id}","href":"/api-reference/computer-use/webhooks-by-update"},{"title":"Create Webhook Endpoint V1","api":"POST https://api.computer.stateset.app/api/v1/webhooks","href":"/api-reference/computer-use/webhooks-create"},{"title":"Aggregate webhook delivery view across all tenant endpoints","api":"GET https://api.computer.stateset.app/api/v1/webhooks/deliveries/recent","href":"/api-reference/computer-use/webhooks-deliveries-recent-list"},{"title":"List Webhook Endpoints V1","api":"GET https://api.computer.stateset.app/api/v1/webhooks","href":"/api-reference/computer-use/webhooks-list"}]},{"group":"Keys","pages":[{"title":"Bulk Revoke Api Keys V1","api":"POST https://api.computer.stateset.app/api/v1/keys/bulk-revoke","href":"/api-reference/computer-use/keys-bulk-revoke-create"},{"title":"Delete Api Key V1","api":"DELETE https://api.computer.stateset.app/api/v1/keys/{key_id}","href":"/api-reference/computer-use/keys-by-delete"},{"title":"Get Api Key V1","api":"GET https://api.computer.stateset.app/api/v1/keys/{key_id}","href":"/api-reference/computer-use/keys-by-get"},{"title":"Rotate Api Key V1","api":"POST https://api.computer.stateset.app/api/v1/keys/{key_id}/rotate","href":"/api-reference/computer-use/keys-by-rotate-create"},{"title":"Update Api Key V1","api":"PATCH https://api.computer.stateset.app/api/v1/keys/{key_id}","href":"/api-reference/computer-use/keys-by-update"},{"title":"Create Api Key V1","api":"POST https://api.computer.stateset.app/api/v1/keys","href":"/api-reference/computer-use/keys-create"},{"title":"List Api Keys V1","api":"GET https://api.computer.stateset.app/api/v1/keys","href":"/api-reference/computer-use/keys-list"}]},{"group":"Auth","pages":[{"title":"Auth Whoami V1","api":"GET https://api.computer.stateset.app/api/v1/auth/whoami","href":"/api-reference/computer-use/auth-whoami-list"}]},{"group":"System","pages":[{"title":"Tenant-agnostic platform outcome benchmarks with BPO comparison","api":"GET https://api.computer.stateset.app/api/v1/system/benchmarks","href":"/api-reference/computer-use/system-benchmarks-list"},{"title":"Versioned list of v1 API changes","api":"GET https://api.computer.stateset.app/api/v1/system/changelog","href":"/api-reference/computer-use/system-changelog-list"},{"title":"System Health Detail V1","api":"GET https://api.computer.stateset.app/api/v1/system/health-detail","href":"/api-reference/computer-use/system-health-detail-list"},{"title":"Discoverable platform metadata (version, environment, supported models)","api":"GET https://api.computer.stateset.app/api/v1/system/info","href":"/api-reference/computer-use/system-info-list"},{"title":"Discoverable input/output caps as a single source of truth","api":"GET https://api.computer.stateset.app/api/v1/system/limits","href":"/api-reference/computer-use/system-limits-list"},{"title":"Discoverable catalog of webhook event types and payload fields","api":"GET https://api.computer.stateset.app/api/v1/system/webhook-events","href":"/api-reference/computer-use/system-webhook-events-list"}]},{"group":"Health","pages":[{"title":"V1 Health","api":"GET https://api.computer.stateset.app/api/v1/health","href":"/api-reference/computer-use/health-list"}]},{"group":"Events","pages":[{"title":"Tenant-wide SSE stream of every job's status events","api":"GET https://api.computer.stateset.app/api/v1/events/stream","href":"/api-reference/computer-use/events-stream-list"}]},{"group":"Tags","pages":[{"title":"List Job Tags V1","api":"GET https://api.computer.stateset.app/api/v1/tags","href":"/api-reference/computer-use/tags-list"}]}]},{"tab":"Agents","icon":"bot","groups":[{"group":"Overview","pages":[{"title":"Agents API","href":"/api-reference/agents/overview"},{"title":"Agents API history","href":"/api-reference/agents/history"}]},{"group":"Agents","pages":[{"title":"Delete a delete agent agents agent ID","api":"DELETE http://localhost:8000/agents/{agent_id}","href":"/api-reference/agents/agents/agents-by-delete"},{"title":"Get Agent Details","api":"GET http://localhost:8000/agents/{agent_id}","href":"/api-reference/agents/agents/agents-by-get"},{"title":"Create Agent","api":"POST http://localhost:8000/agents","href":"/api-reference/agents/agents/agents-create"},{"title":"List Agents","api":"GET http://localhost:8000/agents","href":"/api-reference/agents/agents/agents-list"}]},{"group":"Conversations","pages":[{"title":"Delete a delete conversation conversations conversation ID","api":"DELETE http://localhost:8000/conversations/{conversation_id}","href":"/api-reference/agents/conversations/conversations-by-delete"},{"title":"Get a get conversation conversations conversation ID","api":"GET http://localhost:8000/conversations/{conversation_id}","href":"/api-reference/agents/conversations/conversations-by-get"},{"title":"Chat with Agent","api":"POST http://localhost:8000/conversations","href":"/api-reference/agents/conversations/conversations-create"},{"title":"List Conversations","api":"GET http://localhost:8000/conversations","href":"/api-reference/agents/conversations/conversations-list"}]},{"group":"Training","pages":[{"title":"Cancel Training","api":"DELETE http://localhost:8000/training/{training_id}","href":"/api-reference/agents/training/training-by-delete"},{"title":"Get Training Status","api":"GET http://localhost:8000/training/{training_id}","href":"/api-reference/agents/training/training-by-get"},{"title":"Start Training","api":"POST http://localhost:8000/training","href":"/api-reference/agents/training/training-create"},{"title":"List Training Jobs","api":"GET http://localhost:8000/training","href":"/api-reference/agents/training/training-list"}]},{"group":"v1 API","pages":[{"title":"End Conversation (v1)","api":"DELETE http://localhost:8000/api/v1/conversations/{conversation_id}","href":"/api-reference/agents/v1/conversations-by-delete"},{"title":"Get Conversation (v1)","api":"GET http://localhost:8000/api/v1/conversations/{conversation_id}","href":"/api-reference/agents/v1/conversations-by-get"},{"title":"Chat (v1)","api":"POST http://localhost:8000/api/v1/conversations","href":"/api-reference/agents/v1/conversations-create"},{"title":"Health Check (v1)","api":"GET http://localhost:8000/api/v1/health","href":"/api-reference/agents/v1/health-list"},{"title":"Cancel Training (v1)","api":"DELETE http://localhost:8000/api/v1/training/{job_id}","href":"/api-reference/agents/v1/training-by-delete"},{"title":"Get Training Status (v1)","api":"GET http://localhost:8000/api/v1/training/{job_id}","href":"/api-reference/agents/v1/training-by-get"},{"title":"Start Training (v1)","api":"POST http://localhost:8000/api/v1/training","href":"/api-reference/agents/v1/training-create"}]},{"group":"Messages","pages":[{"title":"Create Message","api":"POST http://localhost:8000/v1/messages","href":"/api-reference/agents/messages/v1-messages-create"}]},{"group":"Chat completions","pages":[{"title":"Chat Completions (OpenAI Compatible)","api":"POST http://localhost:8000/v1/chat/completions","href":"/api-reference/agents/openai/v1-chat-completions-create"},{"title":"Models (OpenAI Compatible)","api":"GET http://localhost:8000/v1/models","href":"/api-reference/agents/openai/v1-models-list"}]},{"group":"Observability","pages":[{"title":"Health Check","api":"GET http://localhost:8000/health","href":"/api-reference/agents/observability/health-list"},{"title":"Kubernetes Health Probe","api":"GET http://localhost:8000/healthz","href":"/api-reference/agents/observability/healthz-list"},{"title":"Cache Metrics","api":"GET http://localhost:8000/metrics/cache","href":"/api-reference/agents/observability/metrics-cache-list"},{"title":"Get get metrics metrics jsons","api":"GET http://localhost:8000/metrics/json","href":"/api-reference/agents/observability/metrics-json-list"},{"title":"Prometheus Metrics","api":"GET http://localhost:8000/metrics","href":"/api-reference/agents/observability/metrics-list"},{"title":"Security Metrics","api":"GET http://localhost:8000/metrics/security","href":"/api-reference/agents/observability/metrics-security-list"}]},{"group":"Health","pages":[{"title":"Liveness Check","api":"GET http://localhost:8000/live","href":"/api-reference/agents/health/live-list"},{"title":"Readiness Check","api":"GET http://localhost:8000/ready","href":"/api-reference/agents/health/ready-list"},{"title":"API Root","api":"GET http://localhost:8000/","href":"/api-reference/agents/health/root-list"}]},{"group":"Metrics","pages":[{"title":"Circuit Breaker Status","api":"GET http://localhost:8000/circuits","href":"/api-reference/agents/metrics/circuits-list"}]},{"group":"Documentation","pages":[{"title":"API Changelog","api":"GET http://localhost:8000/api/docs/changelog","href":"/api-reference/agents/documentation/api-docs-changelog-list"},{"title":"Error Codes Reference","api":"GET http://localhost:8000/api/docs/errors","href":"/api-reference/agents/documentation/api-docs-errors-list"},{"title":"Rate Limits","api":"GET http://localhost:8000/api/docs/rate-limits","href":"/api-reference/agents/documentation/api-docs-rate-limits-list"}]}]}]},{"dropdown":"For AI Agents","icon":"bot","description":"MCP servers and skills for agents using StateSet","tabs":[{"tab":"MCP Servers","icon":"plug","groups":[{"group":"Start here","pages":[{"sidebarTitle":"Signup to first value","title":"From Signup to First Value","icon":"rocket","href":"/guides/platform-onboarding"},{"sidebarTitle":"Rust engines \u0026 MCP","title":"Build Operations with Rust Engines \u0026 MCP","icon":"cpu","href":"/guides/rust-engines-and-mcp"},{"sidebarTitle":"Connect through MCP","title":"Manage Agents \u0026 Workflows with MCP","icon":"plug","href":"/guides/manage-platform-with-mcp"},{"sidebarTitle":"Configuration changes","title":"Your First Workflow Configuration Change","icon":"git-pull-request","href":"/guides/first-workflow-config-change"},{"sidebarTitle":"Durable agents","title":"Operate Your First Durable Agent","icon":"bot","href":"/guides/first-durable-agent"},{"sidebarTitle":"Agent evaluations","title":"Your First Agent Evaluation","icon":"check-check","href":"/guides/first-agent-evaluation"},{"sidebarTitle":"Your first week","title":"Your First Week with StateSet","icon":"chart-line","href":"/guides/first-week-with-stateset"},{"sidebarTitle":"Troubleshooting","title":"Troubleshoot Your First Operation","icon":"life-ring","href":"/guides/onboarding-troubleshooting"},{"sidebarTitle":"Workflow trial","title":"Your First Workflow Trial","icon":"workflow","href":"/guides/first-workflow-trial"},{"sidebarTitle":"Agent quickstart","title":"Getting Started for AI Agents","icon":"robot","href":"/getting-started-for-ai-agents"},{"sidebarTitle":"First local operation","title":"Your First Operation","icon":"play","href":"/guides/first-operation"},{"sidebarTitle":"Connect your systems","title":"Connect Your Operation","icon":"plug","href":"/guides/connect-your-operation"},{"title":"MCP Servers","icon":"plug","href":"/mcp-servers"},{"title":"MCP Integration for AI Agents","icon":"plug","iconType":"solid","href":"/guides/mcp-integration-guide"}]},{"group":"Commerce","pages":[{"title":"iCommerce MCP Server","href":"/stateset-icommerce/stateset-icommerce-mcp"},{"title":"Sandbox MCP server","href":"/stateset-sandbox/stateset-sandbox-mcp"},{"title":"Sync Server MCP","href":"/stateset-sync-mcp"},{"title":"EDI MCP Server","href":"/stateset-edi/mcp-server"},{"title":"Warehouse REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-warehouse/api-and-mcp"},{"title":"Freight REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-freight/api-and-mcp"}]},{"group":"Customer experience","pages":[{"title":"Response MCP Servers","href":"/stateset-response/response-mcp"},{"title":"Voice MCP Server","href":"/stateset-voice/mcp-server"},{"title":"Mail MCP Server","href":"/stateset-mail/mcp-server"}]},{"group":"Decisions and automation","pages":[{"title":"NSR MCP Server","href":"/stateset-nsr-mcp"},{"title":"Workstream MCP","href":"/next-temporal/mcp-connector"},{"title":"Agents MCP server","href":"/stateset-agents/mcp-server"},{"title":"Computer Use MCP Servers","href":"/computer-use-mcp"},{"title":"Engines and Commerce MCP Servers","href":"/computer-use-engines-mcp"}]}]},{"tab":"Skills","icon":"graduation-cap","groups":[{"group":"Start here","pages":[{"title":"Skills","href":"/agent-skills"}]},{"group":"Skills","pages":[{"title":"iCommerce Agent Operating Guide","href":"/stateset-icommerce-skill"},{"title":"NSR Skill","href":"/stateset-nsr-skill"},{"title":"Sandbox agent operating guide","href":"/stateset-sandbox-skill"},{"title":"Voice Skill","href":"/stateset-voice-skill"},{"title":"Computer Use Skill","href":"/computer-use-skill"},{"title":"Sync Server Skill","href":"/stateset-sync-server-skill"},{"title":"StateSet iCommerce Engine Skills","href":"/stateset-icommerce/stateset-icommerce-skills"}]}]}]}]},"basePath":"","title":"StateSet API Docs","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-_HcdDqS2.js","snippetPresets-CXnm-WO6.js","utils-Dg59J__o.js","style-to-object-BY3JEAdk.js","utils-D8TRpdk7.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-B6QaxWc5.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DeMZ-lcM.js","_Uint8Array-BjA2mcVW.js","isObject-FP1Yky1u.js","ApiExamples-cjPyMv63.js","usePlaygroundInputsStore-D7BWoaw4.js","shallow-Z1ceDNSG.js","isEqual-BObTuQrO.js","CodeSnippets-D1UZ1AE-.js","CodeSnippet-B373COAT.js","getApiPlaygroundDisplay-CfL-UuDS.js","Page-DuqezyvM.js","DynamicMarkdown-5yMTCLas.js","SectionHeading-BxT1HYfP.js","icon-DYJTTD3g.js","MethodPill-4AyycJeu.js","getPastedJson-Bp3WV6cN.js","Check2Icon-PhZu6Gry.js","axios-CsQoIw0U.js"]}