Read a clinic’s stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.
Most of this page is reading a clinic’s inventory. The last sections cover the ways your key can retire things: archiving an item, restoring it, deleting one that was never used, and writing off a lot of stock. Creating items and receiving, adjusting or transferring stock are in the API reference and in Retries and duplicates.Each endpoint needs a specific permission on the key making the request — see Permissions for what each one means before you build against it.
Locations
GET /v1/clinics/{clinic_id}/inventory/locations
Requires inventory.items:read. Returns the clinic’s stock locations — the storerooms, shelves or fridges stock is held in.
Free-text match against the item’s name. Matches are text matches, not confirmed equivalence — two items with similar names are not necessarily the same product.
category
Filter to one catalogue category.
status
active lists only items in use, archived lists only archived items, all lists both. Default all, so the list is the same as it has always been unless you ask. Anything else is refused with 400.
updated_since
RFC 3339 timestamp — only items changed since this time.
identifiers lists every code recorded for the item — a barcode (gtin) or a national drug registration number (nafdac) — and appears only where the clinic’s own record has it. Nothing is inferred or guessed on your behalf: an item with no barcode on file simply has no gtin entry.When you create an item, its upc (the barcode) must be a valid GTIN. When you update one, only a changedupc is checked: sending back the value the item already holds is accepted even if it is not a valid GTIN, so an item you read can be written back as it is. A new or different upc that is not a valid GTIN is refused with 400 invalid_gtin. To compare, the API reads the item’s current value with your key, so a key without inventory.items:read cannot send an unchanged invalid value, and that read counts toward your rate limit (if it is refused, for example when you are rate limited, you get that answer instead of invalid_gtin). The barcode filter when you list items is not checked: it matches exactly what is stored, so you can still find an item whose stored barcode is not a valid GTIN. null clears the barcode.is_active is false and archived_at holds the time while an item is archived; both go back to normal when it is restored.is_controlled is true when the clinic has marked the item as a controlled medicine. It is read-only: it can only be changed in the ClinikEHR app, by staff the clinic has allowed to mark medicines as controlled. A clinic that has not marked anything reports false for every item, so treat false as “not marked”, not as a statement about the medicine’s legal status.retail_price is null when the clinic hasn’t set a price for the item — never a fabricated 0.
Get one item
GET /v1/clinics/{clinic_id}/inventory/items/{item_id}
Requires inventory.items:read. Same fields as one entry of the list above. An item_id that doesn’t exist, or that belongs to a different clinic, returns 404 with code: "not_found" — see Errors.
Check availability
POST /v1/clinics/{clinic_id}/inventory/availability
Requires inventory.availability:read. Checks up to 100 items in one request — by their ID, or by any identifier you already hold (a barcode, for example) — and returns a band for each, never an exact number. A gtin value must be a valid barcode number: 8, 12, 13 or 14 digits, digits only, with a correct GS1 check digit. Anything else is refused with 400 invalid_gtin, and the answer names the field and the value.
Whether the identifier you sent resolved to a real item. false means it didn’t — not that the item is out of stock.
band
One of out, low, or in_stock. Computed by the clinic’s own thresholds, not something you can influence per request.
as_of
When this figure was last known to be true.
A positive band is not a reservation. Nothing about calling this endpoint holds, claims, or sets anything aside. Between reading in_stock and a customer actually being sold the item, stock can change — always show as_of to whoever is relying on the answer, and never present availability as a guarantee.
Exact stock levels
GET /v1/clinics/{clinic_id}/inventory/stock
Requires inventory.stock:read — a separate, more sensitive permission than availability (see Permissions). Returns exact quantities, by location and lot.
Query parameter
Meaning
location_id
Filter to one stock location.
item_id
Filter to one item.
expiring_before
RFC 3339 date — only lots expiring before this date.
quantity is a decimal string, the same convention used for money — see Pagination for the list envelope this sits inside.
Archive an item
POST /v1/clinics/{clinic_id}/inventory/items/{item_id}/archive
Requires inventory.items:write. Archiving hides an item from sale and dispensing without erasing anything — it is always reversible, and the item keeps its history. You can send an optional reason, which is kept with the item. No Idempotency-Key is needed, and archiving an item that is already archived simply succeeds.
The response is the item under data, now with is_active: false and an archived_at time.An item that still has stock on hand is refused with 409 and code: "item_has_stock"; the detail says how many units are left. Write the stock off (below) or move it first, then archive.
Restore an item
POST /v1/clinics/{clinic_id}/inventory/items/{item_id}/restore
Requires inventory.items:write. Brings an archived item back so it can be sold and dispensed again. Restoring an item that is already active simply succeeds. No body and no Idempotency-Key.
curl -X POST "https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/items/ITEM_ID/restore" \ -H "Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…"
The response is the item under data, with is_active: true and archived_at: null.
Requires inventory.items:write. Deleting is permanent, so it is only allowed for an item that has never been used: it has never held stock and is not part of any order, count, recipe or dispense. If you added an item by mistake, this removes it.
Anything with history is refused with 409 and code: "item_has_history" — archive it instead, which keeps the history. Sending the same delete a second time returns 404, because the item is gone.
Write off a lot of stock
POST /v1/clinics/{clinic_id}/inventory/lots/{lot_id}/write-off
Requires inventory.stock:write. Use this when a lot has expired, been damaged or been recalled. It records the lot’s remaining quantity as wasted, at every location where it is held, and then archives the lot. The clinic’s stock history keeps the movement; nothing is deleted.The request needs two things:
a reason in the body — say why the stock is being written off;
an Idempotency-Key header, so a retry after a timeout cannot write the same lot off twice. See Retries and duplicates.
curl -X POST "https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/lots/LOT_ID/write-off" \ -H "Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…" \ -H "Idempotency-Key: 7c9e6679-7425-40de-944b-e07fc1f90ae7" \ -H "Content-Type: application/json" \ -d '{ "reason": "Expired on the shelf" }'
{ "data": { "lot_id": "lot_01example", "item_id": "item_01example", "quantity_written_off": "42", "reason": "Expired on the shelf", "archived_at": "2026-10-05T10:15:00Z" }}
quantity_written_off is a decimal string, like every quantity.Leaving reason out is a 400 that names the field; a blank reason is refused with code: "reason_required". A controlled drug is refused with 403 and code: "controlled_drug_not_api_movable" — an API key has no witness to countersign, so the clinic records that loss itself. A lot with part of its stock reserved is refused with 409 and code: "insufficient_stock" until the reservation is released.
Send a stock report
POST /v1/clinics/{clinic_id}/inventory/external-stock/batchesGET /v1/clinics/{clinic_id}/inventory/external-stock/batches/{batch_id}
For a pharmacy that sells through another system. The pharmacy’s owner first switches Settings → API access → Stock source to “Another system’s stock report”; your system then sends that system’s stock as a report, and the pharmacy’s listings show it. Nothing is added to the pharmacy’s own ledger: a report only sets what listings say.Permission. The key needs inventory.external_stock:write, the narrow permission for exactly this. It is available on every paid pharmacy plan, including the Listing plan, and it cannot read, adjust or receive stock. A key that already holds inventory.stock:write (Team and above) works too, and GET also accepts inventory.stock:read. Clinic keys only: an organization never sends a pharmacy’s stock.
Body field
Notes
batch_id
Required. A UUID you generate. It is the idempotency key: sending the same one again returns the stored result and does nothing twice.
as_of
Required. When your system produced the report. We clamp it to the last 30 days.
feed_source
Required. A short label for the system sending it.
rows
Required. Up to 5,000 rows. Each has identifiers (at least one { "system", "value" }, the same systems as search) and at least one of quantity (a number, not negative) or band (in_stock, low, out). A gtin identifier must be a valid GTIN, or the whole report is refused with 400 invalid_gtin before anything is read or saved.
A row that matches none of the pharmacy’s products is counted as unmatched and ignored. Nothing is guessed.
A report is applied whole or not at all. One with an unreadable row (invalid_rows), far fewer products than the last accepted report (suspicious_shrink) or no rows (empty) is refused with 409 batch_rejected and nothing is saved.
A pharmacy that is not in “Another system’s stock report” mode is refused with 409 external_stock_mode_required.
A report older than the pharmacy’s freshness window makes its products read as unknown in listings. Send them regularly.
What’s never in an inventory response
No inventory endpoint returns cost price, vendor information, margins, or anything about a specific customer or sale. This release exposes only what a clinic explicitly permits under Availability, Catalogue, or Stock levels — nothing else rides along.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ClinikEHR API","description":"Reference and guides for the ClinikEHR API — read a clinic's own inventory from your own systems.","colors":{"primary":"#0D9488","light":"#2DD4BF","dark":"#0F766E"},"logo":{"light":"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/logo/light.svg?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=1c5da83101c773651a555abca64ef883","dark":"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/logo/dark.svg?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=6c05e14b5874038f79df529085e321f8","href":"https://clinikehr.com"},"favicon":"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/favicon.png?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=be1f63bf62da11aedb3dfd672a98f8d5","api":{"playground":{"display":"simple"},"examples":{"defaults":"all","languages":["curl","javascript","python"]}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://help.clinikehr.com","label":"Help Center"},{"href":"https://status.clinikehr.com","label":"Status"},{"href":"mailto:[email protected]","label":"Contact support"}],"primary":{"type":"button","label":"Open developer portal","href":"https://developer.clinikehr.com"}},"footer":{"socials":{"website":"https://clinikehr.com","x":"https://x.com/clinikehr","linkedin":"https://www.linkedin.com/company/clinikehr"},"links":[{"header":"Product","items":[{"label":"ClinikEHR","href":"https://clinikehr.com"},{"label":"Pricing","href":"https://clinikehr.com/pricing"}]},{"header":"Resources","items":[{"label":"Help Center","href":"https://help.clinikehr.com"},{"label":"Developer portal","href":"https://developer.clinikehr.com"},{"label":"Status","href":"https://status.clinikehr.com"}]},{"header":"Company","items":[{"label":"Contact support","href":"mailto:[email protected]"},{"label":"Privacy","href":"https://clinikehr.com/privacy"},{"label":"Terms","href":"https://clinikehr.com/terms"}]}]},"seo":{"metatags":{"og:site_name":"ClinikEHR API"},"indexing":"navigable"},"fonts":{"family":"Geist"},"styling":{"eyebrows":"section","codeblocks":"system","latex":false},"integrations":{"posthog":{"apiKey":"phc_817t39VWvmzFeNxvLBBOVQM0CnsuX5INS2qERVGXmIY","apiHost":"https://eu.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clinikehrapi","hasAudioNarration":false,"actualSubdomain":"clinikehrapi","customDomains":["docs.clinikehr.com"],"gitSource":{"type":"github","owner":"clinikehr","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af297a5e44c8040cf970c65","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":121},{"language":"default","tag":"Documentation","count":48},{"language":"default","tag":"Resources","count":20},{"language":"default","tag":"Inventory","count":20},{"language":"default","tag":"HMO insurance","count":14},{"language":"default","tag":"Patients","count":11},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Appointments","count":8},{"language":"default","tag":"CRM","count":8},{"language":"default","tag":"Building an integration","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--ck-teal-50: #f0fdfa;--ck-teal-100: #ccfbf1;--ck-teal-500: #14b8a6;--ck-teal-600: #0d9488;--ck-teal-700: #0f766e;--ck-surface: #ffffff;--ck-surface-muted: #f8fafc;--ck-border: #e2e8f0;--ck-text: #0f172a;--ck-text-muted: #64748b;--ck-edition-clinic: #0d9488;--ck-edition-pharmacy: #7c3aed;--ck-edition-lims: #0284c7;--ck-edition-portal: #db2777}.dark{--ck-surface: #0b1120;--ck-surface-muted: #111827;--ck-border: #1f2937;--ck-text: #e2e8f0;--ck-text-muted: #94a3b8;--ck-edition-clinic: #2dd4bf;--ck-edition-pharmacy: #a78bfa;--ck-edition-lims: #38bdf8;--ck-edition-portal: #f472b6}.ck-avail{display:flex;flex-wrap:wrap;align-items:center;gap:0.5rem;margin:1.25rem 0 1.75rem;padding:0.75rem 0.9rem;border:1px solid var(--ck-border);border-radius:0.75rem;background:var(--ck-surface-muted);font-size:0.8125rem;line-height:1.4}.ck-avail__label{font-weight:600;color:var(--ck-text-muted);text-transform:uppercase;letter-spacing:0.04em;font-size:0.6875rem;margin-right:0.15rem}.ck-pill{display:inline-flex;align-items:center;gap:0.35rem;padding:0.2rem 0.6rem;border-radius:999px;border:1px solid currentColor;font-weight:600;font-size:0.75rem;white-space:nowrap}.ck-pill--clinic{color:var(--ck-edition-clinic)}.ck-pill--pharmacy{color:var(--ck-edition-pharmacy)}.ck-pill--lims{color:var(--ck-edition-lims)}.ck-pill--portal{color:var(--ck-edition-portal)}.ck-pill--plan{color:var(--ck-text-muted);border-style:dashed}.ck-pill--role{color:var(--ck-text-muted);border-color:var(--ck-border);background:var(--ck-surface)}.ck-avail__note{flex-basis:100%;color:var(--ck-text-muted)}.ck-callout{margin:1.5rem 0;padding:0.9rem 1rem;border-radius:0.75rem;border:1px solid var(--ck-border);border-left-width:3px;background:var(--ck-surface-muted)}.ck-callout--note{border-left-color:var(--ck-teal-600)}.ck-callout--info{border-left-color:#6366f1}.dark .ck-callout--note{border-left-color:var(--ck-teal-500)}.dark .ck-callout--info{border-left-color:#818cf8}.ck-callout__body{margin:0;font-size:0.9375rem;line-height:1.6;color:var(--ck-text)}.ck-callout__body a{color:var(--ck-teal-700);text-decoration:underline;text-underline-offset:2px}.dark .ck-callout__body a{color:var(--ck-teal-500)}.ck-task{display:grid;gap:0.75rem;grid-template-columns:repeat(auto-fit, minmax(220px, 1fr));margin:1.5rem 0}.ck-task__cell{border:1px solid var(--ck-border);border-radius:0.75rem;padding:0.85rem 1rem;background:var(--ck-surface)}.ck-task__title{font-size:0.6875rem;font-weight:700;letter-spacing:0.06em;text-transform:uppercase;color:var(--ck-teal-600);margin-bottom:0.35rem}.dark .ck-task__title{color:var(--ck-teal-500)}.ck-task__body{font-size:0.875rem;color:var(--ck-text);margin:0}.ck-path{display:inline-flex;flex-wrap:wrap;align-items:center;gap:0.35rem;padding:0.3rem 0.6rem;border-radius:0.5rem;background:var(--ck-teal-50);border:1px solid var(--ck-teal-100);font-size:0.8125rem;font-weight:500;color:var(--ck-teal-700)}.dark .ck-path{background:rgba(13, 148, 136, 0.12);border-color:rgba(45, 212, 191, 0.28);color:var(--ck-teal-500)}.ck-path__sep{opacity:0.55}#sidebar li>a,#sidebar li>div{font-size:0.8125rem}#content-area a[href]>div.group,#content-area .card{transition:transform 150ms ease, box-shadow 150ms ease, border-color 150ms ease}#content-area a[href]:hover>div.group,#content-area .card:hover{transform:translateY(-2px);box-shadow:0 8px 24px -12px rgba(15, 23, 42, 0.25);border-color:var(--ck-teal-500)}.dark #content-area a[href]:hover>div.group,.dark #content-area .card:hover{box-shadow:0 8px 24px -12px rgba(0, 0, 0, 0.6)}#content-area table{display:block;overflow-x:auto;max-width:100%}#content-area thead th{font-size:0.75rem;text-transform:uppercase;letter-spacing:0.04em;color:var(--ck-text-muted)}#content-area .steps .step-number,#content-area [class*=\"step\"]>div[class*=\"rounded-full\"]{background-color:var(--ck-teal-600);color:#fff}@media (max-width: 768px){#content-area table{font-size:0.8125rem}#content-area th,#content-area td{padding-left:0.6rem;padding-right:0.6rem}}@media (max-width: 640px){.ck-avail{padding:0.6rem 0.7rem;gap:0.4rem;font-size:0.78rem}.ck-pill{padding:0.15rem 0.5rem;font-size:0.7rem}.ck-task{grid-template-columns:1fr;gap:0.5rem}.ck-task__cell{padding:0.7rem 0.85rem}.ck-path{font-size:0.78rem;line-height:1.9}.ck-callout{padding:0.75rem 0.85rem;margin:1.1rem 0}}@media (pointer: coarse){#content-area .card,#content-area a[href]>div.group{min-height:44px}#sidebar li>a{padding-top:0.45rem;padding-bottom:0.45rem}}"}]}
{"page":{"pagePath":"inventory","slug":"/inventory","pageMetadata":{"title":"Inventory","description":"Read a clinic's stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.","icon":"/images/icons/boxes-stacked.svg","href":"/inventory"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Read a clinic’s stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Most of this page is `,_jsx(_components.strong,{children:`reading`}),` a clinic’s inventory. The last sections cover the ways your key can `,_jsx(_components.strong,{children:`retire`}),` things: archiving an item, restoring it, deleting one that was never used, and writing off a lot of stock. Creating items and receiving, adjusting or transferring stock are in the API reference and in `,_jsx(_components.a,{href:`/retries-and-idempotency`,children:`Retries and duplicates`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Each endpoint needs a specific permission on the key making the request — see `,_jsx(_components.a,{href:`/permissions`,children:`Permissions`}),` for what each one means before you build against it.`]}),`\n`,_jsx(Heading,{level:`2`,id:`locations`,children:`Locations`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/clinics/{clinic_id}/inventory/locations`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.items:read`}),`. Returns the clinic’s stock locations — the storerooms, shelves or fridges stock is held in.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/locations\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`list-catalogue-items`,children:`List catalogue items`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/clinics/{clinic_id}/inventory/items`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.items:read`}),`. Cursor-paginated (see `,_jsx(_components.a,{href:`/pagination`,children:`Pagination`}),`).`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Query parameter`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`limit`})}),_jsxs(_components.td,{children:[`See `,_jsx(_components.a,{href:`/pagination`,children:`Pagination`}),`. Default 25, max 100.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`starting_after`})}),_jsxs(_components.td,{children:[`See `,_jsx(_components.a,{href:`/pagination`,children:`Pagination`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`q`})}),_jsx(_components.td,{children:`Free-text match against the item’s name. Matches are text matches, not confirmed equivalence — two items with similar names are not necessarily the same product.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`category`})}),_jsx(_components.td,{children:`Filter to one catalogue category.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`active`}),` lists only items in use, `,_jsx(_components.code,{children:`archived`}),` lists only archived items, `,_jsx(_components.code,{children:`all`}),` lists both. Default `,_jsx(_components.code,{children:`all`}),`, so the list is the same as it has always been unless you ask. Anything else is refused with `,_jsx(_components.code,{children:`400`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`updated_since`})}),_jsx(_components.td,{children:`RFC 3339 timestamp — only items changed since this time.`})]})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/items?category=Antibiotics\u0026limit=50\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Each item in the response:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"item_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Amoxicillin 500mg capsules\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"generic_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Amoxicillin\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brand_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"strength\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"500mg\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"dosage_form\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"capsule\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"category\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Antibiotics\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"item_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"medication\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"unit_of_measure\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"capsule\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"archived_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"is_controlled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"identifiers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"system\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gtin\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6001234567899\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"retail_price\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1200.00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"NGN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-20T10:15:00Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`identifiers`}),` lists every code recorded for the item — a barcode (`,_jsx(_components.code,{children:`gtin`}),`) or a national drug registration number (`,_jsx(_components.code,{children:`nafdac`}),`) — and appears `,_jsx(_components.strong,{children:`only where the clinic’s own record has it`}),`. Nothing is inferred or guessed on your behalf: an item with no barcode on file simply has no `,_jsx(_components.code,{children:`gtin`}),` entry.`]}),`\n`,_jsxs(_components.p,{children:[`When you create an item, its `,_jsx(_components.code,{children:`upc`}),` (the barcode) must be a valid GTIN. When you update one, only a `,_jsx(_components.strong,{children:`changed`}),` `,_jsx(_components.code,{children:`upc`}),` is checked: sending back the value the item already holds is accepted even if it is not a valid GTIN, so an item you read can be written back as it is. A new or different `,_jsx(_components.code,{children:`upc`}),` that is not a valid GTIN is refused with `,_jsx(_components.code,{children:`400 invalid_gtin`}),`. To compare, the API reads the item’s current value with your key, so a key without `,_jsx(_components.code,{children:`inventory.items:read`}),` cannot send an unchanged invalid value, and that read counts toward your rate limit (if it is refused, for example when you are rate limited, you get that answer instead of `,_jsx(_components.code,{children:`invalid_gtin`}),`). The `,_jsx(_components.code,{children:`barcode`}),` filter when you list items is not checked: it matches exactly what is stored, so you can still find an item whose stored barcode is not a valid GTIN. `,_jsx(_components.code,{children:`null`}),` clears the barcode.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`is_active`}),` is `,_jsx(_components.code,{children:`false`}),` and `,_jsx(_components.code,{children:`archived_at`}),` holds the time while an item is archived; both go back to normal when it is restored.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`is_controlled`}),` is `,_jsx(_components.code,{children:`true`}),` when the clinic has marked the item as a controlled medicine. It is read-only: it can only be changed in the ClinikEHR app, by staff the clinic has allowed to mark medicines as controlled. A clinic that has not marked anything reports `,_jsx(_components.code,{children:`false`}),` for every item, so treat `,_jsx(_components.code,{children:`false`}),` as “not marked”, not as a statement about the medicine’s legal status.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`retail_price`}),` is `,_jsx(_components.code,{children:`null`}),` when the clinic hasn’t set a price for the item — never a fabricated `,_jsx(_components.code,{children:`0`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`get-one-item`,children:`Get one item`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/clinics/{clinic_id}/inventory/items/{item_id}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.items:read`}),`. Same fields as one entry of the list above. An `,_jsx(_components.code,{children:`item_id`}),` that doesn’t exist, or that belongs to a different clinic, returns `,_jsx(_components.code,{children:`404`}),` with `,_jsx(_components.code,{children:`code: \"not_found\"`}),` — see `,_jsx(_components.a,{href:`/errors`,children:`Errors`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`check-availability`,children:`Check availability`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST /v1/clinics/{clinic_id}/inventory/availability`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.availability:read`}),`. Checks up to `,_jsx(_components.strong,{children:`100 items`}),` in one request — by their ID, or by any identifier you already hold (a barcode, for example) — and returns a band for each, never an exact number. A `,_jsx(_components.code,{children:`gtin`}),` value must be a valid barcode number: 8, 12, 13 or 14 digits, digits only, with a correct GS1 check digit. Anything else is refused with `,_jsx(_components.code,{children:`400 invalid_gtin`}),`, and the answer names the field and the value.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/availability\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"items\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"item_id\": \"item_01example\" },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"system\": \"gtin\", \"value\": \"6001234567899\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"item_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"item_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"matched\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"band\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"in_stock\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"as_of\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-27T09:02:11Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"item_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"item_02example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"matched\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"band\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"low\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"as_of\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-27T09:02:11Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`matched`})}),_jsxs(_components.td,{children:[`Whether the identifier you sent resolved to a real item. `,_jsx(_components.code,{children:`false`}),` means it didn’t — not that the item is out of stock.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`band`})}),_jsxs(_components.td,{children:[`One of `,_jsx(_components.code,{children:`out`}),`, `,_jsx(_components.code,{children:`low`}),`, or `,_jsx(_components.code,{children:`in_stock`}),`. Computed by the clinic’s own thresholds, not something you can influence per request.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`as_of`})}),_jsx(_components.td,{children:`When this figure was last known to be true.`})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsxs(_components.strong,{children:[`A positive `,_jsx(_components.code,{children:`band`}),` is not a reservation.`]}),` Nothing about calling this endpoint holds, claims, or sets anything aside. Between reading `,_jsx(_components.code,{children:`in_stock`}),` and a customer actually being sold the item, stock can change — always show `,_jsx(_components.code,{children:`as_of`}),` to whoever is relying on the answer, and never present availability as a guarantee.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`exact-stock-levels`,children:`Exact stock levels`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/clinics/{clinic_id}/inventory/stock`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.stock:read`}),` — a separate, more sensitive permission than availability (see `,_jsx(_components.a,{href:`/permissions`,children:`Permissions`}),`). Returns exact quantities, by location and lot.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Query parameter`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`location_id`})}),_jsx(_components.td,{children:`Filter to one stock location.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`item_id`})}),_jsx(_components.td,{children:`Filter to one item.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`expiring_before`})}),_jsx(_components.td,{children:`RFC 3339 date — only lots expiring before this date.`})]})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/stock?item_id=item_01example\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"item_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"item_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"location_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"loc_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lot_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"lot_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"42\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"as_of\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-27T09:02:11Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_more\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"next_cursor\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`quantity`}),` is a decimal `,_jsx(_components.strong,{children:`string`}),`, the same convention used for money — see `,_jsx(_components.a,{href:`/pagination`,children:`Pagination`}),` for the list envelope this sits inside.`]}),`\n`,_jsx(Heading,{level:`2`,id:`archive-an-item`,children:`Archive an item`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST /v1/clinics/{clinic_id}/inventory/items/{item_id}/archive`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.items:write`}),`. Archiving hides an item from sale and dispensing without erasing anything — it is always reversible, and the item keeps its history. You can send an optional `,_jsx(_components.code,{children:`reason`}),`, which is kept with the item. No `,_jsx(_components.code,{children:`Idempotency-Key`}),` is needed, and archiving an item that is already archived simply succeeds.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/items/ITEM_ID/archive\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ \"reason\": \"No longer stocked\" }'`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The response is the item under `,_jsx(_components.code,{children:`data`}),`, now with `,_jsx(_components.code,{children:`is_active: false`}),` and an `,_jsx(_components.code,{children:`archived_at`}),` time.`]}),`\n`,_jsxs(_components.p,{children:[`An item that still has stock on hand is refused with `,_jsx(_components.code,{children:`409`}),` and `,_jsx(_components.code,{children:`code: \"item_has_stock\"`}),`; the `,_jsx(_components.code,{children:`detail`}),` says how many units are left. Write the stock off (below) or move it first, then archive.`]}),`\n`,_jsx(Heading,{level:`2`,id:`restore-an-item`,children:`Restore an item`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST /v1/clinics/{clinic_id}/inventory/items/{item_id}/restore`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.items:write`}),`. Brings an archived item back so it can be sold and dispensed again. Restoring an item that is already active simply succeeds. No body and no `,_jsx(_components.code,{children:`Idempotency-Key`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/items/ITEM_ID/restore\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The response is the item under `,_jsx(_components.code,{children:`data`}),`, with `,_jsx(_components.code,{children:`is_active: true`}),` and `,_jsx(_components.code,{children:`archived_at: null`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`delete-an-item-that-was-never-used`,children:`Delete an item that was never used`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`DELETE /v1/clinics/{clinic_id}/inventory/items/{item_id}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.items:write`}),`. `,_jsx(_components.strong,{children:`Deleting is permanent`}),`, so it is only allowed for an item that has never been used: it has never held stock and is not part of any order, count, recipe or dispense. If you added an item by mistake, this removes it.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` DELETE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/items/ITEM_ID\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"item_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Anything with history is refused with `,_jsx(_components.code,{children:`409`}),` and `,_jsx(_components.code,{children:`code: \"item_has_history\"`}),` — `,_jsx(_components.strong,{children:`archive it instead`}),`, which keeps the history. Sending the same delete a second time returns `,_jsx(_components.code,{children:`404`}),`, because the item is gone.`]}),`\n`,_jsx(Heading,{level:`2`,id:`write-off-a-lot-of-stock`,children:`Write off a lot of stock`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST /v1/clinics/{clinic_id}/inventory/lots/{lot_id}/write-off`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`inventory.stock:write`}),`. Use this when a lot has expired, been damaged or been recalled. It records the lot’s remaining quantity as wasted, at every location where it is held, and then archives the lot. The clinic’s stock history keeps the movement; nothing is deleted.`]}),`\n`,_jsx(_components.p,{children:`The request needs two things:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`a `,_jsx(_components.code,{children:`reason`}),` in the body — say why the stock is being written off;`]}),`\n`,_jsxs(_components.li,{children:[`an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header, so a retry after a timeout cannot write the same lot off twice. See `,_jsx(_components.a,{href:`/retries-and-idempotency`,children:`Retries and duplicates`}),`.`]}),`\n`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/lots/LOT_ID/write-off\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Idempotency-Key: 7c9e6679-7425-40de-944b-e07fc1f90ae7\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{ \"reason\": \"Expired on the shelf\" }'`})]}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lot_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"lot_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"item_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"item_01example\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"quantity_written_off\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"42\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reason\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Expired on the shelf\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"archived_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-10-05T10:15:00Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`quantity_written_off`}),` is a decimal `,_jsx(_components.strong,{children:`string`}),`, like every quantity.`]}),`\n`,_jsxs(_components.p,{children:[`Leaving `,_jsx(_components.code,{children:`reason`}),` out is a `,_jsx(_components.code,{children:`400`}),` that names the field; a blank reason is refused with `,_jsx(_components.code,{children:`code: \"reason_required\"`}),`. A controlled drug is refused with `,_jsx(_components.code,{children:`403`}),` and `,_jsx(_components.code,{children:`code: \"controlled_drug_not_api_movable\"`}),` — an API key has no witness to countersign, so the clinic records that loss itself. A lot with part of its stock reserved is refused with `,_jsx(_components.code,{children:`409`}),` and `,_jsx(_components.code,{children:`code: \"insufficient_stock\"`}),` until the reservation is released.`]}),`\n`,_jsx(Heading,{level:`2`,id:`send-a-stock-report`,children:`Send a stock report`}),`\n`,_jsx(CodeBlock,{numberOfLines:`3`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`POST /v1/clinics/{clinic_id}/inventory/external-stock/batches`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/clinics/{clinic_id}/inventory/external-stock/batches/{batch_id}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`For a pharmacy that sells through `,_jsx(_components.strong,{children:`another system`}),`. The pharmacy’s owner first switches Settings → API access → `,_jsx(_components.strong,{children:`Stock source`}),` to “Another system’s stock report”; your system then sends that system’s stock as a report, and the pharmacy’s listings show it. Nothing is added to the pharmacy’s own ledger: a report only sets what listings say.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Permission.`}),` The key needs `,_jsx(_components.code,{children:`inventory.external_stock:write`}),`, the narrow permission for exactly this. It is available on `,_jsx(_components.strong,{children:`every paid pharmacy plan, including the Listing plan`}),`, and it cannot read, adjust or receive stock. A key that already holds `,_jsx(_components.code,{children:`inventory.stock:write`}),` (Team and above) works too, and `,_jsx(_components.code,{children:`GET`}),` also accepts `,_jsx(_components.code,{children:`inventory.stock:read`}),`. Clinic keys only: an organization never sends a pharmacy’s stock.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Body field`}),_jsx(_components.th,{children:`Notes`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`batch_id`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Required.`}),` A UUID you generate. It is the idempotency key: sending the same one again returns the stored result and does nothing twice.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`as_of`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Required.`}),` When your system produced the report. We clamp it to the last 30 days.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`feed_source`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Required.`}),` A short label for the system sending it.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`rows`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Required.`}),` Up to 5,000 rows. Each has `,_jsx(_components.code,{children:`identifiers`}),` (at least one `,_jsx(_components.code,{children:`{ \"system\", \"value\" }`}),`, the same systems as `,_jsx(_components.a,{href:`/pharmacy-listings#search-for-a-medicine`,children:`search`}),`) and at least one of `,_jsx(_components.code,{children:`quantity`}),` (a number, not negative) or `,_jsx(_components.code,{children:`band`}),` (`,_jsx(_components.code,{children:`in_stock`}),`, `,_jsx(_components.code,{children:`low`}),`, `,_jsx(_components.code,{children:`out`}),`). A `,_jsx(_components.code,{children:`gtin`}),` identifier must be a valid GTIN, or the whole report is refused with `,_jsx(_components.code,{children:`400 invalid_gtin`}),` before anything is read or saved.`]})]})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.clinikehr.com/v1/clinics/YOUR_CLINIC_ID/inventory/external-stock/batches\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer ehr_live_EXAMPLEKEYID0000000000_EXAMPLESECRET…\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"batch_id\": \"6f1d3c52-8a1e-4b7e-9f0d-0c2f5e3b7a11\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"as_of\": \"2026-10-13T08:00:00Z\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"feed_source\": \"Example POS nightly export\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"rows\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"identifiers\": [{ \"system\": \"gtin\", \"value\": \"5000000000005\" }], \"quantity\": 120 },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"identifiers\": [{ \"system\": \"nafdac\", \"value\": \"A4-0000\" }], \"band\": \"low\" }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"batch_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6f1d3c52-8a1e-4b7e-9f0d-0c2f5e3b7a11\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"item_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"matched_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"unmatched_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A row that matches none of the pharmacy’s products is `,_jsx(_components.strong,{children:`counted as unmatched and ignored`}),`. Nothing is guessed.`]}),`\n`,_jsxs(_components.li,{children:[`A report is applied whole or not at all. One with an unreadable row (`,_jsx(_components.code,{children:`invalid_rows`}),`), far fewer products than the last accepted report (`,_jsx(_components.code,{children:`suspicious_shrink`}),`) or no rows (`,_jsx(_components.code,{children:`empty`}),`) is refused with `,_jsx(_components.code,{children:`409 batch_rejected`}),` and nothing is saved.`]}),`\n`,_jsxs(_components.li,{children:[`A pharmacy that is not in “Another system’s stock report” mode is refused with `,_jsx(_components.code,{children:`409 external_stock_mode_required`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`A report older than the pharmacy’s freshness window makes its products read as `,_jsx(_components.code,{children:`unknown`}),` in listings. Send them regularly.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`what’s-never-in-an-inventory-response`,children:`What’s never in an inventory response`}),`\n`,_jsx(_components.p,{children:`No inventory endpoint returns cost price, vendor information, margins, or anything about a specific customer or sale. This release exposes only what a clinic explicitly permits under Availability, Catalogue, or Stock levels — nothing else rides along.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Inventory","description":"Read a clinic's stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.","icon":"/images/icons/boxes-stacked.svg","href":"/inventory"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Locations","slug":"locations","depth":2,"children":[]},{"title":"List catalogue items","slug":"list-catalogue-items","depth":2,"children":[]},{"title":"Get one item","slug":"get-one-item","depth":2,"children":[]},{"title":"Check availability","slug":"check-availability","depth":2,"children":[]},{"title":"Exact stock levels","slug":"exact-stock-levels","depth":2,"children":[]},{"title":"Archive an item","slug":"archive-an-item","depth":2,"children":[]},{"title":"Restore an item","slug":"restore-an-item","depth":2,"children":[]},{"title":"Delete an item that was never used","slug":"delete-an-item-that-was-never-used","depth":2,"children":[]},{"title":"Write off a lot of stock","slug":"write-off-a-lot-of-stock","depth":2,"children":[]},{"title":"Send a stock report","slug":"send-a-stock-report","depth":2,"children":[]},{"title":"What’s never in an inventory response","slug":"what’s-never-in-an-inventory-response","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"clinikehrapi","siteName":"ClinikEHR API","title":"Inventory - ClinikEHR API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-01T00:01:42.317Z","originalFileLocation":"inventory.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=\"Read a clinic\u0026#x27;s stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ClinikEHR API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_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/clinikehrapi/7-ZhjGEqSsWHGBLc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Inventory - ClinikEHR API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read a clinic\u0026#x27;s stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClinikEHR API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clinikehr.com/inventory\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clinikehrapi.mintlify.site/_mintlify/api/og/v2?division=Resources\u0026amp;title=Inventory\u0026amp;description=Read+a+clinic%27s+stock+locations%2C+catalogue+items%2C+availability+and+exact+stock+levels%2C+and+archive%2C+restore%2C+delete+or+write+off+what+the+clinic+no+longer+uses.\u0026amp;theme=db10b84d30f87e3825f88ac9\u0026amp;signature=4603eb3968610db78e567d55233a6e8c5665b9aab718759be6a48314355164dd\">\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=\"Inventory - ClinikEHR API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read a clinic\u0026#x27;s stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clinikehrapi.mintlify.site/_mintlify/api/og/v2?division=Resources\u0026amp;title=Inventory\u0026amp;description=Read+a+clinic%27s+stock+locations%2C+catalogue+items%2C+availability+and+exact+stock+levels%2C+and+archive%2C+restore%2C+delete+or+write+off+what+the+clinic+no+longer+uses.\u0026amp;theme=db10b84d30f87e3825f88ac9\u0026amp;signature=4603eb3968610db78e567d55233a6e8c5665b9aab718759be6a48314355164dd\">\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/clinikehrapi/7-ZhjGEqSsWHGBLc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClinikEHR API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9488\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clinikehr.com/inventory\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/inventory.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clinikehr.com/#organization\",\"name\":\"ClinikEHR API\",\"url\":\"https://docs.clinikehr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clinikehrapi/yWDcCtWZLvQferdo/logo/light.svg?fit=max\u0026auto=format\u0026n=yWDcCtWZLvQferdo\u0026q=85\u0026s=1c5da83101c773651a555abca64ef883\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clinikehr.com#website\",\"name\":\"ClinikEHR API\",\"url\":\"https://docs.clinikehr.com\",\"publisher\":{\"@id\":\"https://docs.clinikehr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clinikehr.com/inventory#webpage\",\"url\":\"https://docs.clinikehr.com/inventory\",\"name\":\"Inventory\",\"description\":\"Read a clinic's stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.\",\"dateModified\":\"2026-11-01T00:01:42.317Z\",\"isPartOf\":{\"@id\":\"https://docs.clinikehr.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clinikehr.com/inventory#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clinikehr.com/inventory#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://docs.clinikehr.com/patients\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Inventory\",\"item\":\"https://docs.clinikehr.com/inventory\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.clinikehr.com/inventory#article\",\"headline\":\"Inventory\",\"name\":\"Inventory\",\"description\":\"Read a clinic's stock locations, catalogue items, availability and exact stock levels, and archive, restore, delete or write off what the clinic no longer uses.\",\"url\":\"https://docs.clinikehr.com/inventory\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clinikehr.com/inventory#webpage\"},\"dateModified\":\"2026-11-01T00:01:42.317Z\",\"publisher\":{\"@id\":\"https://docs.clinikehr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clinikehr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ClinikEHR API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ClinikEHR API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/inventory.md","siteName":"ClinikEHR API","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Introduction","pages":[{"title":"ClinikEHR API","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/compass.svg","href":""},{"title":"Quickstart","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/rocket.svg","href":"/quickstart"},{"title":"SDKs and Postman","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/code.svg","href":"/sdks-and-postman"},{"title":"TypeScript client","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/code.svg","href":"/typescript-sdk"},{"title":"Python client","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/code.svg","href":"/python-sdk"}]},{"group":"Building an integration","pages":[{"title":"Authentication","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/key.svg","href":"/authentication"},{"title":"Permissions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/permissions"},{"title":"Getting access to patient data","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/patient-data-access"},{"title":"Pagination","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/layer-group.svg","href":"/pagination"},{"title":"Response formats: JSON and FHIR","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/layers.svg","href":"/json-and-fhir"},{"title":"Errors","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/triangle-exclamation.svg","href":"/errors"},{"title":"Rate limits","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/gauge.svg","href":"/rate-limits"}]},{"group":"Resources","pages":[{"title":"Patients","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/patients"},{"title":"Appointments","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/compass.svg","href":"/appointments"},{"title":"Encounters","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/file-signature.svg","href":"/encounters"},{"title":"Clinical notes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/file-signature.svg","href":"/notes"},{"title":"Conditions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/conditions"},{"title":"Allergies","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/allergies"},{"title":"Medications","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/prescription-bottle-medical.svg","href":"/medications"},{"title":"Referrals","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/referrals"},{"title":"Providers: the clinic's clinicians","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/link.svg","href":"/providers"},{"title":"Outside care providers","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/link.svg","href":"/care-providers"},{"title":"Insurance: payers and coverage","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/insurance"},{"title":"Insurance for HMOs and insurers","description":"Verify enrollees, vet claims, decide authorizations and report payments for the insurers a clinic links to you, or submit claims as a developer.","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/insurance-hmos"},{"title":"Inventory","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/boxes-stacked.svg","href":"/inventory"},{"title":"Dispensing history and flags","description":"Read what a pharmacy has dispensed to a linked patient, and the refill and duplicate-dispensing flags its pharmacists recorded. Read-only, and never a price.","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/prescription-bottle-medical.svg","href":"/dispensing"},{"title":"Prescription pickups","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/prescription-bottle-medical.svg","href":"/prescription-pickups"},{"title":"Outreach events","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/outreach-events"},{"title":"Pharmacy listings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/prescription-bottle-medical.svg","href":"/pharmacy-listings"},{"title":"CRM contacts and pipelines","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/layers.svg","href":"/crm"},{"title":"Events","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/arrows-repeat.svg","href":"/events"},{"title":"Connections","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/link.svg","href":"/connections"}]},{"group":"Guides","pages":[{"title":"Stock bands, and what \"unknown\" means","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/gauge.svg","href":"/stock-bands"},{"title":"Verifying a webhook's signature","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/file-signature.svg","href":"/verifying-webhook-signatures"},{"title":"Retries and duplicates","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/arrows-repeat.svg","href":"/retries-and-idempotency"},{"title":"Workspace settings and your account","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/workspace-settings-and-account"},{"title":"Uploading your own medicine codes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/barcode.svg","href":"/uploading-partner-codes"},{"title":"Drug requests","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/prescription-bottle-medical.svg","href":"/drug-requests"},{"title":"Reviewing outside submissions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/reviewing-outside-submissions"},{"title":"Automatic acceptance","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/automatic-acceptance"},{"title":"FHIR R4","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/code.svg","href":"/fhir"}]},{"group":"Plans and billing","pages":[{"title":"Plans and pricing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/credit-card.svg","href":"/plans-and-pricing"},{"title":"Usage and billing","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/chart-line.svg","href":"/usage-and-billing"}]},{"group":"Reference","pages":[{"title":"Versioning","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/layers.svg","href":"/versioning"}]},{"group":"Legal","pages":[{"title":"API Terms of Use","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/file-signature.svg","href":"/terms-of-use"},{"title":"Acceptable Use Policy","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-check.svg","href":"/acceptable-use-policy"},{"title":"Data Protection Addendum for Organizations","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/shield-halved.svg","href":"/data-protection-addendum"}]},{"group":"Changelog","pages":[{"title":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/clinikehrapi/images/icons/sparkles.svg","mode":"center","href":"/changelog/index"}]}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api-reference/overview"}]}]},"basePath":"","title":"Inventory - ClinikEHR API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}