An optional dictionary of key-value pairs stored with the order.
Example:
null
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Spot","colors":{"primary":"#7E63F8","light":"#DB6082","dark":"#462BBE"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/spot/5oSV-2vR4214gDZI/logo.svg?fit=max\u0026auto=format\u0026n=5oSV-2vR4214gDZI\u0026q=85\u0026s=c3babda7ad42176c58dfe4ea2137cd7c","dark":"https://mintcdn.com/spot/5oSV-2vR4214gDZI/logo.svg?fit=max\u0026auto=format\u0026n=5oSV-2vR4214gDZI\u0026q=85\u0026s=c3babda7ad42176c58dfe4ea2137cd7c"},"api":{"mdx":{"server":"https://app.spotdx.com"}},"background":{"image":"https://mintlify.s3.us-west-1.amazonaws.com/spot/background.png","decoration":null},"navbar":{"primary":{"type":"button","label":"Book a Call","href":"https://calendly.com/jajack/30minutes"}},"footer":{"socials":{"website":"https://spotdx.com/","linkedin":"https://www.linkedin.com/company/spotkits/"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spot","hasAudioNarration":false,"actualSubdomain":"spot","customDomains":["docs.spotdx.com"],"gitSource":{"type":"github","owner":"spothealth","repo":"public-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c3454d01e0d38c5e4731","collectionId":"59782a55-59a4-405f-8e47-b5f53d23aec7","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a20c3454d01e0d38c5e4731:success","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"API Reference - Orders","count":4},{"language":"default","tag":"Welcome","count":3},{"language":"default","tag":"Basic Guides","count":3},{"language":"default","tag":"API Reference - Requisitions","count":3},{"language":"default","tag":"Advanced Guides","count":2},{"language":"default","tag":"API Reference - Registration","count":2},{"language":"default","tag":"API Reference - Kits","count":2},{"language":"default","tag":"Integrations","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/update-order-metadata","slug":"/reference/update-order-metadata","pageMetadata":{"title":"Update order metadata","openapi":"POST /api/v2/orders/{public_id}/","description":"Replace the metadata for an order with a new set of values","href":"/reference/update-order-metadata"},"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: \"Replace the metadata for an order with a new set of values\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update order metadata","openapi":"POST /api/v2/orders/{public_id}/","description":"Replace the metadata for an order with a new set of values","href":"/reference/update-order-metadata"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"api_v2_update_order_metadata","description":"Replace the metadata for an order with a new set of values","parameters":["6e578b21-4e40-4263-b238-2c15c9e571eb"],"requestBody":"28ccc3c4-3fdf-46c1-aeca-351bf861996c","security":["0f1cc015-a159-4c7b-995b-c54ead99ae86"],"responses":{"200":"8c9a2792-2590-4e32-8154-519d0b598750","400":"6a95a122-96e4-4769-82c7-157209276a9c","404":"6bf67580-a7dc-4b00-b402-c95fc22390f2"},"method":"post","type":"path","servers":["136bb80f-2e5e-442d-9083-64ebaa0c8fbb"],"path":"/api/v2/orders/{public_id}/","baseUrlOptions":["https://app.spotdx.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6e578b21-4e40-4263-b238-2c15c9e571eb":{"in":"path","name":"public_id","schema":{"type":"string","isRequired":true,"description":"The ID of the order to retrieve.","uniqueKey":"","typeLabel":"string"},"description":"The ID of the order to retrieve.","required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"object","description":"The metadata to replace the existing metadata with.","example":{"some_key":"some_value"},"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"metadata":{"some_key":"some_value"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8c9a2792-2590-4e32-8154-519d0b598750":{"content":{"application/json":{"schema":{"type":"object","properties":{"order_id":{"type":"string","description":"The unique identifier of the order.","example":"O1234567","uniqueKey":"order_id","typeLabel":"string"},"status":{"type":"string","enum":["pending","in_progress","completed","canceled"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"recipient":{"type":"object","properties":{"first_name":{"type":"string","description":"Recipient's first name.","example":"Alice","isRequired":true,"uniqueKey":"recipient.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Recipient's last name.","example":"Smith","isRequired":true,"uniqueKey":"recipient.last_name","typeLabel":"string"},"email":{"type":"string","description":"Recipient's email.","example":"alice123@gmail.com","isRequired":true,"uniqueKey":"recipient.email","typeLabel":"string"},"phone":{"type":"string","description":"Recipient's phone number, as a string.","example":"1234567890","isRequired":true,"uniqueKey":"recipient.phone","typeLabel":"string"},"address":{"type":"object","properties":{"street1":{"type":"string","description":"Recipient's address.","example":"123 Main St","isRequired":true,"uniqueKey":"recipient.address.street1","typeLabel":"string"},"city":{"type":"string","description":"Recipient's city of residence.","example":"San Francisco","isRequired":true,"uniqueKey":"recipient.address.city","typeLabel":"string"},"state":{"type":"string","description":"Recipient's state of residence.","example":"CA","isRequired":true,"uniqueKey":"recipient.address.state","typeLabel":"string"},"country":{"type":"string","description":"Recipient's country of residence.","enum":["US","CA"],"example":"US","isRequired":true,"uniqueKey":"recipient.address.country","typeLabel":"enum\u003cstring>"},"zip":{"type":"string","description":"Recipient's zip code.","example":"94105","isRequired":true,"uniqueKey":"recipient.address.zip","typeLabel":"string"},"street2":{"oneOf":[{"description":"Second line of recipient's address.","type":"string","example":"Apt 1","uniqueKey":"recipient.address.street2.oneOf.0","typeLabel":"string"},{"description":"Second line of recipient's address.","type":"null","example":"Apt 1","uniqueKey":"recipient.address.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient.address.street2","typeLabel":"string | null"}},"required":["street1","city","state","country","zip"],"isRequired":true,"uniqueKey":"recipient.address","typeLabel":"object"}},"required":["address","email","first_name","last_name","phone"],"uniqueKey":"recipient","typeLabel":"object"},"kit_types":{"type":"array","items":{"type":"string","uniqueKey":"kit_types.items.[INDEX]","typeLabel":"string"},"description":"A list of the kit types that are included in this order.","example":["health_kit_1"],"uniqueKey":"kit_types","typeLabel":"string[]"},"kits":{"type":"array","items":{"type":"object","properties":{"kit_id":{"type":"string","description":"The unique identifier of the kit.","example":"SPOT123456","uniqueKey":"kits.items.[INDEX].kit_id","typeLabel":"string"},"type":{"type":"string","description":"The kit's type","example":"health_kit_1","uniqueKey":"kits.items.[INDEX].type","typeLabel":"string"},"status":{"type":"string","description":"The new status of the kit.","enum":["preparing","in_transit","delivered","delivery_exception","registered","canceled"],"example":"preparing","uniqueKey":"kits.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"events":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The new status of the kit.","enum":["preparing","in_transit","delivered","delivery_exception","registered","canceled"],"example":"preparing","uniqueKey":"kits.items.[INDEX].events.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"created":{"type":"string","format":"date-time","description":"The date and time the event occurred.","example":"2023-01-01T04:30:11.222Z","uniqueKey":"kits.items.[INDEX].events.items.[INDEX].created","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"kits.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"description":"A list of all the events that have occurred for this kit.","example":[{"status":"preparing","created":"2023-01-01T04:30:11.222Z"},{"status":"in_transit","created":"2023-01-05T04:30:11.222Z"},{"status":"delivered","created":"2023-01-06T04:30:11.222Z"},{"status":"registered","created":"2023-01-07T04:30:11.222Z"}],"uniqueKey":"kits.items.[INDEX].events","typeLabel":"object[]"},"shipment_to_customer":{"type":"object","properties":{"tracking_number":{"oneOf":[{"type":"string","example":"9400123456789999876500","uniqueKey":"kits.items.[INDEX].shipment_to_customer.tracking_number.oneOf.0","typeLabel":"string"},{"type":"null","example":"9400123456789999876500","uniqueKey":"kits.items.[INDEX].shipment_to_customer.tracking_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].shipment_to_customer.tracking_number","typeLabel":"string | null"},"carrier":{"oneOf":[{"type":"string","enum":["fedex","ups","usps"],"example":"usps","uniqueKey":"kits.items.[INDEX].shipment_to_customer.carrier.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["fedex","ups","usps"],"example":"usps","uniqueKey":"kits.items.[INDEX].shipment_to_customer.carrier.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].shipment_to_customer.carrier","typeLabel":"enum\u003cstring> | null"},"created":{"type":"string","format":"date-time","example":"2023-01-01T04:30:11.222Z","uniqueKey":"kits.items.[INDEX].shipment_to_customer.created","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"kits.items.[INDEX].shipment_to_customer","typeLabel":"object"},"registered_to":{"type":"object","properties":{"patient_id":{"type":"string","format":"uuid","example":"7563e8e2-7fbd-480c-9b8b-2070eda884bf","uniqueKey":"kits.items.[INDEX].registered_to.patient_id","typeLabel":"string\u003cuuid>"},"first_name":{"type":"string","example":"Alice","uniqueKey":"kits.items.[INDEX].registered_to.first_name","typeLabel":"string"},"last_name":{"type":"string","example":"Smith","uniqueKey":"kits.items.[INDEX].registered_to.last_name","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date","example":"1990-01-01","uniqueKey":"kits.items.[INDEX].registered_to.date_of_birth","typeLabel":"string\u003cdate>"},"sex":{"type":"string","enum":["M","F"],"example":"F","uniqueKey":"kits.items.[INDEX].registered_to.sex","typeLabel":"enum\u003cstring>"},"email":{"type":"string","example":"alice123@gmail.com","uniqueKey":"kits.items.[INDEX].registered_to.email","typeLabel":"string"},"phone":{"type":"string","example":"1234567890","uniqueKey":"kits.items.[INDEX].registered_to.phone","typeLabel":"string"}},"uniqueKey":"kits.items.[INDEX].registered_to","typeLabel":"object"},"sample":{"type":"object","properties":{"sample_id":{"type":"string","example":"SPOT654321","uniqueKey":"kits.items.[INDEX].sample.sample_id","typeLabel":"string"},"status":{"type":"string","description":"The new status of the sample.","enum":["awaiting_collection","collection_exception","delivery_exception","delivered","in_transit","received","resulted","partially_resulted","extra_quality_checks","canceled"],"uniqueKey":"kits.items.[INDEX].sample.status","typeLabel":"enum\u003cstring>"},"events":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"The new status of the sample.","enum":["awaiting_collection","collection_exception","delivery_exception","delivered","in_transit","received","resulted","partially_resulted","extra_quality_checks","canceled"],"uniqueKey":"kits.items.[INDEX].sample.events.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"created":{"type":"string","format":"date-time","example":"2023-01-01T04:30:11.222Z","uniqueKey":"kits.items.[INDEX].sample.events.items.[INDEX].created","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"kits.items.[INDEX].sample.events.items.[INDEX]","typeLabel":"object"},"example":[{"status":"awaiting_collection","created":"2023-01-01T04:30:11.222Z"},{"status":"in_transit","created":"2023-01-10T04:30:11.222Z"},{"status":"delivered","created":"2023-01-11T04:30:11.222Z"},{"status":"received","created":"2023-01-12T04:30:11.222Z"},{"status":"resulted","created":"2023-01-13T04:30:11.222Z"}],"uniqueKey":"kits.items.[INDEX].sample.events","typeLabel":"object[]"},"type":{"type":"string","enum":["adx100","adx100_2","adx100_4","whatman903_10","dry_transport_swab","hemaspot_hf","saliva_3"],"example":"adx100","uniqueKey":"kits.items.[INDEX].sample.type","typeLabel":"enum\u003cstring>"},"shipments":{"type":"array","items":{"type":"object","properties":{"tracking_number":{"oneOf":[{"type":"string","example":"9400123456789999876500","uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX].tracking_number.oneOf.0","typeLabel":"string"},{"type":"null","example":"9400123456789999876500","uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX].tracking_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX].tracking_number","typeLabel":"string | null"},"carrier":{"oneOf":[{"type":"string","enum":["fedex","ups","usps"],"example":"usps","uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX].carrier.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["fedex","ups","usps"],"example":"usps","uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX].carrier.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX].carrier","typeLabel":"enum\u003cstring> | null"},"created":{"type":"string","format":"date-time","example":"2023-01-01T04:30:11.222Z","uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX].created","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"kits.items.[INDEX].sample.shipments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"kits.items.[INDEX].sample.shipments","typeLabel":"object[]"},"panels":{"type":"array","description":"The panel codes of the test being performed on the sample. We'll create these with you during onboarding.","example":["PANEL-123"],"items":{"type":"string","uniqueKey":"kits.items.[INDEX].sample.panels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"kits.items.[INDEX].sample.panels","typeLabel":"string[]"},"reports":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"report_id":{"type":"string","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.report_id","typeLabel":"string"},"results":{"description":"","type":"array","items":{"oneOf":[{"type":"object","properties":{"result_type":{"type":"string","enum":["quantity"],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.result_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The biomarker that was analyzed.","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.name","typeLabel":"string"},"time_collected":{"type":"string","format":"date-time","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.time_collected","typeLabel":"string\u003cdate-time>"},"result":{"oneOf":[{"type":"string","description":"","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.result.oneOf.0","typeLabel":"string"},{"type":"number","description":"","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.result.oneOf.1","typeLabel":"number"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.result","typeLabel":"string | number"},"unit_of_measure":{"oneOf":[{"type":"string","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.unit_of_measure.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.unit_of_measure.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.unit_of_measure","typeLabel":"string | null"},"range_minimum":{"type":"string","minimum":0,"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.range_minimum","typeLabel":"string"},"range_maximum":{"type":"number","minimum":0,"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.range_maximum","typeLabel":"number"},"comments":{"oneOf":[{"type":"string","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.comments.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0.comments","typeLabel":"string | null"}},"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","properties":{"result_type":{"type":"string","enum":["reactivity"],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.result_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The biomarker that was analyzed.","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.name","typeLabel":"string"},"time_collected":{"type":"string","format":"date-time","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.time_collected","typeLabel":"string\u003cdate-time>"},"result":{"description":"","type":"string","enum":["positive","negative"],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.result","typeLabel":"enum\u003cstring>"},"unit_of_measure":{"oneOf":[{"type":"string","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.unit_of_measure.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.unit_of_measure.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.unit_of_measure","typeLabel":"string | null"},"range_minimum":{"oneOf":[{"type":"number","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.range_minimum.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.range_minimum.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.range_minimum","typeLabel":"number | null"},"range_maximum":{"oneOf":[{"type":"number","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.range_maximum.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.range_maximum.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.range_maximum","typeLabel":"number | null"},"comments":{"oneOf":[{"type":"string","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.comments.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1.comments","typeLabel":"string | null"}},"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","properties":{"result_type":{"type":"string","enum":["genotype"],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.result_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The biomarker that was analyzed.","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.name","typeLabel":"string"},"time_collected":{"type":"string","format":"date-time","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.time_collected","typeLabel":"string\u003cdate-time>"},"result":{"description":"","type":"string","enum":["TT","GG","CG","AG","CT","CC","AA","AT","AC","TA","TG","TC","GA","GT","GC","CA"],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.result","typeLabel":"enum\u003cstring>"},"unit_of_measure":{"oneOf":[{"type":"string","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.unit_of_measure.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.unit_of_measure.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.unit_of_measure","typeLabel":"string | null"},"range_minimum":{"oneOf":[{"type":"number","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.range_minimum.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.range_minimum.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.range_minimum","typeLabel":"number | null"},"range_maximum":{"oneOf":[{"type":"number","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.range_maximum.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.range_maximum.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.range_maximum","typeLabel":"number | null"},"comments":{"oneOf":[{"type":"string","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.comments.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2.comments","typeLabel":"string | null"}},"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results.items.[INDEX]","typeLabel":"object"},"example":[{"result_type":"quantity","name":"HDL Cholesterol","time_collected":"2023-01-14T04:30:11.222Z","result":123,"unit_of_measure":"mg/dL","range_minimum":20,"range_maximum":200,"comments":null},{"result_type":"quantity","name":"Vitamin B12","time_collected":"2023-01-14T04:30:11.222Z","result":"\u003c10","unit_of_measure":"pg/mL","range_minimum":20,"range_maximum":200,"comments":null},{"result_type":"reactivity","name":"Chlamydia","time_collected":"2023-01-14T04:30:11.222Z","result":"negative","unit_of_measure":null,"range_minimum":null,"range_maximum":null,"comments":null},{"result_type":"genotype","name":"rs1234567","time_collected":"2023-01-14T04:30:11.222Z","result":"TT","unit_of_measure":null,"range_minimum":null,"range_maximum":null,"comments":null}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.results","typeLabel":"object[]"},"pdf":{"oneOf":[{"type":"string","format":"url","description":"A URL to the PDF report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.pdf.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","description":"A URL to the PDF report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.pdf.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.pdf","typeLabel":"string\u003curl> | null"},"txt":{"oneOf":[{"type":"string","format":"url","description":"A URL to the TXT report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.txt.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","description":"A URL to the TXT report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.txt.oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.txt","typeLabel":"string\u003curl> | null"},"date_collected":{"type":"string","format":"date-time","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.date_collected","typeLabel":"string\u003cdate-time>"},"date_received":{"type":"string","format":"date-time","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.date_received","typeLabel":"string\u003cdate-time>"},"date_resulted":{"type":"string","format":"date-time","uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.date_resulted","typeLabel":"string\u003cdate-time>"},"is_amendment":{"type":"boolean","description":"Whether this report is an amendment to a previous report.","example":false,"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0.is_amendment","typeLabel":"boolean"}},"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"null","properties":{"report_id":{"type":"string"},"results":{"description":"","type":"array","items":{"oneOf":[{"type":"object","properties":{"result_type":{"type":"string","enum":["quantity"]},"name":{"type":"string","description":"The biomarker that was analyzed."},"time_collected":{"type":"string","format":"date-time"},"result":{"oneOf":[{"type":"string","description":""},{"type":"number","description":""}]},"unit_of_measure":{"oneOf":[{"type":"string"},{"type":"null"}]},"range_minimum":{"type":"string","minimum":0},"range_maximum":{"type":"number","minimum":0},"comments":{"oneOf":[{"type":"string"},{"type":"null"}]}}},{"type":"object","properties":{"result_type":{"type":"string","enum":["reactivity"]},"name":{"type":"string","description":"The biomarker that was analyzed."},"time_collected":{"type":"string","format":"date-time"},"result":{"description":"","type":"string","enum":["positive","negative"]},"unit_of_measure":{"oneOf":[{"type":"string"},{"type":"null"}]},"range_minimum":{"oneOf":[{"type":"number"},{"type":"null"}]},"range_maximum":{"oneOf":[{"type":"number"},{"type":"null"}]},"comments":{"oneOf":[{"type":"string"},{"type":"null"}]}}},{"type":"object","properties":{"result_type":{"type":"string","enum":["genotype"]},"name":{"type":"string","description":"The biomarker that was analyzed."},"time_collected":{"type":"string","format":"date-time"},"result":{"description":"","type":"string","enum":["TT","GG","CG","AG","CT","CC","AA","AT","AC","TA","TG","TC","GA","GT","GC","CA"]},"unit_of_measure":{"oneOf":[{"type":"string"},{"type":"null"}]},"range_minimum":{"oneOf":[{"type":"number"},{"type":"null"}]},"range_maximum":{"oneOf":[{"type":"number"},{"type":"null"}]},"comments":{"oneOf":[{"type":"string"},{"type":"null"}]}}}]},"example":[{"result_type":"quantity","name":"HDL Cholesterol","time_collected":"2023-01-14T04:30:11.222Z","result":123,"unit_of_measure":"mg/dL","range_minimum":20,"range_maximum":200,"comments":null},{"result_type":"quantity","name":"Vitamin B12","time_collected":"2023-01-14T04:30:11.222Z","result":"\u003c10","unit_of_measure":"pg/mL","range_minimum":20,"range_maximum":200,"comments":null},{"result_type":"reactivity","name":"Chlamydia","time_collected":"2023-01-14T04:30:11.222Z","result":"negative","unit_of_measure":null,"range_minimum":null,"range_maximum":null,"comments":null},{"result_type":"genotype","name":"rs1234567","time_collected":"2023-01-14T04:30:11.222Z","result":"TT","unit_of_measure":null,"range_minimum":null,"range_maximum":null,"comments":null}]},"pdf":{"oneOf":[{"type":"string","format":"url","description":"A URL to the PDF report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf"},{"type":"null","format":"url","description":"A URL to the PDF report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf"}]},"txt":{"oneOf":[{"type":"string","format":"url","description":"A URL to the TXT report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"},{"type":"null","format":"url","description":"A URL to the TXT report.","example":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"}]},"date_collected":{"type":"string","format":"date-time"},"date_received":{"type":"string","format":"date-time"},"date_resulted":{"type":"string","format":"date-time"},"is_amendment":{"type":"boolean","description":"Whether this report is an amendment to a previous report.","example":false}},"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"kits.items.[INDEX].sample.reports.items.[INDEX]","typeLabel":"object | null"},"uniqueKey":"kits.items.[INDEX].sample.reports","typeLabel":"(object | null)[]"}},"uniqueKey":"kits.items.[INDEX].sample","typeLabel":"object"}},"uniqueKey":"kits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"kits","typeLabel":"object[]"},"created":{"type":"string","format":"date-time","description":"The date and time the order was created.","example":"2023-01-01T04:30:11.222Z","uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"updated":{"type":"string","format":"date-time","description":"The date and time the order was last updated.","example":"2023-01-01T04:30:11.222Z","uniqueKey":"updated","typeLabel":"string\u003cdate-time>"},"metadata":{"oneOf":[{"type":"object","description":"An optional dictionary of key-value pairs stored with the order.","example":null,"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"An optional dictionary of key-value pairs stored with the order.","example":null,"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"order_id":"O1234567","status":"pending","recipient":{"first_name":"Alice","last_name":"Smith","email":"alice123@gmail.com","phone":"1234567890","address":{"street1":"123 Main St","city":"San Francisco","state":"CA","country":"US","zip":"94105","street2":"Apt 1"}},"kit_types":["health_kit_1"],"kits":[{"kit_id":"SPOT123456","type":"health_kit_1","status":"preparing","events":[{"status":"preparing","created":"2023-01-01T04:30:11.222Z"},{"status":"in_transit","created":"2023-01-05T04:30:11.222Z"},{"status":"delivered","created":"2023-01-06T04:30:11.222Z"},{"status":"registered","created":"2023-01-07T04:30:11.222Z"}],"shipment_to_customer":{"tracking_number":"9400123456789999876500","carrier":"usps","created":"2023-01-01T04:30:11.222Z"},"registered_to":{"patient_id":"7563e8e2-7fbd-480c-9b8b-2070eda884bf","first_name":"Alice","last_name":"Smith","date_of_birth":"1990-01-01","sex":"F","email":"alice123@gmail.com","phone":"1234567890"},"sample":{"sample_id":"SPOT654321","status":"awaiting_collection","events":[{"status":"awaiting_collection","created":"2023-01-01T04:30:11.222Z"},{"status":"in_transit","created":"2023-01-10T04:30:11.222Z"},{"status":"delivered","created":"2023-01-11T04:30:11.222Z"},{"status":"received","created":"2023-01-12T04:30:11.222Z"},{"status":"resulted","created":"2023-01-13T04:30:11.222Z"}],"type":"adx100","shipments":[{"tracking_number":"9400123456789999876500","carrier":"usps","created":"2023-01-01T04:30:11.222Z"}],"panels":["PANEL-123"],"reports":[{"report_id":"\u003cstring>","results":[{"result_type":"quantity","name":"HDL Cholesterol","time_collected":"2023-01-14T04:30:11.222Z","result":123,"unit_of_measure":"mg/dL","range_minimum":20,"range_maximum":200,"comments":null},{"result_type":"quantity","name":"Vitamin B12","time_collected":"2023-01-14T04:30:11.222Z","result":"\u003c10","unit_of_measure":"pg/mL","range_minimum":20,"range_maximum":200,"comments":null},{"result_type":"reactivity","name":"Chlamydia","time_collected":"2023-01-14T04:30:11.222Z","result":"negative","unit_of_measure":null,"range_minimum":null,"range_maximum":null,"comments":null},{"result_type":"genotype","name":"rs1234567","time_collected":"2023-01-14T04:30:11.222Z","result":"TT","unit_of_measure":null,"range_minimum":null,"range_maximum":null,"comments":null}],"pdf":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf","txt":"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt","date_collected":"2023-11-07T05:31:56Z","date_received":"2023-11-07T05:31:56Z","date_resulted":"2023-11-07T05:31:56Z","is_amendment":false}]}}],"created":"2023-01-01T04:30:11.222Z","updated":"2023-01-01T04:30:11.222Z","metadata":null}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"6a95a122-96e4-4769-82c7-157209276a9c":{"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"status":{"type":"number","example":400,"enum":[400,401,403,404,500],"uniqueKey":"error.status","typeLabel":"enum\u003cnumber>"},"type":{"type":"string","example":"bad_request","enum":["bad_request","not_found","unauthorized","forbidden","rate_limit_exceeded","internal_server_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"detail":{"type":"string","example":"The first_name field is required","uniqueKey":"error.detail","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":400,"type":"bad_request","detail":"The first_name field is required"}}}},"exampleType":"generated"}},"description":"Bad request","exampleType":"generated"},"6bf67580-a7dc-4b00-b402-c95fc22390f2":{"description":"Order not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"status":{"type":"number","example":404,"enum":[400,401,403,404,500],"uniqueKey":"error.status","typeLabel":"enum\u003cnumber>"},"type":{"type":"string","example":"forbidden","enum":["bad_request","not_found","unauthorized","forbidden","rate_limit_exceeded","internal_server_error"],"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"detail":{"type":"string","example":"Kit id SPOTZZZZZZ not found","uniqueKey":"error.detail","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"status":404,"type":"forbidden","detail":"Kit id SPOTZZZZZZ not found"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0f1cc015-a159-4c7b-995b-c54ead99ae86":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\"","scopes":[]}}},"servers":{"136bb80f-2e5e-442d-9083-64ebaa0c8fbb":{"url":"https://app.spotdx.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\"","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Token-based authentication with required prefix \"Token\"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"tokenAuth","name":"Authorization"}],"title":"tokenAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"spot","siteName":"Spot","title":"Update order metadata - Spot","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:45:24.272Z","originalFileLocation":"reference/update-order-metadata.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=\"Replace the metadata for an order with a new set of values\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spot\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spot/i35owai1mOdoGnQM/_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/spot/i35owai1mOdoGnQM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spot/i35owai1mOdoGnQM/_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/spot/i35owai1mOdoGnQM/_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/spot/i35owai1mOdoGnQM/_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/spot/i35owai1mOdoGnQM/_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/spot/i35owai1mOdoGnQM/_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/spot/i35owai1mOdoGnQM/_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/spot/i35owai1mOdoGnQM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update order metadata - Spot\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replace the metadata for an order with a new set of values\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spot\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spotdx.com/reference/update-order-metadata\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spot.mintlify.app/_mintlify/api/og/v2?division=API+Reference+-+Orders\u0026amp;title=Update+order+metadata\u0026amp;description=Replace+the+metadata+for+an+order+with+a+new+set+of+values\u0026amp;theme=44dad369af3402d43d93674c\u0026amp;signature=ddfe60da2b63fa089d083924c45c3e6e5d8addcb76fbfe7b4cdfadccce3237c9\">\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=\"Update order metadata - Spot\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replace the metadata for an order with a new set of values\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spot.mintlify.app/_mintlify/api/og/v2?division=API+Reference+-+Orders\u0026amp;title=Update+order+metadata\u0026amp;description=Replace+the+metadata+for+an+order+with+a+new+set+of+values\u0026amp;theme=44dad369af3402d43d93674c\u0026amp;signature=ddfe60da2b63fa089d083924c45c3e6e5d8addcb76fbfe7b4cdfadccce3237c9\">\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/spot/i35owai1mOdoGnQM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spot\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7E63F8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spotdx.com/reference/update-order-metadata\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/update-order-metadata.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spotdx.com/#organization\",\"name\":\"Spot\",\"url\":\"https://docs.spotdx.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spot/5oSV-2vR4214gDZI/logo.svg?fit=max\u0026auto=format\u0026n=5oSV-2vR4214gDZI\u0026q=85\u0026s=c3babda7ad42176c58dfe4ea2137cd7c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spotdx.com#website\",\"name\":\"Spot\",\"url\":\"https://docs.spotdx.com\",\"publisher\":{\"@id\":\"https://docs.spotdx.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spotdx.com/reference/update-order-metadata#webpage\",\"url\":\"https://docs.spotdx.com/reference/update-order-metadata\",\"name\":\"Update order metadata\",\"description\":\"Replace the metadata for an order with a new set of values\",\"dateModified\":\"2026-01-06T22:45:24.272Z\",\"isPartOf\":{\"@id\":\"https://docs.spotdx.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spotdx.com/reference/update-order-metadata#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spotdx.com/reference/update-order-metadata#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference - Orders\",\"item\":\"https://docs.spotdx.com/reference/create-order\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update order metadata\",\"item\":\"https://docs.spotdx.com/reference/update-order-metadata\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spotdx.com/reference/update-order-metadata#apireference\",\"headline\":\"Update order metadata\",\"name\":\"Update order metadata\",\"description\":\"Replace the metadata for an order with a new set of values\",\"url\":\"https://docs.spotdx.com/reference/update-order-metadata\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spotdx.com/reference/update-order-metadata#webpage\"},\"dateModified\":\"2026-01-06T22:45:24.272Z\",\"publisher\":{\"@id\":\"https://docs.spotdx.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spotdx.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spot\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spot","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Welcome","pages":[{"title":"Introduction","href":"/docs/introduction"},{"title":"Authentication","href":"/docs/authentication"},{"title":"Errors \u0026 status codes","href":"/docs/errors"}]},{"group":"Basic Guides","pages":[{"title":"Quickstart","href":"/docs/quickstart"},{"title":"Core concepts","href":"/docs/concepts"},{"title":"Order, sample \u0026 kit lifecycles","href":"/docs/sample-kit-lifecycle"}]},{"group":"Advanced Guides","pages":[{"title":"Advanced kit workflows","href":"/docs/advanced-kit-workflows"},{"title":"Using requisitions","href":"/docs/requisitions"}]},{"group":"Integrations","pages":[{"title":"Ecommerce Integrations","href":"/docs/integrations"}]},{"group":"API Reference - Orders","pages":[{"title":"Create order","openapi":"POST /api/v2/orders/","href":"/reference/create-order"},{"title":"List orders","openapi":"GET /api/v2/orders/","href":"/reference/list-orders"},{"title":"Get order by ID","openapi":"GET /api/v2/orders/{public_id}/","description":"Retrieve a singular order matching the provided ID.","href":"/reference/get-order"},{"title":"Update order metadata","openapi":"POST /api/v2/orders/{public_id}/","href":"/reference/update-order-metadata"}]},{"group":"API Reference - Kits","pages":[{"title":"List kits","openapi":"GET /api/v2/kits/","description":"Query your kits and return a summary, sorted by creation date. Providing any query params will further filter the results to only those that match the query params.","href":"/reference/list-kits"},{"title":"Get kit by ID","openapi":"GET /api/v2/kits/{public_id}/","href":"/reference/get-kit"}]},{"group":"API Reference - Requisitions","pages":[{"title":"Create requisition","openapi":"POST /api/v2/requisitions/","href":"/reference/create-requisition"},{"title":"List requisitions","openapi":"GET /api/v2/requisitions/","href":"/reference/list-requisitions"},{"title":"Get requisition","openapi":"GET /api/v2/requisitions/{id}","href":"/reference/get-requisition"}]},{"group":"API Reference - Registration","pages":[{"title":"Create patient","openapi":"POST /api/v2/patients/","href":"/reference/create-patient"},{"title":"Generate registration token","openapi":"POST /api/v2/tokens/patient_registration/","href":"/reference/generate-registration-token"}]}]},{"anchor":"Get in Touch","href":"https://calendly.com/jajack/30minutes","icon":"phone"},{"anchor":"Contact Us","href":"mailto:hello@spotkits.com","icon":"envelope"}]},"title":"Update order metadata - Spot","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}