Filter orders by whether they have prescription products that are not (yet) associated with a prescription. The has_unmatched_prescriptions=true will return only orders with un-prescribed products.
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.
Example:
"2026-08-07T00:00:00"
{"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":"6ae78e5e3e428d6b587ea20b","collectionId":"72ba9fb3-413b-4a6a-9fbf-298466041bd6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae78e5e3e428d6b587ea20b"},"entitlements":{},"buildId":"6ae793cf748e6ef8daaf680b","clientVersion":"0.0.4044","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":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"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 b,#content-container .prose strong{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,.dark\\:bg-codeblock .group:hover .group-hover\\:bg-gray-700\\/60{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 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:.13em .36em;font-weight:400}.dark :not(pre)>code{background-color:rgba(223,236,236,.08);color:var(--blend-vapor, #DFECEC);border-color:rgba(223,236,236,.14)}#content-container .prose{font-size:15.5px;line-height:1.65;color:var(--bd-fg, #22332F)}#content-container #page-title,#content-container .mdx-content>h2,#content-container .prose h1,#content-container .prose h2{font-family:\"SeasonMix\",\"IBM Plex Serif\",Georgia,serif;font-weight:400;font-size:2.05rem;line-height:1.18;letter-spacing:-.02em;margin-bottom:0;text-wrap:balance;color:var(--bd-fg-strong, #111A18)}#content-container .prose h1+p,#content-container header .mt-2,#content-container header .mt-2 p,#content-container>div>p.mt-2{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:.3rem}#content-container .mdx-content>h2,#content-container .prose h2{font-size:1.55rem;line-height:1.2;letter-spacing:-.015em;margin-top:2.1em;margin-bottom:.55em;padding-bottom:0;border-bottom:0}#content-container .mdx-content>h3,#content-container .prose h3{font-family:\"SeasonMix\",\"IBM Plex Serif\",Georgia,serif;font-weight:400;font-size:1.22rem;line-height:1.3;letter-spacing:-.01em;margin-top:1.7em;margin-bottom:.45em;color:var(--bd-fg-strong, #111A18)}#content-container .mdx-content>h4,#content-container .prose 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:.4em;color:var(--bd-fg-strong, #111A18)}#content-container .prose ol,#content-container .prose p,#content-container .prose span[data-as=p],#content-container .prose ul{max-width:68ch;text-wrap:pretty}#content-container .prose p{margin-bottom:.95em}#content-container .prose li{margin-top:.28em;margin-bottom:.28em}#content-container .prose ol,#content-container .prose ul{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}[role=button]:focus-visible,a:focus-visible,button:focus-visible,input:focus-visible{outline:2px solid rgba(253,177,38,.4);outline-offset:2px;border-radius:4px}[role=button],a,button{transition:color var(--bd-dur, 200ms) var(--bd-ease, cubic-bezier(0.2, 0, 0, 1)),background-color var(--bd-dur, 200ms) var(--bd-ease, cubic-bezier(0.2, 0, 0, 1)),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:700;color:var(--blend-vitality-deep, #29795B)}.update-container div.gap-2,.update-container div.gap-2 span{display:block}#content-container .prose .overflow-x-auto:has(>table),#content-container .prose :where(div):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 td,#content-container .prose table th{padding:.42rem .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:.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 td:nth-child(1),#content-container .licenses-table table th:nth-child(1){width:40%}#content-container .licenses-table table td:nth-child(2),#content-container .licenses-table table th:nth-child(2){width:16%}#content-container .licenses-table table td:nth-child(3),#content-container .licenses-table table td:nth-child(4),#content-container .licenses-table table th:nth-child(3),#content-container .licenses-table table th:nth-child(4){width:22%}#content-container .callout{border-radius:var(--bd-radius, 8px);padding:.85rem 1rem;gap:.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,#content-container .prose .not-prose li,#content-container .prose .not-prose ol,#content-container .prose .not-prose p,#content-container .prose .not-prose ul{margin:0;max-width:none}#content-container .callout p+p{margin-top:.55em}#content-container .callout>div:last-child{font-size:.9rem;line-height:1.6}#content-container .callout:has(.text-sky-200),#content-container .callout:has(.text-sky-900){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-200) svg,#content-container .callout:has(.text-sky-900) svg{color:var(--blend-vapor-100, #99C6C5)}#content-container .callout:has(.text-amber-900) .text-amber-900,#content-container .callout:has(.text-emerald-900) .text-emerald-900,#content-container .callout:has(.text-sky-900) .text-sky-900{color:var(--blend-carbon, #22332F)}#content-container .callout:has(.text-amber-200),#content-container .callout:has(.text-amber-900){border-color:var(--blend-citrate-100, #FEE0A8);border-left-color:var(--blend-citrate, #FDB126);background:rgba(253,177,38,.1)}#content-container .callout:has(.text-amber-200) svg,#content-container .callout:has(.text-amber-900) svg{color:var(--blend-citrate-400, #FD8B34)}#content-container .callout:has(.text-emerald-200),#content-container .callout:has(.text-emerald-900){border-color:var(--blend-vitality-tint, #97DFC3);border-left-color:var(--blend-vitality, #2FBE87);background:rgba(47,190,135,.09)}#content-container .callout:has(.text-emerald-200) svg,#content-container .callout:has(.text-emerald-900) svg{color:var(--blend-vitality-deep, #29795B)}.dark #content-container .callout{background:rgba(255,255,255,.03)}.dark #content-container .callout:has(.text-sky-200){background:rgba(223,236,236,.07)}.dark #content-container .callout:has(.text-amber-200){background:rgba(253,177,38,.1)}.dark #content-container .callout:has(.text-emerald-200){background:rgba(47,190,135,.1)}#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)),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:.925rem;line-height:1.38;font-weight:500;letter-spacing:-.005em}#content-container .card .mt-1{font-size:.8rem;line-height:1.5;margin-top:.2rem}#content-container .card .mt-1 code{font-size:.95em}#content-container .card-group,#content-container .not-prose.grid{row-gap:.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 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:has(a[href$=\"/guides\"]),#content-container .card[href$=\"/guides\"]{background:rgba(253,177,38,.1);border-color:var(--blend-citrate-100, #FEE0A8);border-left:3px solid var(--blend-citrate, #FDB126)}#content-container .card:has(a[href$=\"/guides\"]):hover,#content-container .card[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:has(a[href$=\"/guides\"]) svg,#content-container .card[href$=\"/guides\"] svg{color:var(--blend-citrate-400, #FD8B34);background-color:var(--blend-citrate-400, #FD8B34)}#content-container .card:has(a[href$=\"/guides\"]) h2,#content-container .card[href$=\"/guides\"] h2{font-size:1rem;font-weight:600}.dark #content-container .card:has(a[href$=\"/guides\"]),.dark #content-container .card[href$=\"/guides\"]{background:rgba(253,177,38,.1);border-color:rgba(253,177,38,.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-amber-50\\/50 .text-amber-900,#content-container .callout.bg-emerald-50\\/50 .text-emerald-900,#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,.1)}#content-container .callout.bg-amber-50\\/50 svg{color:var(--blend-citrate-400, #FD8B34)}#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,.09)}#content-container .callout.bg-emerald-50\\/50 svg{color:var(--blend-vitality-deep, #29795B)}.dark #content-container .callout.bg-sky-50\\/50{background:rgba(223,236,236,.07)}.dark #content-container .callout.bg-amber-50\\/50{background:rgba(253,177,38,.1)}.dark #content-container .callout.bg-emerald-50\\/50{background:rgba(47,190,135,.1)}.dark #content-container .callout .text-amber-200,.dark #content-container .callout .text-emerald-200,.dark #content-container .callout .text-sky-200{color:var(--blend-isotonic, #F2EFF0)}#content-container .card:has(a[href$=\"/guides\"]) div.absolute,#content-container .card[href$=\"/guides\"] div.absolute{display:none}#content-container .callout[data-callout-type=info],#content-container .callout[data-callout-type=note]{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,.1)}#content-container .callout[data-callout-type=check],#content-container .callout[data-callout-type=tip]{border-color:#97dfc3;border-left:3px solid #2fbe87;background:rgba(47,190,135,.09)}#content-container .callout[data-callout-type=info] [data-component-part=callout-icon] svg,#content-container .callout[data-callout-type=note] [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=check] [data-component-part=callout-icon] svg,#content-container .callout[data-callout-type=tip] [data-component-part=callout-icon] svg{color:#29795b}.dark #content-container .callout[data-callout-type=info],.dark #content-container .callout[data-callout-type=note]{background:rgba(223,236,236,.07);border-color:#2a3a36 #2a3a36 #2a3a36 #99c6c5}.dark #content-container .callout[data-callout-type=warning]{background:rgba(253,177,38,.1);border-color:rgba(253,177,38,.28);border-left-color:#fdb126}.dark #content-container .callout[data-callout-type=check],.dark #content-container .callout[data-callout-type=tip]{background:rgba(47,190,135,.1);border-color:rgba(47,190,135,.28);border-left-color:#2fbe87}.dark #content-container .callout[data-callout-type=info] [data-component-part=callout-icon] svg,.dark #content-container .callout[data-callout-type=note] [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=check] [data-component-part=callout-icon] svg,.dark #content-container .callout[data-callout-type=tip] [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 [data-component-part=code-block-root],#content-container pre.shiki{background-color:#1b2926!important}#content-container pre.shiki,#content-container pre.shiki span{color:var(--shiki-dark, #D4D4D4)!important}#content-container [data-component-part=card-content]{font-size:.8rem;line-height:1.5}#content-container button[data-testid=copy-code-button]{background-color:rgba(223,236,236,.1)!important;color:#dfecec!important}#content-container button[data-testid=copy-code-button]:hover{background-color:rgba(223,236,236,.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:has(a[href$=\"/guides\"]) h2,#content-container .card[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 .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:-.01em;color:var(--bd-fg-strong, #111A18);margin: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:.15em 0}#content-container .accreditation-card__seals{display:flex;align-items:center;gap:.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/get-orders","slug":"/api-reference/orders/get-orders","pageMetadata":{"title":"Get orders","description":"Retrieve all orders. This endpoint returns paginated responses.\n\nDetails on pagination are returned in response headers.\n\n- `X-Total-Count`: total number of items available\n- `X-Page`: current page number\n- `X-Page-Size`: number of items per page\n- `X-Total-Pages`: total number of pages available\n- `X-Remaining-Count`: number of items remaining after the current page\n","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/orders","href":"/api-reference/orders/get-orders","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve all orders. This endpoint returns paginated responses.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Details on pagination are returned in response headers.\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"X-Total-Count\"\n }), \": total number of items available\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"X-Page\"\n }), \": current page number\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"X-Page-Size\"\n }), \": number of items per page\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"X-Total-Pages\"\n }), \": total number of pages available\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"X-Remaining-Count\"\n }), \": number of items remaining after the current page\"]\n }), \"\\n\"]\n })]\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":"Get orders","description":"Retrieve all orders. This endpoint returns paginated responses.\n\nDetails on pagination are returned in response headers.\n\n- `X-Total-Count`: total number of items available\n- `X-Page`: current page number\n- `X-Page-Size`: number of items per page\n- `X-Total-Pages`: total number of pages available\n- `X-Remaining-Count`: number of items remaining after the current page\n","deprecated":null,"version":null,"openapi":"/openapi-public.yml get /api/v1/orders","href":"/api-reference/orders/get-orders","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/blend/ac38e857016c236d/clicky.js"],"openApiReferenceData":{"operation":{"summary":"Get orders","description":"Retrieve all orders. This endpoint returns paginated responses.\n\nDetails on pagination are returned in response headers.\n\n- `X-Total-Count`: total number of items available\n- `X-Page`: current page number\n- `X-Page-Size`: number of items per page\n- `X-Total-Pages`: total number of pages available\n- `X-Remaining-Count`: number of items remaining after the current page\n","tags":["Orders"],"parameters":["abd3f840-d040-4239-889e-f94f735d9f69","2926d6fc-da6b-4e14-9d72-aa4d85236586","67e1160b-7e4c-4867-994d-7c2c027eda8b","5e902b45-fcce-4a77-885d-24f4246e7c4e"],"responses":{"200":"8cce1be1-685f-42db-8848-b538f557dfbb"},"method":"get","type":"path","servers":["059d5c53-9b23-47db-8cc0-2422197f6fca"],"security":["e7ecb83e-2a71-4c06-90f8-68e41734937b"],"path":"/api/v1/orders","baseUrlOptions":["https://api.byblend.com"],"title":"Get orders","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"abd3f840-d040-4239-889e-f94f735d9f69":{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer","example":1,"isRequired":false,"description":"Page number for pagination","uniqueKey":"","typeLabel":"integer"}},"2926d6fc-da6b-4e14-9d72-aa4d85236586":{"name":"page_size","in":"query","required":false,"description":"Number of items per page; defaults to 25, max of 200","schema":{"type":"integer","example":25,"isRequired":false,"description":"Number of items per page; defaults to 25, max of 200","uniqueKey":"","typeLabel":"integer"}},"67e1160b-7e4c-4867-994d-7c2c027eda8b":{"name":"has_unmatched_prescriptions","in":"query","required":false,"description":"Filter orders by whether they have prescription products that are not (yet) associated with a prescription. The `has_unmatched_prescriptions=true` will return only orders with un-prescribed products.","schema":{"type":"boolean","example":true,"isRequired":false,"description":"Filter orders by whether they have prescription products that are not (yet) associated with a prescription. The `has_unmatched_prescriptions=true` will return only orders with un-prescribed products.","uniqueKey":"","typeLabel":"boolean"}},"5e902b45-fcce-4a77-885d-24f4246e7c4e":{"name":"status","in":"query","required":false,"description":"Filter orders by status; comma-separate multiple values to return orders of various statuses","schema":{"type":"string","example":"picked,verified","isRequired":false,"description":"Filter orders by status; comma-separate multiple values to return orders of various statuses","uniqueKey":"","typeLabel":"string"}}},"responses":{"8cce1be1-685f-42db-8848-b538f557dfbb":{"description":"Successful response with an array of orders. Details on pagination are returned in response headers.\n","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total number of items available.","example":121},"X-Page":{"schema":{"type":"integer"},"description":"Current page number.","example":2},"X-Page-Size":{"schema":{"type":"integer"},"description":"Number of items per page.","example":25},"X-Total-Pages":{"schema":{"type":"integer"},"description":"Total number of pages available based on the page size and total count.","example":5},"X-Remaining-Count":{"schema":{"type":"integer"},"description":"Number of items remaining after current page.","example":96}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier","example":"0227d1e5-ba9a-42b5-8fe2-38882aa65708","uniqueKey":"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":"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":"items.[INDEX].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":"items.[INDEX].address.id","typeLabel":"string\u003cuuid>"},"address_1":{"type":"string","example":"140 Lindgren Streets","uniqueKey":"items.[INDEX].address.address_1","typeLabel":"string"},"address_2":{"type":"string","example":"Apt 227","uniqueKey":"items.[INDEX].address.address_2","typeLabel":"string"},"city":{"type":"string","example":"North Consueloburgh","uniqueKey":"items.[INDEX].address.city","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state abbreviation","example":"CA","uniqueKey":"items.[INDEX].address.state","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code","example":"US","uniqueKey":"items.[INDEX].address.country","typeLabel":"string"},"type":{"type":"string","description":"Type of address, if applicable","example":"shipping","uniqueKey":"items.[INDEX].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":"items.[INDEX].address.zip_code","typeLabel":"string"}},"uniqueKey":"items.[INDEX].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":"items.[INDEX].custom_shipping.label_url","typeLabel":"string"},"tracking_number":{"type":"string","example":"TEST123456","description":"Tracking number from the custom shipping label","uniqueKey":"items.[INDEX].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":"items.[INDEX].custom_shipping.tracking_url","typeLabel":"string"},"carrier":{"type":"string","example":"UPS","description":"Carrier of the custom shipping label","uniqueKey":"items.[INDEX].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":"items.[INDEX].custom_shipping","typeLabel":"object"},"customer_id":{"type":"string","format":"uuid","example":"b658f16f-819c-4503-aede-bd555fc4ebfb","uniqueKey":"items.[INDEX].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":"items.[INDEX].external_id","typeLabel":"string"},"is_replacement":{"type":"boolean","example":false,"description":"Whether the order is a replacement order","uniqueKey":"items.[INDEX].is_replacement","typeLabel":"boolean"},"order_number":{"type":"string","example":"ORD250312003548IAU4","description":"Friendlier identifier for the order. Auto-generated.","uniqueKey":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].patient.updated_at","typeLabel":"string\u003cdate-time>"},"first_name":{"type":"string","example":"Willard","uniqueKey":"items.[INDEX].patient.first_name","typeLabel":"string"},"middle_name":{"type":"string","example":"Moises","uniqueKey":"items.[INDEX].patient.middle_name","typeLabel":"string"},"last_name":{"type":"string","example":"Donnelly","uniqueKey":"items.[INDEX].patient.last_name","typeLabel":"string"},"gender":{"type":"string","enum":["male","female"],"example":"male","description":"Gender of the patient","uniqueKey":"items.[INDEX].patient.gender","typeLabel":"enum\u003cstring>"},"email":{"type":"string","example":"Harmon43@gmail.com","uniqueKey":"items.[INDEX].patient.email","typeLabel":"string"},"phone":{"type":"string","description":"10-digit phone number without formatting, e.g. 6417383445","example":"6417383445","uniqueKey":"items.[INDEX].patient.phone","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","example":"1990-01-01","uniqueKey":"items.[INDEX].patient.date_of_birth","typeLabel":"string\u003cdate>"},"driver_license_number":{"type":"string","example":"B49188319","uniqueKey":"items.[INDEX].patient.driver_license_number","typeLabel":"string"},"driver_license_state":{"type":"string","example":"CA","uniqueKey":"items.[INDEX].patient.driver_license_state","typeLabel":"string"},"ssn":{"type":"string","example":"123456789","description":"Social Security number. Can be provided with or without hyphens.","uniqueKey":"items.[INDEX].patient.ssn","typeLabel":"string"},"primary_language":{"type":"string","description":"ISO 639-1 language code","example":"en","uniqueKey":"items.[INDEX].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":"items.[INDEX].patient.guardian_name","typeLabel":"string"},"guardian_phone":{"type":"string","example":"6417383445","uniqueKey":"items.[INDEX].patient.guardian_phone","typeLabel":"string"},"guardian_email":{"type":"string","example":"parent@example.com","uniqueKey":"items.[INDEX].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":"items.[INDEX].patient.guardian_relationship","typeLabel":"string"},"height_inches":{"type":"integer","example":72,"description":"Height of the patient in inches","uniqueKey":"items.[INDEX].patient.height_inches","typeLabel":"integer"},"weight_pounds":{"type":"integer","example":180,"description":"Weight of the patient in pounds","uniqueKey":"items.[INDEX].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":"items.[INDEX].patient.external_id","typeLabel":"string"},"is_smoker":{"type":"boolean","example":false,"description":"Whether the patient is a smoker","uniqueKey":"items.[INDEX].patient.is_smoker","typeLabel":"boolean"},"is_diabetic":{"type":"boolean","example":false,"description":"Whether the patient is diabetic","uniqueKey":"items.[INDEX].patient.is_diabetic","typeLabel":"boolean"},"is_pregnant":{"type":"boolean","example":false,"description":"Whether the patient is pregnant","uniqueKey":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].patient.address.address_1","typeLabel":"string"},"city":{"type":"string","example":"North Consueloburgh","isRequired":true,"uniqueKey":"items.[INDEX].patient.address.city","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state abbreviation","example":"CA","isRequired":true,"uniqueKey":"items.[INDEX].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":"items.[INDEX].patient.address.zip_code","typeLabel":"string"},"address_2":{"type":"string","example":"Apt 227","uniqueKey":"items.[INDEX].patient.address.address_2","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code, defaults to US","example":"US","uniqueKey":"items.[INDEX].patient.address.country","typeLabel":"string"}},"uniqueKey":"items.[INDEX].patient.address","typeLabel":"object"}},"uniqueKey":"items.[INDEX].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":"items.[INDEX].prescription_count","typeLabel":"integer"},"priority_requested":{"type":"boolean","example":false,"description":"Whether the order has a priority request","uniqueKey":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].replacement_order_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].replacement_requested","typeLabel":"boolean"},"replacement_request_status":{"type":"string","example":"pending","description":"Status of the replacement request","enum":["pending","fulfilled","declined","cancelled"],"uniqueKey":"items.[INDEX].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":"items.[INDEX].replacement_requested_at","typeLabel":"string"},"replacement_requested_reason":{"type":"string","example":"Product arrived damaged","description":"Reason for the replacement request","uniqueKey":"items.[INDEX].replacement_requested_reason","typeLabel":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"carrier":{"type":"string","example":"USPS","description":"Shipment carrier.","uniqueKey":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].shipments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"service_level":{"type":"string","example":"Ground Advantage","description":"Shipment service level.","uniqueKey":"items.[INDEX].shipments.items.[INDEX].service_level","typeLabel":"string"},"status":{"type":"string","example":"shipped","description":"Status of the shipment.","enum":["shipped","cancelled","delivered"],"uniqueKey":"items.[INDEX].shipments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tracking_number":{"type":"string","example":"9200190347375200467807","description":"Tracking number for the shipment.","uniqueKey":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].shipments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].shipments","typeLabel":"object[]"},"shipping":{"type":"object","properties":{"carrier":{"type":"string","example":"usps","description":"Desired shipment carrier.","uniqueKey":"items.[INDEX].shipping.carrier","typeLabel":"string"},"service_level":{"type":"string","example":"usps_ground_advantage","description":"Desired shipment service level.","uniqueKey":"items.[INDEX].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":"items.[INDEX].shipping.signature_confirmation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"items.[INDEX].shipping","typeLabel":"object"},"status":{"type":"string","example":"received","description":"Order status. One of `received`, `picked`, `verified`, `exception`, `paused`, `shipped`, `delivered`, `cancelled`, `returned`.","uniqueKey":"items.[INDEX].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":"items.[INDEX].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":"items.[INDEX].paused_until.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].paused_until","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"items.[INDEX]","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"}]}},"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":"Get orders - Blend Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-01T19:32:40.503Z","originalFileLocation":"api-reference/orders/get-orders.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=\"Retrieve all orders. This endpoint returns paginated responses. Details on pagination are returned in response headers. - X-Total-Count: total number of items available - X-Page: current page number - X-Page-Size: number of items per page - X-Total-Pages: total number of pages available - X-Remaining-Count: number of items remaining after the current page\">\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=\"Get orders - Blend Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve all orders. This endpoint returns paginated responses. Details on pagination are returned in response headers. - X-Total-Count: total number of items available - X-Page: current page number - X-Page-Size: number of items per page - X-Total-Pages: total number of pages available - X-Remaining-Count: number of items remaining after the current page\">\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/get-orders\">\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=Get+orders\u0026amp;description=Retrieve+all+orders.+This+endpoint+returns+paginated+responses.%0A%0ADetails+on+pagination+are+returned+in+response+headers.%0A%0A-+%60X-Total-Count%60%3A+total+number+of+ite\u0026amp;theme=a2dc0bad46ee3871485c3413\u0026amp;signature=d693584dd264cb7d4362ca780c2509fc5e9cbc4237f6e0834aa9fe6fe8141860\">\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=\"Get orders - Blend Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve all orders. This endpoint returns paginated responses. Details on pagination are returned in response headers. - X-Total-Count: total number of items available - X-Page: current page number - X-Page-Size: number of items per page - X-Total-Pages: total number of pages available - X-Remaining-Count: number of items remaining after the current page\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blend.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Get+orders\u0026amp;description=Retrieve+all+orders.+This+endpoint+returns+paginated+responses.%0A%0ADetails+on+pagination+are+returned+in+response+headers.%0A%0A-+%60X-Total-Count%60%3A+total+number+of+ite\u0026amp;theme=a2dc0bad46ee3871485c3413\u0026amp;signature=d693584dd264cb7d4362ca780c2509fc5e9cbc4237f6e0834aa9fe6fe8141860\">\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/get-orders\">\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/get-orders.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/get-orders#webpage\",\"url\":\"https://docs.byblend.com/api-reference/orders/get-orders\",\"name\":\"Get orders\",\"description\":\"Retrieve all orders. This endpoint returns paginated responses. Details on pagination are returned in response headers. - X-Total-Count: total number of items available - X-Page: current page number - X-Page-Size: number of items per page - X-Total-Pages: total number of pages available - X-Remaining-Count: number of items remaining after the current page\",\"dateModified\":\"2026-11-01T19:32:40.503Z\",\"isPartOf\":{\"@id\":\"https://docs.byblend.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byblend.com/api-reference/orders/get-orders#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byblend.com/api-reference/orders/get-orders#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Blend Documentation\",\"item\":\"https://docs.byblend.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get orders\",\"item\":\"https://docs.byblend.com/api-reference/orders/get-orders\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byblend.com/api-reference/orders/get-orders#apireference\",\"headline\":\"Get orders\",\"name\":\"Get orders\",\"description\":\"Retrieve all orders. This endpoint returns paginated responses. Details on pagination are returned in response headers. - X-Total-Count: total number of items available - X-Page: current page number - X-Page-Size: number of items per page - X-Total-Pages: total number of pages available - X-Remaining-Count: number of items remaining after the current page\",\"url\":\"https://docs.byblend.com/api-reference/orders/get-orders\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byblend.com/api-reference/orders/get-orders#webpage\"},\"dateModified\":\"2026-11-01T19:32:40.503Z\",\"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","description":"Deactivate a subscription by its unique ID. This endpoint is deprecated. Please use the specific endpoints instead for webhooks or email.","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","description":"Create a new order.\n\nIf a mergeable order exists for the provided patient, a new order request will be merged into the existing order, unless `force_new=true` is specified. Please see \u003ca href=\"/overview#order-merging\">Order Merging\u003c/a> for more details.\n","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","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","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":"Get orders - Blend Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}