Cancel an order. Only orders in received, paused, or exception status can be cancelled. For orders already in picked or verified status, use Request Cancellation.
Unique identifier for the order, either UUID, order number (e.g. ORD250312003548IAU4), or external ID (e.g. my-system-128318AA2) if you have provided one during order creation or update.
Whether the order has a replacement request. This field is deprecated and will be removed in a future version. Please use replacement_request_status instead.
When an order is paused, midnight UTC of the pause-until calendar day. The order automatically unpauses when this date is reached. null when the pause is indefinite or the order is not paused.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Blend Documentation","colors":{"primary":"#22332f","light":"#22332f","dark":"#f7f5f6"},"logo":{"light":"https://mintcdn.com/blend/pai5IRtvTxf2zF92/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=pai5IRtvTxf2zF92\u0026q=85\u0026s=0ba0319e3cf8417a78cf8f955b4f1264","dark":"https://mintcdn.com/blend/pai5IRtvTxf2zF92/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=pai5IRtvTxf2zF92\u0026q=85\u0026s=0ba0319e3cf8417a78cf8f955b4f1264"},"favicon":"https://mintcdn.com/blend/pai5IRtvTxf2zF92/favicon.svg?fit=max\u0026auto=format\u0026n=pai5IRtvTxf2zF92\u0026q=85\u0026s=08cc719a6941120fbeb657a0e08cf735","background":{"color":{"light":"#f7f5f6","dark":"#111a18"}},"navbar":{"links":[{"href":"https://status.byblend.com","label":"System Status"},{"href":"mailto:support@byblend.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.byblend.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/byblend"}},"fonts":{"heading":{"family":"SeasonMix","weight":400,"source":"https://app.byblend.com/fonts/SeasonMix-Regular.woff2","format":"woff2"},"body":{"family":"Aeonik","weight":400,"source":"https://app.byblend.com/fonts/aeonik-regular.woff2","format":"woff2"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"blend","hasAudioNarration":false,"actualSubdomain":"blend","customDomains":["docs.byblend.com"],"gitSource":{"type":"github","owner":"johndavi","repo":"blend-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae793cf748e6ef8daaf680b","collectionId":"1fd3e932-6063-4193-95e4-367e58af7dd2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae793cf748e6ef8daaf680b"},"entitlements":{},"buildId":"6ae793cf748e6ef8daaf680b","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"API Reference","count":88},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"Orders","count":29},{"language":"default","tag":"Prescribers","count":19},{"language":"default","tag":"Notifications","count":15},{"language":"default","tag":"Patients","count":13},{"language":"default","tag":"Prescriptions","count":7},{"language":"default","tag":"Products and Materials","count":7},{"language":"default","tag":"Getting started","count":6},{"language":"default","tag":"Search","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Aeonik\";src:url(\"https://app.byblend.com/fonts/aeonik-medium.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}@font-face{font-family:\"Aeonik\";src:url(\"https://app.byblend.com/fonts/aeonik-bold.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}@font-face{font-family:\"SeasonMix\";src:url(\"https://app.byblend.com/fonts/SeasonMix-Regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"SeasonMix\";src:url(\"https://app.byblend.com/fonts/SeasonMix-Medium.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}#content-container .prose strong,#content-container .prose b{font-weight:500}:root{--blend-carbon: #22332F;--blend-carbon-100: #5D6B68;--blend-carbon-200: #364542;--blend-carbon-400: #1B2926;--blend-carbon-500: #111A18;--blend-isotonic: #F2EFF0;--blend-isotonic-100: #D3D9DA;--blend-isotonic-200: #C0C7C7;--blend-isotonic-400: #F7F5F6;--blend-isotonic-500: #FBFAFB;--blend-vapor: #DFECEC;--blend-vapor-100: #99C6C5;--blend-vapor-200: #C8DDDD;--blend-citrate: #FDB126;--blend-citrate-100: #FEE0A8;--blend-citrate-400: #FD8B34;--blend-vitality: #2FBE87;--blend-vitality-tint: #97DFC3;--blend-vitality-deep: #29795B;--blend-serum: #C1C2DE;--blend-capsule: #F5DFCE;--bd-fg: var(--blend-carbon);--bd-fg-strong: var(--blend-carbon-500);--bd-fg-muted: var(--blend-carbon-100);--bd-surface: #FFFFFF;--bd-surface-2: var(--blend-isotonic-400);--bd-stroke: var(--blend-isotonic-100);--bd-stroke-faint: rgba(34, 51, 47, 0.08);--bd-accent: var(--blend-citrate);--bd-radius: 8px;--bd-shadow-card: 1px 1px 42px 0 rgba(34, 51, 47, 0.08);--bd-ease: cubic-bezier(0.2, 0, 0, 1);--bd-dur: 200ms}.dark{--bd-fg: var(--blend-isotonic);--bd-fg-strong: #FFFFFF;--bd-fg-muted: var(--blend-vapor-200);--bd-surface: var(--blend-carbon-400);--bd-surface-2: var(--blend-carbon-200);--bd-stroke: var(--blend-carbon-200);--bd-stroke-faint: rgba(223, 236, 236, 0.10);--bd-shadow-card: none}#navbar div div div.relative,.dark #navbar div div div.relative{background-color:var(--blend-carbon, #22332F)}#navbar nav li a.text-gray-600{color:var(--blend-isotonic, #F2EFF0)}#navbar nav li a.text-gray-600:hover{color:var(--blend-vitality-tint, #97DFC3)}#navbar nav li span.bg-primary-dark{background-color:var(--blend-vitality-tint, #97DFC3)}#navbar nav li a span.text-white,#navbar nav li a svg{color:var(--blend-carbon, #22332F)}.dark\\:text-primary-light:is(.dark *){color:var(--blend-vitality-tint, #97DFC3)}.dark\\:bg-codeblock .text-gray-400{color:var(--blend-isotonic, #F2EFF0)}.dark\\:bg-codeblock .text-primary-light{color:var(--blend-vitality-tint, #97DFC3)}.dark\\:bg-codeblock .group:hover .group-hover\\:bg-gray-700\\/60{background-color:var(--blend-vitality-tint, #97DFC3)}.dark\\:bg-codeblock button+div.absolute{background-color:var(--blend-vitality-tint, #97DFC3);color:var(--blend-carbon, #22332F)}:not(pre)>code{background-color:var(--blend-vapor, #DFECEC);color:var(--blend-carbon-400, #1B2926);border:1px solid var(--blend-vapor-200, #C8DDDD);border-radius:4px;padding:0.13em 0.36em;font-weight:400}.dark :not(pre)>code{background-color:rgba(223, 236, 236, 0.08);color:var(--blend-vapor, #DFECEC);border-color:rgba(223, 236, 236, 0.14)}#content-container .prose{font-size:15.5px;line-height:1.65;color:var(--bd-fg, #22332F)}#content-container .prose h1,#content-container #page-title{font-family:\"SeasonMix\", \"IBM Plex Serif\", Georgia, serif;font-weight:400;font-size:2.05rem;line-height:1.18;letter-spacing:-0.02em;margin-bottom:0;text-wrap:balance;color:var(--bd-fg-strong, #111A18)}#content-container .prose h1+p,#content-container>div>p.mt-2,#content-container header .mt-2,#content-container header .mt-2 p{font-family:\"Aeonik\", system-ui, sans-serif;font-size:1.02rem;font-weight:400;line-height:1.55;color:var(--bd-fg-muted, #5D6B68);margin-bottom:0;padding-bottom:0;border-bottom:0;text-wrap:pretty}#content-container header#header{padding-bottom:1.35rem;border-bottom:1px solid var(--bd-stroke-faint, rgba(34, 51, 47, 0.08))}#content-container header#header>.mt-2{margin-top:0.3rem}#content-container .prose h2,#content-container .mdx-content>h2{font-family:\"SeasonMix\", \"IBM Plex Serif\", Georgia, serif;font-weight:400;font-size:1.55rem;line-height:1.2;letter-spacing:-0.015em;margin-top:2.1em;margin-bottom:0.55em;padding-bottom:0;border-bottom:0;text-wrap:balance;color:var(--bd-fg-strong, #111A18)}#content-container .prose h3,#content-container .mdx-content>h3{font-family:\"SeasonMix\", \"IBM Plex Serif\", Georgia, serif;font-weight:400;font-size:1.22rem;line-height:1.3;letter-spacing:-0.01em;margin-top:1.7em;margin-bottom:0.45em;color:var(--bd-fg-strong, #111A18)}#content-container .prose h4,#content-container .mdx-content>h4{font-family:\"SeasonMix\", \"IBM Plex Serif\", Georgia, serif;font-weight:400;font-size:1.05rem;line-height:1.35;margin-top:1.5em;margin-bottom:0.4em;color:var(--bd-fg-strong, #111A18)}#content-container .prose p,#content-container .prose span[data-as=\"p\"],#content-container .prose ul,#content-container .prose ol{max-width:68ch;text-wrap:pretty}#content-container .prose p{margin-bottom:0.95em}#content-container .prose li{margin-top:0.28em;margin-bottom:0.28em}#content-container .prose ul,#content-container .prose ol{margin-bottom:1.1em}#content-container .prose :where(table,pre){max-width:100%}#content-container .prose pre{border-radius:var(--bd-radius, 8px);font-size:12.9px;line-height:1.62}#content-container .prose pre code{font-size:inherit;line-height:inherit}#content-container .prose a:not(.card):hover{text-decoration-thickness:2px}a:focus-visible,button:focus-visible,[role=\"button\"]:focus-visible,input:focus-visible{outline:2px solid rgba(253, 177, 38, 0.4);outline-offset:2px;border-radius:4px}a,button,[role=\"button\"]{transition:color var(--bd-dur, 200ms) var(--bd-ease, cubic-bezier(0.2, 0, 0, 1)),\n background-color var(--bd-dur, 200ms) var(--bd-ease, cubic-bezier(0.2, 0, 0, 1)),\n border-color var(--bd-dur, 200ms) var(--bd-ease, cubic-bezier(0.2, 0, 0, 1))}@media (prefers-reduced-motion: reduce){*{transition:none!important;animation:none!important}}footer .items-center div{display:none}.update-container .rounded-lg.cursor-pointer{font-family:'SeasonMix';font-weight:bold;color:var(--blend-vitality-deep, #29795B)}.update-container div.gap-2{display:block}.update-container div.gap-2 span{display:block}#content-container .prose :where(div):has(>table),#content-container .prose .overflow-x-auto:has(>table){width:100%;max-width:100%;min-width:0;overflow-x:hidden;box-sizing:border-box}#content-container .prose table{width:100%;max-width:100%;box-sizing:border-box;display:table;margin-top:1rem;border:1px solid var(--bd-stroke, #D3D9DA);border-radius:var(--bd-radius, 8px);border-collapse:separate;border-spacing:0;overflow:hidden;font-variant-numeric:tabular-nums}#content-container .prose table th,#content-container .prose table td{padding:0.42rem 0.7rem;text-align:left;overflow-wrap:break-word;word-break:break-word;border-bottom:1px solid var(--bd-stroke, #D3D9DA)}#content-container .prose table th{background:var(--bd-surface-2, #F7F5F6);font-weight:500;letter-spacing:0.02em}#content-container .prose table tr:last-child td{border-bottom:0}#content-container .prose table:has(th:nth-child(4)){table-layout:fixed}#content-container .licenses-table table th:nth-child(1),#content-container .licenses-table table td:nth-child(1){width:40%}#content-container .licenses-table table th:nth-child(2),#content-container .licenses-table table td:nth-child(2){width:16%}#content-container .licenses-table table th:nth-child(3),#content-container .licenses-table table td:nth-child(3){width:22%}#content-container .licenses-table table th:nth-child(4),#content-container .licenses-table table td:nth-child(4){width:22%}#content-container .callout{border-radius:var(--bd-radius, 8px);padding:0.85rem 1rem;gap:0.75rem;margin-top:1.25rem;margin-bottom:1.25rem;border:1px solid var(--bd-stroke, #D3D9DA);border-left:3px solid var(--bd-fg-muted, #5D6B68);background:var(--bd-surface-2, #F7F5F6)}#content-container .callout p{margin:0;max-width:none}#content-container .callout p+p{margin-top:0.55em}#content-container .callout>div:last-child{font-size:0.9rem;line-height:1.6}#content-container .callout:has(.text-sky-900),#content-container .callout:has(.text-sky-200){border-color:var(--blend-vapor-200, #C8DDDD);border-left-color:var(--blend-vapor-100, #99C6C5);background:var(--blend-vapor, #DFECEC)}#content-container .callout:has(.text-sky-900) svg,#content-container .callout:has(.text-sky-200) svg{color:var(--blend-vapor-100, #99C6C5)}#content-container .callout:has(.text-sky-900) .text-sky-900{color:var(--blend-carbon, #22332F)}#content-container .callout:has(.text-amber-900),#content-container .callout:has(.text-amber-200){border-color:var(--blend-citrate-100, #FEE0A8);border-left-color:var(--blend-citrate, #FDB126);background:rgba(253, 177, 38, 0.10)}#content-container .callout:has(.text-amber-900) svg,#content-container .callout:has(.text-amber-200) svg{color:var(--blend-citrate-400, #FD8B34)}#content-container .callout:has(.text-amber-900) .text-amber-900{color:var(--blend-carbon, #22332F)}#content-container .callout:has(.text-emerald-900),#content-container .callout:has(.text-emerald-200){border-color:var(--blend-vitality-tint, #97DFC3);border-left-color:var(--blend-vitality, #2FBE87);background:rgba(47, 190, 135, 0.09)}#content-container .callout:has(.text-emerald-900) svg,#content-container .callout:has(.text-emerald-200) svg{color:var(--blend-vitality-deep, #29795B)}#content-container .callout:has(.text-emerald-900) .text-emerald-900{color:var(--blend-carbon, #22332F)}.dark #content-container .callout{background:rgba(255,255,255,0.03)}.dark #content-container .callout:has(.text-sky-200){background:rgba(223,236,236,0.07)}.dark #content-container .callout:has(.text-amber-200){background:rgba(253,177,38,0.10)}.dark #content-container .callout:has(.text-emerald-200){background:rgba(47,190,135,0.10)}.dark #content-container .callout .text-sky-200,.dark #content-container .callout .text-amber-200,.dark #content-container .callout .text-emerald-200{color:var(--blend-isotonic, #F2EFF0)}#content-container .card,#content-container .card{border-radius:var(--bd-radius, 8px);border:1px solid var(--bd-stroke, #D3D9DA);box-shadow:none;transition:border-color var(--bd-dur, 200ms) var(--bd-ease, cubic-bezier(0.2, 0, 0, 1)),\n box-shadow var(--bd-dur, 200ms) var(--bd-ease, cubic-bezier(0.2, 0, 0, 1))}#content-container .card:hover{border-color:var(--blend-citrate, #FDB126);box-shadow:var(--bd-shadow-card, 1px 1px 42px 0 rgba(34, 51, 47, 0.08))}#content-container .card>div:first-child{padding:1.05rem 1.15rem}#content-container .card h2{font-family:\"Aeonik\", system-ui, sans-serif;font-size:0.925rem;line-height:1.38;font-weight:500;letter-spacing:-0.005em}#content-container .card-group .card h2{margin-top:1.25rem}#content-container .card .mt-1{font-size:0.8rem;line-height:1.5;margin-top:0.2rem}#content-container .card .mt-1 code{font-size:0.95em}#content-container .not-prose.grid,#content-container .card-group{row-gap:0.75rem}#content-container .w-7.h-7.rounded-lg{background:var(--blend-carbon, #22332F);color:var(--blend-isotonic, #F2EFF0);border-radius:999px;font-weight:500;font-variant-numeric:tabular-nums}.dark #content-container .w-7.h-7.rounded-lg{background:var(--blend-vapor, #DFECEC);color:var(--blend-carbon, #22332F)}#content-container .prose .not-prose p,#content-container .prose .not-prose ul,#content-container .prose .not-prose ol,#content-container .prose .not-prose li{margin:0;max-width:none}#content-container .prose .not-prose h1,#content-container .prose .not-prose h2,#content-container .prose .not-prose h3,#content-container .prose .not-prose h4,#content-container .prose h1.not-prose,#content-container .prose h2.not-prose,#content-container .prose h3.not-prose,#content-container .prose h4.not-prose{font-family:inherit;max-width:none;margin-top:0;margin-bottom:0;border-bottom:0;padding-bottom:0}#content-container button.not-prose{align-items:center;line-height:normal}#content-container button.not-prose>svg{flex:none}#content-container .card[href$=\"/guides\"],#content-container .card:has(a[href$=\"/guides\"]){background:rgba(253, 177, 38, 0.10);border-color:var(--blend-citrate-100, #FEE0A8);border-left:3px solid var(--blend-citrate, #FDB126)}#content-container .card[href$=\"/guides\"]:hover,#content-container .card:has(a[href$=\"/guides\"]):hover{border-color:var(--blend-citrate, #FDB126);border-left-color:var(--blend-citrate, #FDB126);box-shadow:var(--bd-shadow-card, 1px 1px 42px 0 rgba(34, 51, 47, 0.08))}#content-container .card[href$=\"/guides\"] svg,#content-container .card:has(a[href$=\"/guides\"]) svg{color:var(--blend-citrate-400, #FD8B34);background-color:var(--blend-citrate-400, #FD8B34)}#content-container .card[href$=\"/guides\"] h2,#content-container .card:has(a[href$=\"/guides\"]) h2{font-size:1rem;font-weight:600}.dark #content-container .card[href$=\"/guides\"],.dark #content-container .card:has(a[href$=\"/guides\"]){background:rgba(253, 177, 38, 0.10);border-color:rgba(253, 177, 38, 0.28);border-left-color:var(--blend-citrate, #FDB126)}#content-container .callout.bg-sky-50\\/50{border-color:var(--blend-vapor-200, #C8DDDD);border-left-color:var(--blend-vapor-100, #99C6C5);background:var(--blend-vapor, #DFECEC)}#content-container .callout.bg-sky-50\\/50 svg{color:var(--blend-vapor-100, #99C6C5)}#content-container .callout.bg-sky-50\\/50 .text-sky-900{color:var(--blend-carbon, #22332F)}#content-container .callout.bg-amber-50\\/50{border-color:var(--blend-citrate-100, #FEE0A8);border-left-color:var(--blend-citrate, #FDB126);background:rgba(253, 177, 38, 0.10)}#content-container .callout.bg-amber-50\\/50 svg{color:var(--blend-citrate-400, #FD8B34)}#content-container .callout.bg-amber-50\\/50 .text-amber-900{color:var(--blend-carbon, #22332F)}#content-container .callout.bg-emerald-50\\/50{border-color:var(--blend-vitality-tint, #97DFC3);border-left-color:var(--blend-vitality, #2FBE87);background:rgba(47, 190, 135, 0.09)}#content-container .callout.bg-emerald-50\\/50 svg{color:var(--blend-vitality-deep, #29795B)}#content-container .callout.bg-emerald-50\\/50 .text-emerald-900{color:var(--blend-carbon, #22332F)}.dark #content-container .callout.bg-sky-50\\/50{background:rgba(223,236,236,0.07)}.dark #content-container .callout.bg-amber-50\\/50{background:rgba(253,177,38,0.10)}.dark #content-container .callout.bg-emerald-50\\/50{background:rgba(47,190,135,0.10)}.dark #content-container .callout .text-sky-200,.dark #content-container .callout .text-amber-200,.dark #content-container .callout .text-emerald-200{color:var(--blend-isotonic, #F2EFF0)}#content-container .card[href$=\"/guides\"] div.absolute,#content-container .card:has(a[href$=\"/guides\"]) div.absolute{display:none}#content-container .callout[data-callout-type=\"note\"],#content-container .callout[data-callout-type=\"info\"]{border-color:#C8DDDD;border-left:3px solid #99C6C5;background:#DFECEC}#content-container .callout[data-callout-type=\"warning\"]{border-color:#FEE0A8;border-left:3px solid #FDB126;background:rgba(253, 177, 38, 0.10)}#content-container .callout[data-callout-type=\"tip\"],#content-container .callout[data-callout-type=\"check\"]{border-color:#97DFC3;border-left:3px solid #2FBE87;background:rgba(47, 190, 135, 0.09)}#content-container .callout[data-callout-type=\"note\"] [data-component-part=\"callout-icon\"] svg,#content-container .callout[data-callout-type=\"info\"] [data-component-part=\"callout-icon\"] svg{color:#5D6B68}#content-container .callout[data-callout-type=\"warning\"] [data-component-part=\"callout-icon\"] svg{color:#B8791F}#content-container .callout[data-callout-type=\"tip\"] [data-component-part=\"callout-icon\"] svg,#content-container .callout[data-callout-type=\"check\"] [data-component-part=\"callout-icon\"] svg{color:#29795B}.dark #content-container .callout[data-callout-type=\"note\"],.dark #content-container .callout[data-callout-type=\"info\"]{background:rgba(223, 236, 236, 0.07);border-color:#2A3A36;border-left-color:#99C6C5}.dark #content-container .callout[data-callout-type=\"warning\"]{background:rgba(253, 177, 38, 0.10);border-color:rgba(253, 177, 38, 0.28);border-left-color:#FDB126}.dark #content-container .callout[data-callout-type=\"tip\"],.dark #content-container .callout[data-callout-type=\"check\"]{background:rgba(47, 190, 135, 0.10);border-color:rgba(47, 190, 135, 0.28);border-left-color:#2FBE87}.dark #content-container .callout[data-callout-type=\"note\"] [data-component-part=\"callout-icon\"] svg,.dark #content-container .callout[data-callout-type=\"info\"] [data-component-part=\"callout-icon\"] svg{color:#99C6C5}.dark #content-container .callout[data-callout-type=\"warning\"] [data-component-part=\"callout-icon\"] svg{color:#FDB126}.dark #content-container .callout[data-callout-type=\"tip\"] [data-component-part=\"callout-icon\"] svg,.dark #content-container .callout[data-callout-type=\"check\"] [data-component-part=\"callout-icon\"] svg{color:#97DFC3}#content-container .callout [data-component-part=\"callout-content\"]{color:var(--bd-fg, #22332F)}.dark #content-container .callout [data-component-part=\"callout-content\"]{color:#F2EFF0}#content-container pre.shiki,#content-container [data-component-part=\"code-block-root\"]{background-color:#1B2926!important}#content-container pre.shiki,#content-container pre.shiki span{color:var(--shiki-dark, #D4D4D4)!important}#content-container .card-group [data-component-part=\"card-title\"]{margin-top:1.25rem}#content-container [data-component-part=\"card-content\"]{font-size:0.8rem;line-height:1.5}#content-container button[data-testid=\"copy-code-button\"]{background-color:rgba(223, 236, 236, 0.10)!important;color:#DFECEC!important}#content-container button[data-testid=\"copy-code-button\"]:hover{background-color:rgba(223, 236, 236, 0.18)!important}#content-container button[data-testid=\"copy-code-button\"] svg{color:#DFECEC}#content-container .code-block-fade-overlay{background:linear-gradient(to right, rgba(27, 41, 38, 0) 0%, #1B2926 60%)!important}.dark #content-container [data-component-part=\"card-icon\"] svg{background-color:#DFECEC!important}.dark #content-container [data-component-part=\"card-icon\"]{color:#DFECEC;fill:#DFECEC}#content-container .card-group .card h2,#content-container .card-group [data-component-part=\"card-title\"]{margin-top:1.25rem}#content-container .card[href$=\"/guides\"] h2,#content-container .card:has(a[href$=\"/guides\"]) h2{margin-top:0;border-bottom:0;padding-bottom:0}#content-container .mdx-content{margin-top:1.75rem;min-width:0;max-width:100%}#content-container .flex.flex-row-reverse>div:not(#content-side-layout){min-width:0}#content-container .accreditation-card{display:flex;align-items:center;justify-content:space-between;gap:1.5rem;max-width:100%;box-sizing:border-box;margin:1.75rem 0 0.5rem;padding:1.15rem 1.35rem;background:var(--bd-surface, #FFFFFF);border:1px solid var(--bd-stroke, #D3D9DA);border-radius:var(--bd-radius, 8px);box-shadow:var(--bd-shadow-card, 1px 1px 42px 0 rgba(34, 51, 47, 0.08))}#content-container .accreditation-card__copy{min-width:0}#content-container .accreditation-card__title{font-family:\"SeasonMix\", \"IBM Plex Serif\", Georgia, serif;font-weight:400;font-size:1.22rem;line-height:1.25;letter-spacing:-0.01em;color:var(--bd-fg-strong, #111A18);margin:0 0 0.5em;max-width:none;padding-bottom:0;border-bottom:0}#content-container .accreditation-card ul{margin:0;padding-left:1.15em;max-width:none}#content-container .accreditation-card li{margin:0.15em 0}#content-container .accreditation-card__seals{display:flex;align-items:center;gap:0.75rem;flex-shrink:0}#content-container .accreditation-card__seals img{display:block;width:73px;height:auto}@media (max-width: 640px){#content-container .accreditation-card{flex-direction:column;align-items:flex-start}}.dark #content-container .accreditation-card{background:var(--bd-surface, #1B2926);box-shadow:none}#content-container .mdx-content>:first-child,#content-container .prose>:first-child{margin-top:0}#content-container .mdx-content>h1:first-of-type,#content-container .mdx-content>h2:first-of-type,#content-container .mdx-content>h3:first-of-type{margin-top:1.1em}"}],"page":{"pagePath":"api-reference/orders/cancel-an-order","slug":"/api-reference/orders/cancel-an-order","pageMetadata":{"title":"Cancel an order","description":"Cancel an order. Only orders in `received`, `paused`, or `exception` status can be cancelled. For orders already in `picked` or `verified` status, use Request Cancellation.","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/cancel","href":"/api-reference/orders/cancel-an-order","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Cancel an order. Only orders in \", _jsx(_components.code, {\n children: \"received\"\n }), \", \", _jsx(_components.code, {\n children: \"paused\"\n }), \", or \", _jsx(_components.code, {\n children: \"exception\"\n }), \" status can be cancelled. For orders already in \", _jsx(_components.code, {\n children: \"picked\"\n }), \" or \", _jsx(_components.code, {\n children: \"verified\"\n }), \" status, use Request Cancellation.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel an order","description":"Cancel an order. Only orders in `received`, `paused`, or `exception` status can be cancelled. For orders already in `picked` or `verified` status, use Request Cancellation.","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/cancel","href":"/api-reference/orders/cancel-an-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/blend/ac38e857016c236d/clicky.js"],"openApiReferenceData":{"operation":{"summary":"Cancel an order","description":"Cancel an order. Only orders in `received`, `paused`, or `exception` status can be cancelled. For orders already in `picked` or `verified` status, use Request Cancellation.","tags":["Orders"],"parameters":["67039d1e-ed15-4613-8678-69ef060cba5e"],"responses":{"200":"de0b88d7-b473-450b-af9d-85d80bea2a21"},"method":"put","type":"path","servers":["059d5c53-9b23-47db-8cc0-2422197f6fca"],"security":["e7ecb83e-2a71-4c06-90f8-68e41734937b"],"path":"/api/v1/orders/{order_id}/cancel","baseUrlOptions":["https://api.byblend.com"],"title":"Cancel an order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"67039d1e-ed15-4613-8678-69ef060cba5e":{"name":"order_id","in":"path","required":true,"description":"Unique identifier for the order, either UUID, order number (e.g. ORD250312003548IAU4), or external ID (e.g. my-system-128318AA2) if you have provided one during order creation or update.","schema":{"type":"string","isRequired":true,"description":"Unique identifier for the order, either UUID, order number (e.g. ORD250312003548IAU4), or external ID (e.g. my-system-128318AA2) if you have provided one during order creation or update.","uniqueKey":"","typeLabel":"string"}}},"responses":{"de0b88d7-b473-450b-af9d-85d80bea2a21":{"description":"Successful response with order details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Date and time of creation","example":"2025-03-15T12:00:00Z","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date and time of last update","example":"2025-03-15T12:00:00Z","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"address":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","uniqueKey":"address.id","typeLabel":"string\u003cuuid>"},"address_1":{"type":"string","example":"140 Lindgren Streets","uniqueKey":"address.address_1","typeLabel":"string"},"address_2":{"type":"string","example":"Apt 227","uniqueKey":"address.address_2","typeLabel":"string"},"city":{"type":"string","example":"North Consueloburgh","uniqueKey":"address.city","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state abbreviation","example":"CA","uniqueKey":"address.state","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code","example":"US","uniqueKey":"address.country","typeLabel":"string"},"type":{"type":"string","description":"Type of address, if applicable","example":"shipping","uniqueKey":"address.type","typeLabel":"string"},"zip_code":{"type":"string","description":"5-digit ZIP code or ZIP+4 code, e.g. 02108 or 02108-1234","example":"02108","uniqueKey":"address.zip_code","typeLabel":"string"}},"uniqueKey":"address","typeLabel":"object"},"custom_shipping":{"type":"object","properties":{"label_url":{"type":"string","example":"https://example.com/label.pdf","description":"URL of the printable (4x6) custom shipping label","uniqueKey":"custom_shipping.label_url","typeLabel":"string"},"tracking_number":{"type":"string","example":"TEST123456","description":"Tracking number from the custom shipping label","uniqueKey":"custom_shipping.tracking_number","typeLabel":"string"},"tracking_url":{"type":"string","example":"https://example.com/track/TEST123456","description":"Tracking URL of the custom shipping label","uniqueKey":"custom_shipping.tracking_url","typeLabel":"string"},"carrier":{"type":"string","example":"UPS","description":"Carrier of the custom shipping label","uniqueKey":"custom_shipping.carrier","typeLabel":"string"}},"description":"Custom shipping details for the order if your account has custom shipping enabled, and you have provided prepaid label details.","uniqueKey":"custom_shipping","typeLabel":"object"},"customer_id":{"type":"string","format":"uuid","example":"b658f16f-819c-4503-aede-bd555fc4ebfb","uniqueKey":"customer_id","typeLabel":"string\u003cuuid>"},"external_id":{"type":"string","example":"my-system-128318AA2","description":"External (your own system's) ID associated with the order.","uniqueKey":"external_id","typeLabel":"string"},"is_replacement":{"type":"boolean","example":false,"description":"Whether the order is a replacement order","uniqueKey":"is_replacement","typeLabel":"boolean"},"order_number":{"type":"string","example":"ORD250312003548IAU4","description":"Friendlier identifier for the order. Auto-generated.","uniqueKey":"order_number","typeLabel":"string"},"original_order_id":{"type":"string","format":"uuid","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","description":"ID of the original order, if this is a replacement order","uniqueKey":"original_order_id","typeLabel":"string\u003cuuid>"},"patient":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","uniqueKey":"patient.id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Date and time of creation","example":"2025-03-15T12:00:00Z","uniqueKey":"patient.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date and time of last update","example":"2025-03-15T12:00:00Z","uniqueKey":"patient.updated_at","typeLabel":"string\u003cdate-time>"},"first_name":{"type":"string","example":"Willard","uniqueKey":"patient.first_name","typeLabel":"string"},"middle_name":{"type":"string","example":"Moises","uniqueKey":"patient.middle_name","typeLabel":"string"},"last_name":{"type":"string","example":"Donnelly","uniqueKey":"patient.last_name","typeLabel":"string"},"gender":{"type":"string","enum":["male","female"],"example":"male","description":"Gender of the patient","uniqueKey":"patient.gender","typeLabel":"enum\u003cstring>"},"email":{"type":"string","example":"Harmon43@gmail.com","uniqueKey":"patient.email","typeLabel":"string"},"phone":{"type":"string","description":"10-digit phone number without formatting, e.g. 6417383445","example":"6417383445","uniqueKey":"patient.phone","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","example":"1990-01-01","uniqueKey":"patient.date_of_birth","typeLabel":"string\u003cdate>"},"driver_license_number":{"type":"string","example":"B49188319","uniqueKey":"patient.driver_license_number","typeLabel":"string"},"driver_license_state":{"type":"string","example":"CA","uniqueKey":"patient.driver_license_state","typeLabel":"string"},"ssn":{"type":"string","example":"123456789","description":"Social Security number. Can be provided with or without hyphens.","uniqueKey":"patient.ssn","typeLabel":"string"},"primary_language":{"type":"string","description":"ISO 639-1 language code","example":"en","uniqueKey":"patient.primary_language","typeLabel":"string"},"guardian_name":{"type":"string","description":"Name of the patient's guardian. Required if patient is a minor.","example":"John Guardian","uniqueKey":"patient.guardian_name","typeLabel":"string"},"guardian_phone":{"type":"string","example":"6417383445","uniqueKey":"patient.guardian_phone","typeLabel":"string"},"guardian_email":{"type":"string","example":"parent@example.com","uniqueKey":"patient.guardian_email","typeLabel":"string"},"guardian_relationship":{"type":"string","description":"Relationship of the guardian to the patient. See relationship types lookup for available values; most common are `parent` and `legal_guardian`; and `other` can be used.","example":"parent","uniqueKey":"patient.guardian_relationship","typeLabel":"string"},"height_inches":{"type":"integer","example":72,"description":"Height of the patient in inches","uniqueKey":"patient.height_inches","typeLabel":"integer"},"weight_pounds":{"type":"integer","example":180,"description":"Weight of the patient in pounds","uniqueKey":"patient.weight_pounds","typeLabel":"integer"},"external_id":{"type":"string","example":"1234567890","description":"External (your own) ID for the patient, to be used for prescription matching","uniqueKey":"patient.external_id","typeLabel":"string"},"is_smoker":{"type":"boolean","example":false,"description":"Whether the patient is a smoker","uniqueKey":"patient.is_smoker","typeLabel":"boolean"},"is_diabetic":{"type":"boolean","example":false,"description":"Whether the patient is diabetic","uniqueKey":"patient.is_diabetic","typeLabel":"boolean"},"is_pregnant":{"type":"boolean","example":false,"description":"Whether the patient is pregnant","uniqueKey":"patient.is_pregnant","typeLabel":"boolean"},"receive_sms":{"type":"boolean","example":true,"description":"Whether the patient should receive SMS notifications for shipments. This is only applicable if you have authorized Blend to send patient communications on your behalf.","uniqueKey":"patient.receive_sms","typeLabel":"boolean"},"receive_email":{"type":"boolean","example":true,"description":"Whether the patient should receive email notifications for shipments. This is only applicable if you have authorized Blend to send patient communications on your behalf.","uniqueKey":"patient.receive_email","typeLabel":"boolean"},"address":{"type":"object","required":["address_1","city","state","zip_code"],"properties":{"address_1":{"type":"string","example":"140 Lindgren Streets","isRequired":true,"uniqueKey":"patient.address.address_1","typeLabel":"string"},"city":{"type":"string","example":"North Consueloburgh","isRequired":true,"uniqueKey":"patient.address.city","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state abbreviation","example":"CA","isRequired":true,"uniqueKey":"patient.address.state","typeLabel":"string"},"zip_code":{"type":"string","description":"5-digit ZIP code or 9-digit ZIP+4 code, e.g. 02108 or 02108-1234.","example":"02108","isRequired":true,"uniqueKey":"patient.address.zip_code","typeLabel":"string"},"address_2":{"type":"string","example":"Apt 227","uniqueKey":"patient.address.address_2","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code, defaults to US","example":"US","uniqueKey":"patient.address.country","typeLabel":"string"}},"uniqueKey":"patient.address","typeLabel":"object"}},"uniqueKey":"patient","typeLabel":"object"},"prescription_count":{"type":"integer","example":1,"description":"Number of prescriptions associated with the order (expected to be the same as the number of prescription products in the products object)","uniqueKey":"prescription_count","typeLabel":"integer"},"priority_requested":{"type":"boolean","example":false,"description":"Whether the order has a priority request","uniqueKey":"priority_requested","typeLabel":"boolean"},"cancellation_requested":{"type":"boolean","example":false,"description":"Whether the customer has requested cancellation for an order in picked or verified status","uniqueKey":"cancellation_requested","typeLabel":"boolean"},"replacement_order_ids":{"type":"array","items":{"type":"string","format":"uuid","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","description":"IDs of any replacement orders, if they have been created from this order","uniqueKey":"replacement_order_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"replacement_order_ids","typeLabel":"string\u003cuuid>[]"},"replacement_reason":{"type":"string","example":"Product arrived damaged","description":"If this is a replacement order, reason for the replacement","uniqueKey":"replacement_reason","typeLabel":"string"},"replacement_requested":{"type":"boolean","example":false,"description":"Whether the order has a replacement request. This field is deprecated and will be removed in a future version. Please use replacement_request_status instead.","uniqueKey":"replacement_requested","typeLabel":"boolean"},"replacement_request_status":{"type":"string","example":"pending","description":"Status of the replacement request","enum":["pending","fulfilled","declined","cancelled"],"uniqueKey":"replacement_request_status","typeLabel":"enum\u003cstring>"},"replacement_requested_at":{"type":"string","example":"2025-01-01T00:00:00Z","description":"Date and time a replacement request was made","uniqueKey":"replacement_requested_at","typeLabel":"string"},"replacement_requested_reason":{"type":"string","example":"Product arrived damaged","description":"Reason for the replacement request","uniqueKey":"replacement_requested_reason","typeLabel":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"carrier":{"type":"string","example":"USPS","description":"Shipment carrier.","uniqueKey":"shipments.items.[INDEX].carrier","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2026-04-17T18:31:05.175498","description":"Date and time the package label was purchased and the item marked shipped.","uniqueKey":"shipments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"delivered_at":{"type":"string","format":"date-time","example":"2026-04-17T18:31:05.175498","description":"Date and time the shipment was delivered.","uniqueKey":"shipments.items.[INDEX].delivered_at","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","example":"0239CA06-9A71-4FFE-8A8D-5403540A19E7","description":"Blend internal shipment ID.","uniqueKey":"shipments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"service_level":{"type":"string","example":"Ground Advantage","description":"Shipment service level.","uniqueKey":"shipments.items.[INDEX].service_level","typeLabel":"string"},"status":{"type":"string","example":"shipped","description":"Status of the shipment.","enum":["shipped","cancelled","delivered"],"uniqueKey":"shipments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tracking_number":{"type":"string","example":"9200190347375200467807","description":"Tracking number for the shipment.","uniqueKey":"shipments.items.[INDEX].tracking_number","typeLabel":"string"},"tracking_url":{"type":"string","example":"https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200467807","description":"Tracking URL for the shipment.","uniqueKey":"shipments.items.[INDEX].tracking_url","typeLabel":"string"}},"description":"Once an order has been shipped, details on its shipment(s) will be provided in this array.","uniqueKey":"shipments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shipments","typeLabel":"object[]"},"shipping":{"type":"object","properties":{"carrier":{"type":"string","example":"usps","description":"Desired shipment carrier.","uniqueKey":"shipping.carrier","typeLabel":"string"},"service_level":{"type":"string","example":"usps_ground_advantage","description":"Desired shipment service level.","uniqueKey":"shipping.service_level","typeLabel":"string"},"signature_confirmation":{"type":"string","enum":["standard","adult"],"example":"standard","description":"Preferred carrier signature confirmation for the eventual label (`standard` = anyone may sign; `adult` = 21+). Omitted when unset.","uniqueKey":"shipping.signature_confirmation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"shipping","typeLabel":"object"},"status":{"type":"string","example":"received","description":"Order status. One of `received`, `picked`, `verified`, `exception`, `paused`, `shipped`, `delivered`, `cancelled`, `returned`.","uniqueKey":"status","typeLabel":"string"},"paused_until":{"oneOf":[{"type":"string","format":"date-time","example":"2026-08-07T00:00:00","description":"When an order is paused, midnight UTC of the pause-until calendar day. The order automatically unpauses when this date is reached. `null` when the pause is indefinite or the order is not paused.","uniqueKey":"paused_until.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2026-08-07T00:00:00","description":"When an order is paused, midnight UTC of the pause-until calendar day. The order automatically unpauses when this date is reached. `null` when the pause is indefinite or the order is not paused.","uniqueKey":"paused_until.oneOf.1","typeLabel":"null"}],"uniqueKey":"paused_until","typeLabel":"string\u003cdate-time> | null"},"products":{"type":"object","properties":{"prescription":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","uniqueKey":"products.prescription.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Date and time of creation","example":"2025-03-15T12:00:00Z","uniqueKey":"products.prescription.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date and time of last update","example":"2025-03-15T12:00:00Z","uniqueKey":"products.prescription.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","example":"1234567890","description":"Unique inventory identifier for the product","uniqueKey":"products.prescription.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","example":"Mupirocin","uniqueKey":"products.prescription.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","example":"A topical cream that is used to treat skin infections.","uniqueKey":"products.prescription.items.[INDEX].description","typeLabel":"string"},"product_code":{"type":"string","example":"SUPERSPRAY15","description":"Customer reference for the product for use in electronic prescriptions.","uniqueKey":"products.prescription.items.[INDEX].product_code","typeLabel":"string"},"form":{"type":"string","example":"cream","description":"Optional form of the product for customer use, if desired.","uniqueKey":"products.prescription.items.[INDEX].form","typeLabel":"string"},"is_active":{"type":"boolean","example":true,"description":"Whether the product is currently active for purchase or prescription","uniqueKey":"products.prescription.items.[INDEX].is_active","typeLabel":"boolean"},"label_orientation":{"type":"string","example":"portrait","description":"Orientation of the printed product label, either `portrait` or `landscape`.","uniqueKey":"products.prescription.items.[INDEX].label_orientation","typeLabel":"string"},"strength":{"type":"string","example":"1%","description":"Optional strength of the product for customer use, if desired.","uniqueKey":"products.prescription.items.[INDEX].strength","typeLabel":"string"},"has_prescription":{"type":"boolean","example":true,"description":"Whether the product is associated with a prescription.","uniqueKey":"products.prescription.items.[INDEX].has_prescription","typeLabel":"boolean"},"quantity":{"type":"integer","description":"Quantity of product in this specific order.","example":2,"uniqueKey":"products.prescription.items.[INDEX].quantity","typeLabel":"integer"},"reasons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-0000-0000-000000000201","uniqueKey":"products.prescription.items.[INDEX].reasons.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","example":"Palatability","uniqueKey":"products.prescription.items.[INDEX].reasons.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","example":"Commercial formulation has an unpleasant taste, texture, or odor.","uniqueKey":"products.prescription.items.[INDEX].reasons.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"products.prescription.items.[INDEX].reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.prescription.items.[INDEX].reasons","typeLabel":"object[]"},"fills":{"type":"array","description":"Dispensing events recorded against this line's prescription on this order. Present for every authorized viewer of the order read; empty until the line is picked. Carries the facts needed to run the pharmacy's own refill arithmetic (fills_remaining = refills + 1 − Σ deducted_fills over fills not excluded from the refill count).","items":{"type":"object","description":"One dispensing event against a prescription. Multi-lot picks share a fill_number and appear as multiple rows; they count once in refill arithmetic.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"prescription_id":{"type":"string","format":"uuid","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].prescription_id","typeLabel":"string\u003cuuid>"},"order_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].order_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].order_id","typeLabel":"string\u003cuuid> | null"},"fill_number":{"type":"integer","description":"0 is the initial fill; 1..n are refills.","example":0,"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].fill_number","typeLabel":"integer"},"deducted_fills":{"type":"integer","description":"How many fills this dispensing event consumed, as counted by the pharmacist at pick — a 90-day pick against a 30-day prescription deducts 3.","example":1,"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].deducted_fills","typeLabel":"integer"},"exclude_from_refill_count":{"type":"boolean","description":"True only for replacement shipments; excluded fills never consume a refill.","example":false,"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].exclude_from_refill_count","typeLabel":"boolean"},"dispensed_days_supply":{"oneOf":[{"type":"integer","example":30,"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_days_supply.oneOf.0","typeLabel":"integer"},{"type":"null","example":30,"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_days_supply.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_days_supply","typeLabel":"integer | null"},"dispensed_quantity":{"oneOf":[{"type":"number","example":30,"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_quantity.oneOf.0","typeLabel":"number"},{"type":"null","example":30,"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_quantity","typeLabel":"number | null"},"dispensed_unit_type":{"oneOf":[{"type":"string","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_unit_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_unit_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_unit_type","typeLabel":"string | null"},"dispensed_sig":{"oneOf":[{"type":"string","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_sig.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_sig.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].dispensed_sig","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"verified_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].verified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].verified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX].verified_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"products.prescription.items.[INDEX].fills.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.prescription.items.[INDEX].fills","typeLabel":"object[]"}},"uniqueKey":"products.prescription.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.prescription","typeLabel":"object[]"},"non_prescription":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","uniqueKey":"products.non_prescription.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Date and time of creation","example":"2025-03-15T12:00:00Z","uniqueKey":"products.non_prescription.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date and time of last update","example":"2025-03-15T12:00:00Z","uniqueKey":"products.non_prescription.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","example":"1234567890","description":"Unique inventory identifier for the product","uniqueKey":"products.non_prescription.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","example":"Krill Farms Fish Oil","uniqueKey":"products.non_prescription.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","example":"A fish oil supplement complementary to prescribed products.","uniqueKey":"products.non_prescription.items.[INDEX].description","typeLabel":"string"},"form":{"type":"string","example":"liquid","description":"Optional form of the product for customer use, if desired.","uniqueKey":"products.non_prescription.items.[INDEX].form","typeLabel":"string"},"is_active":{"type":"boolean","example":true,"description":"Whether the product is currently active for purchase","uniqueKey":"products.non_prescription.items.[INDEX].is_active","typeLabel":"boolean"},"quantity":{"type":"integer","description":"Quantity in this specific order.","example":1,"uniqueKey":"products.non_prescription.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"products.non_prescription.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.non_prescription","typeLabel":"object[]"},"order_material":{"type":"array","items":{"type":"object","description":"Materials or packing items that may be included in a shipment","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","uniqueKey":"products.order_material.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","description":"Date and time of creation","example":"2025-03-15T12:00:00Z","uniqueKey":"products.order_material.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Date and time of last update","example":"2025-03-15T12:00:00Z","uniqueKey":"products.order_material.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","example":"1234567890","description":"Unique inventory identifier for the product","uniqueKey":"products.order_material.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","example":"Referral Brochure","uniqueKey":"products.order_material.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","example":"Customer brochure included in every shipment.","uniqueKey":"products.order_material.items.[INDEX].description","typeLabel":"string"},"category":{"type":"string","example":"marketing","uniqueKey":"products.order_material.items.[INDEX].category","typeLabel":"string"},"current_stock":{"type":"integer","example":927,"uniqueKey":"products.order_material.items.[INDEX].current_stock","typeLabel":"integer"},"reorder_threshold":{"type":"integer","example":100,"uniqueKey":"products.order_material.items.[INDEX].reorder_threshold","typeLabel":"integer"},"has_inventory":{"type":"boolean","example":true,"description":"Whether the product has any inventory associated with it","uniqueKey":"products.order_material.items.[INDEX].has_inventory","typeLabel":"boolean"},"is_global":{"type":"boolean","example":false,"description":"Whether the material is customer-specific or Blend-wide (e.g. regulatory inserts)","uniqueKey":"products.order_material.items.[INDEX].is_global","typeLabel":"boolean"},"quantity":{"type":"integer","description":"Quantity of the material in this specific order.","example":1,"uniqueKey":"products.order_material.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"products.order_material.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products.order_material","typeLabel":"object[]"}},"uniqueKey":"products","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","created_at":"2025-03-15T12:00:00Z","updated_at":"2025-03-15T12:00:00Z","address":{"id":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","address_1":"140 Lindgren Streets","address_2":"Apt 227","city":"North Consueloburgh","state":"CA","country":"US","type":"shipping","zip_code":"02108"},"custom_shipping":{"label_url":"https://example.com/label.pdf","tracking_number":"TEST123456","tracking_url":"https://example.com/track/TEST123456","carrier":"UPS"},"customer_id":"b658f16f-819c-4503-aede-bd555fc4ebfb","external_id":"my-system-128318AA2","is_replacement":false,"order_number":"ORD250312003548IAU4","original_order_id":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","patient":{"id":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","created_at":"2025-03-15T12:00:00Z","updated_at":"2025-03-15T12:00:00Z","first_name":"Willard","middle_name":"Moises","last_name":"Donnelly","gender":"male","email":"Harmon43@gmail.com","phone":"6417383445","date_of_birth":"1990-01-01","driver_license_number":"B49188319","driver_license_state":"CA","ssn":"123456789","primary_language":"en","guardian_name":"John Guardian","guardian_phone":"6417383445","guardian_email":"parent@example.com","guardian_relationship":"parent","height_inches":72,"weight_pounds":180,"external_id":"1234567890","is_smoker":false,"is_diabetic":false,"is_pregnant":false,"receive_sms":true,"receive_email":true,"address":{"address_1":"140 Lindgren Streets","city":"North Consueloburgh","state":"CA","zip_code":"02108","address_2":"Apt 227","country":"US"}},"prescription_count":1,"priority_requested":false,"cancellation_requested":false,"replacement_order_ids":["0227d1e5-ba9a-42b5-8fe2-38882aa65708"],"replacement_reason":"Product arrived damaged","replacement_requested":false,"replacement_request_status":"pending","replacement_requested_at":"2025-01-01T00:00:00Z","replacement_requested_reason":"Product arrived damaged","shipments":[{"carrier":"USPS","created_at":"2026-04-17T18:31:05.175498","delivered_at":"2026-04-17T18:31:05.175498","id":"0239CA06-9A71-4FFE-8A8D-5403540A19E7","service_level":"Ground Advantage","status":"shipped","tracking_number":"9200190347375200467807","tracking_url":"https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200467807"}],"shipping":{"carrier":"usps","service_level":"usps_ground_advantage","signature_confirmation":"standard"},"status":"received","paused_until":"2026-08-07T00:00:00","products":{"prescription":[{"id":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","created_at":"2025-03-15T12:00:00Z","updated_at":"2025-03-15T12:00:00Z","sku":"1234567890","name":"Mupirocin","description":"A topical cream that is used to treat skin infections.","product_code":"SUPERSPRAY15","form":"cream","is_active":true,"label_orientation":"portrait","strength":"1%","has_prescription":true,"quantity":2,"reasons":[{"id":"00000000-0000-0000-0000-000000000201","name":"Palatability","description":"Commercial formulation has an unpleasant taste, texture, or odor."}],"fills":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","prescription_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","order_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","fill_number":0,"deducted_fills":1,"exclude_from_refill_count":false,"dispensed_days_supply":30,"dispensed_quantity":30,"dispensed_unit_type":"\u003cstring>","dispensed_sig":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","verified_at":"2023-11-07T05:31:56Z"}]}],"non_prescription":[{"id":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","created_at":"2025-03-15T12:00:00Z","updated_at":"2025-03-15T12:00:00Z","sku":"1234567890","name":"Krill Farms Fish Oil","description":"A fish oil supplement complementary to prescribed products.","form":"liquid","is_active":true,"quantity":1}],"order_material":[{"id":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","created_at":"2025-03-15T12:00:00Z","updated_at":"2025-03-15T12:00:00Z","sku":"1234567890","name":"Referral Brochure","description":"Customer brochure included in every shipment.","category":"marketing","current_stock":927,"reorder_threshold":100,"has_inventory":true,"is_global":false,"quantity":1}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e7ecb83e-2a71-4c06-90f8-68e41734937b":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"059d5c53-9b23-47db-8cc0-2422197f6fca":{"url":"https://api.byblend.com","description":"Blend production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi-public.yml"},"subdomain":"blend","siteName":"Blend Documentation","title":"Cancel an order - Blend Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-01T19:32:40.586Z","originalFileLocation":"api-reference/orders/cancel-an-order.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. Only orders in received, paused, or exception status can be cancelled. For orders already in picked or verified status, use Request Cancellation.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Blend Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blend/L6mpByy1agxrEHqC/_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/blend/L6mpByy1agxrEHqC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blend/L6mpByy1agxrEHqC/_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/blend/L6mpByy1agxrEHqC/_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/blend/L6mpByy1agxrEHqC/_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/blend/L6mpByy1agxrEHqC/_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/blend/L6mpByy1agxrEHqC/_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/blend/L6mpByy1agxrEHqC/_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/blend/L6mpByy1agxrEHqC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel an order - Blend Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancel an order. Only orders in received, paused, or exception status can be cancelled. For orders already in picked or verified status, use Request Cancellation.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Blend Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byblend.com/api-reference/orders/cancel-an-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://blend.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Cancel+an+order\u0026amp;description=Cancel+an+order.+Only+orders+in+%60received%60%2C+%60paused%60%2C+or+%60exception%60+status+can+be+cancelled.+For+orders+already+in+%60picked%60+or+%60verified%60+status%2C+use+Request+C\u0026amp;theme=a2dc0bad46ee3871485c3413\u0026amp;signature=f868a85278479c0c4b61162d15e9bd4f147a035b1024ae56759030ba4715a2bf\">\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=\"Cancel an order - Blend Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancel an order. Only orders in received, paused, or exception status can be cancelled. For orders already in picked or verified status, use Request Cancellation.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blend.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Cancel+an+order\u0026amp;description=Cancel+an+order.+Only+orders+in+%60received%60%2C+%60paused%60%2C+or+%60exception%60+status+can+be+cancelled.+For+orders+already+in+%60picked%60+or+%60verified%60+status%2C+use+Request+C\u0026amp;theme=a2dc0bad46ee3871485c3413\u0026amp;signature=f868a85278479c0c4b61162d15e9bd4f147a035b1024ae56759030ba4715a2bf\">\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/blend/L6mpByy1agxrEHqC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Blend Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#22332f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byblend.com/api-reference/orders/cancel-an-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/cancel-an-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.byblend.com/#organization\",\"name\":\"Blend Documentation\",\"url\":\"https://docs.byblend.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/blend/pai5IRtvTxf2zF92/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=pai5IRtvTxf2zF92\u0026q=85\u0026s=0ba0319e3cf8417a78cf8f955b4f1264\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.byblend.com#website\",\"name\":\"Blend Documentation\",\"url\":\"https://docs.byblend.com\",\"publisher\":{\"@id\":\"https://docs.byblend.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order#webpage\",\"url\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order\",\"name\":\"Cancel an order\",\"description\":\"Cancel an order. Only orders in received, paused, or exception status can be cancelled. For orders already in picked or verified status, use Request Cancellation.\",\"dateModified\":\"2026-11-01T19:32:40.586Z\",\"isPartOf\":{\"@id\":\"https://docs.byblend.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orders\",\"item\":\"https://docs.byblend.com/api-reference/orders/get-orders\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel an order\",\"item\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order#apireference\",\"headline\":\"Cancel an order\",\"name\":\"Cancel an order\",\"description\":\"Cancel an order. Only orders in received, paused, or exception status can be cancelled. For orders already in picked or verified status, use Request Cancellation.\",\"url\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byblend.com/api-reference/orders/cancel-an-order#webpage\"},\"dateModified\":\"2026-11-01T19:32:40.586Z\",\"publisher\":{\"@id\":\"https://docs.byblend.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.byblend.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Blend Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Blend Documentation","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Generate token","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/auth/login","href":"/api-reference/authentication/generate-token"},{"title":"Refresh access token","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/auth/refresh","href":"/api-reference/authentication/refresh-access-token"},{"title":"Verify access token","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/auth/verify","href":"/api-reference/authentication/verify-access-token"}]},{"group":"Composite Creation","pages":[{"title":"Single request creation of a prescription and order (and patient/prescriber)","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/prescriptions/electronic_prescriptions/composite","href":"/api-reference/composite-creation/single-request-creation-of-a-prescription-and-order-and-patientprescriber"}]},{"group":"Electronic Prescriptions","pages":[{"title":"Create a new electronic prescription","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/prescriptions/electronic_prescriptions","href":"/api-reference/electronic-prescriptions/create-a-new-electronic-prescription"},{"title":"Get electronic prescription","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescriptions/electronic_prescriptions/{electronic_prescription_id}","href":"/api-reference/electronic-prescriptions/get-electronic-prescription"},{"title":"Get quantity units","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescriptions/quantity_units","href":"/api-reference/electronic-prescriptions/get-quantity-units"}]},{"group":"Exceptions (Stuck Orders)","pages":[{"title":"Get an exception","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/exceptions/{exception_id}","href":"/api-reference/exceptions/get-an-exception"},{"title":"Get an entity's exceptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/exceptions/entity/{entity_type}/{entity_id}","href":"/api-reference/exceptions/get-an-entitys-exceptions"},{"title":"Respond to an exception","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/exceptions/{exception_id}/responses","href":"/api-reference/exceptions/respond-to-an-exception"}]},{"group":"Notifications","pages":[{"title":"Get notification event types","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/notifications/events","href":"/api-reference/notifications/get-notification-event-types"},{"title":"Generate a webhook secret","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/notifications/webhook-secret","href":"/api-reference/notifications/generate-a-webhook-secret"},{"title":"Get email subscriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/notifications/email","href":"/api-reference/notifications/get-email-subscriptions"},{"title":"Update email subscriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/notifications/email","href":"/api-reference/notifications/update-email-subscriptions"},{"title":"Deactivate email subscriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/notifications/email","href":"/api-reference/notifications/deactivate-email-subscriptions"},{"title":"Get webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/notifications/webhooks","href":"/api-reference/notifications/get-webhook-subscriptions"},{"title":"Create a new webhook subscription","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/notifications/webhooks","href":"/api-reference/notifications/create-a-new-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/notifications/webhooks/{webhook_id}","href":"/api-reference/notifications/get-a-webhook-subscription"},{"title":"Update webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/notifications/webhooks/{webhook_id}","href":"/api-reference/notifications/update-webhook-subscriptions"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/notifications/webhooks/{webhook_id}","href":"/api-reference/notifications/delete-a-webhook-subscription"},{"title":"Send a sample webhook","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/notifications/sample","href":"/api-reference/notifications/send-a-sample-webhook"},{"title":"Preview a sample webhook payload","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/notifications/sample/{event_code}","href":"/api-reference/notifications/preview-a-sample-webhook-payload"},{"title":"DEP: Get subscriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/notifications","href":"/api-reference/notifications/dep:-get-subscriptions"},{"title":"DEP: Create a new subscription","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/notifications","href":"/api-reference/notifications/dep:-create-a-new-subscription"},{"title":"DEP: Deactivate a subscription","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/notifications/{subscription_id}","href":"/api-reference/notifications/dep:-deactivate-a-subscription"}]},{"group":"Orders","pages":[{"title":"Get orders","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/orders","href":"/api-reference/orders/get-orders"},{"title":"Create an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/orders","href":"/api-reference/orders/create-an-order"},{"title":"Get an order's details","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/orders/{order_id}","href":"/api-reference/orders/get-an-orders-details"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/orders/{order_id}","href":"/api-reference/orders/update-an-order"},{"title":"Add products to an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/orders/{order_id}/products","href":"/api-reference/orders/add-products-to-an-order"},{"title":"Remove a product from an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/orders/{order_id}/products/{product_type}/{id}","href":"/api-reference/orders/remove-a-product-from-an-order"},{"title":"Update order item quantity","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/orders/{order_id}/products/{product_type}/{id}","href":"/api-reference/orders/update-order-item-quantity"},{"title":"Get shipping options","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/orders/shipping_options","href":"/api-reference/orders/get-shipping-options"},{"title":"Get order statuses","description":"Retrieve all available order status codes and names.","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/orders/statuses","href":"/api-reference/orders/get-order-statuses"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/cancel","href":"/api-reference/orders/cancel-an-order"},{"title":"Request cancellation of an order","description":"Request cancellation for an order already in process. This does not change order status. Only one request per order is allowed.","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/request_cancellation","href":"/api-reference/orders/request-cancellation-of-an-order"},{"title":"Pause an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/pause","href":"/api-reference/orders/pause-an-order"},{"title":"Pause an order until a date","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/pause/{date}","href":"/api-reference/orders/pause-an-order-until-a-date"},{"title":"Unpause an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/unpause","href":"/api-reference/orders/unpause-an-order"},{"title":"Prioritize an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/request_priority","href":"/api-reference/orders/prioritize-an-order"},{"title":"Replace an order","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/orders/{order_id}/request_replacement","href":"/api-reference/orders/replace-an-order"},{"title":"Get an order's status history","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/orders/{order_id}/status_history","href":"/api-reference/orders/get-an-orders-status-history"},{"title":"Get compounding reasons","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/reasons","href":"/api-reference/orders/get-compounding-reasons"},{"title":"Create a custom compounding reason","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/reasons","href":"/api-reference/orders/create-a-custom-compounding-reason"},{"title":"Update a custom compounding reason","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/reasons/{reason_id}","href":"/api-reference/orders/update-a-custom-compounding-reason"}]},{"group":"Patients","pages":[{"title":"Get patients","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/patients","href":"/api-reference/patients/get-patients"},{"title":"Create a patient","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/patients","href":"/api-reference/patients/create-a-patient"},{"title":"Get a patient's details","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/patients/{patient_id}","href":"/api-reference/patients/get-a-patients-details"},{"title":"Update a patient's details","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/patients/{patient_id}","href":"/api-reference/patients/update-a-patients-details"},{"title":"Get guardian relationship types","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/patients/guardian_relationship_types","href":"/api-reference/patients/get-guardian-relationship-types"},{"title":"Get a patient's orders","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/patients/{patient_id}/orders","href":"/api-reference/patients/get-a-patients-orders"},{"title":"Get a patient's prescriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/patients/{patient_id}/prescriptions","href":"/api-reference/patients/get-a-patients-prescriptions"},{"title":"Get a patient's risk factors","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/patients/{patient_id}/risk_factors","href":"/api-reference/patients/get-a-patients-risk-factors"},{"title":"Deactivate a risk factor","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/patients/{patient_id}/risk_factors/{risk_factor_id}","href":"/api-reference/patients/deactivate-a-risk-factor"},{"title":"Add freeform risk factor text","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/patients/{patient_id}/risk_factors/raw_text","href":"/api-reference/patients/add-freeform-risk-factor-text"}]},{"group":"Prescribers","pages":[{"title":"Get all available prescribers","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescribers","href":"/api-reference/prescribers/get-all-available-prescribers"},{"title":"Create a new prescriber","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/prescribers","href":"/api-reference/prescribers/create-a-new-prescriber"},{"title":"Get a prescriber's details","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescribers/{prescriber_id}","href":"/api-reference/prescribers/get-a-prescribers-details"},{"title":"Update a prescriber's details","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/prescribers/{prescriber_id}","href":"/api-reference/prescribers/update-a-prescribers-details"},{"title":"Get all available credentials","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescribers/credentials","href":"/api-reference/prescribers/get-all-available-credentials"},{"title":"Create a license/qualification","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/prescribers/{prescriber_id}/qualifications","href":"/api-reference/prescribers/create-a-licensequalification"},{"title":"Update a license/qualification","deprecated":null,"version":null,"openapi":"/openapi-public.yml put /api/v1/prescribers/{prescriber_id}/qualifications/{qualification_id}","href":"/api-reference/prescribers/update-a-licensequalification"},{"title":"Deactivate a license/qualification","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/prescribers/{prescriber_id}/qualifications/{qualification_id}","href":"/api-reference/prescribers/deactivate-a-licensequalification"},{"title":"List DEA registrations","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescribers/{prescriber_id}/dea-registrations","href":"/api-reference/prescribers/list-dea-registrations"},{"title":"Add a DEA registration","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/prescribers/{prescriber_id}/dea-registrations","href":"/api-reference/prescribers/add-a-dea-registration"},{"title":"Remove a DEA registration","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/prescribers/{prescriber_id}/dea-registrations/{registration_id}","href":"/api-reference/prescribers/remove-a-dea-registration"},{"title":"Update a DEA registration","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/prescribers/{prescriber_id}/dea-registrations/{registration_id}","href":"/api-reference/prescribers/update-a-dea-registration"},{"title":"Get a prescriber's supervisors","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescribers/{prescriber_id}/supervisors","href":"/api-reference/prescribers/get-a-prescribers-supervisors"},{"title":"Create a supervisorial relationship","deprecated":null,"version":null,"openapi":"/openapi-public.yml post /api/v1/prescribers/{prescriber_id}/supervisors","href":"/api-reference/prescribers/create-a-supervisorial-relationship"},{"title":"Remove a supervisorial relationship","deprecated":null,"version":null,"openapi":"/openapi-public.yml delete /api/v1/prescribers/{prescriber_id}/supervisors/{mapping_id}","href":"/api-reference/prescribers/remove-a-supervisorial-relationship"},{"title":"Get a prescriber's supervisees","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescribers/{prescriber_id}/supervisees","href":"/api-reference/prescribers/get-a-prescribers-supervisees"}]},{"group":"Prescriptions","pages":[{"title":"Get prescriptions","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescriptions","href":"/api-reference/prescriptions/get-prescriptions"},{"title":"Get a prescription","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/prescriptions/{prescription_id}","href":"/api-reference/prescriptions/get-a-prescription"}]},{"group":"Products and Materials","pages":[{"title":"Get products","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/products","href":"/api-reference/products-and-materials/get-products"},{"title":"Get prescription products","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/products/prescription","href":"/api-reference/products-and-materials/get-prescription-products"},{"title":"Get non-prescription products","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/products/non_prescription","href":"/api-reference/products-and-materials/get-non-prescription-products"},{"title":"Get order materials","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/products/order_material","href":"/api-reference/products-and-materials/get-order-materials"},{"title":"Update a prescription product","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/products/prescription/{product_id}","href":"/api-reference/products-and-materials/update-a-prescription-product"},{"title":"Update non-prescription product","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/products/non_prescription/{product_id}","href":"/api-reference/products-and-materials/update-non-prescription-product"},{"title":"Update order materials","deprecated":null,"version":null,"openapi":"/openapi-public.yml patch /api/v1/products/order_material/{product_id}","href":"/api-reference/products-and-materials/update-order-materials"}]},{"group":"Reports","pages":[{"title":"Daily report","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/reports/daily","href":"/api-reference/reports/daily-report"},{"title":"Orders report","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/reports/orders","href":"/api-reference/reports/orders-report"}]},{"group":"Search","pages":[{"title":"Search all","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/search","href":"/api-reference/search/search-all"},{"title":"Search orders","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/search/orders","href":"/api-reference/search/search-orders"},{"title":"Search patients","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/search/patients","href":"/api-reference/search/search-patients"},{"title":"Search prescribers","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/search/prescribers","href":"/api-reference/search/search-prescribers"},{"title":"Search products","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/search/products","href":"/api-reference/search/search-products"},{"title":"Search tasks","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/search/tasks","href":"/api-reference/search/search-tasks"}]}]}]},"basePath":"","title":"Cancel an order - Blend Documentation","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}