Prefix the value with "ApiKey" to indicate the custom authorization type
Path Parameters
orderId
string<uuid>
required
Response
The requested order
id
string<uuid>
required
Order's ID
Example:
"123E4567-E89B-12D3-A456-426614174000"
status
enum<string>
required
Order's status
Available options:
AWAITING_APPROVAL,
ORDERED,
PROCESSING,
ORDERED_NOT_SHIPPED,
SHIPPED,
COMPLETED,
PARTIALLY_SHIPPED,
DECLINED,
AWAITING_DELIVERY_SCHEDULING,
DELIVERY_SCHEDULED,
DELIVERED,
ACTIVATED,
NONE,
APPROVED,
AWAITING_FULFILLMENT,
ACTION_REQUIRED,
PENDING,
RETURN_KIT_SENT,
RETURN_KIT_DELIVERED,
RETURN_KIT_SENT_BACK,
RECEIVED_IN_WAREHOUSE,
RETURNED,
NOT_RETURNED,
OUT_FOR_DELIVERY,
DELIVERY_EXCEPTION,
SUBMITTED,
CANCELLED,
CONFIRMED,
NOT_COMPLETED,
PARTIALLY_COMPLETED
Example:
"COMPLETED"
orderItems
object[]
required
All order item rows on the order, including lines in terminal states such as CANCELLED. Replacing products via PATCH cancels superseded rows rather than deleting them, so consumers should filter by each item's status when they care only about active lines.
Show child attributes
statusHistory
object[]
required
Chronological history of status changes
Show child attributes
orderType
enum<string>
required
Type of order based on lifecycle context
Available options:
ONE_OFF,
ONBOARDING,
REPLACEMENT
personId
string<uuid>
The ID of the Person
Example:
"d7d0d906-425f-402f-bde1-39031c67c40b"
officeId
string<uuid>
The ID of the Office
Example:
"d7d0d906-425f-402f-bde1-39031c67c40b"
shippingAddress
null
Order item's shipping address
submittedBy
string
Name of the person who submitted the order
Example:
"John S. (Firstbase)"
approvedBy
string
Name of the person who approved the order
Example:
"Jane Smith"
approvedAt
string<date>
Date when the order was approved
Example:
"2026-02-26"
deliverToOffice
object
Office to which the order is delivered, when different from the assigned office
Show child attributes
deliverToPerson
object
Person to whom the order is delivered, when different from the assigned person
Show child attributes
createdAt
string<date-time> | null
UTC ISO-8601 timestamp when the order was created.
Example:
"2026-02-26T14:15:22.123Z"
updatedAt
string<date-time> | null
UTC ISO-8601 timestamp when the order was last updated.
Example:
"2026-03-15T09:00:00.000Z"
expectedBy
string<date> | null
Date by which the order is expected to be delivered (calendar date, no time component).
Example:
"2026-03-10"
packageSlug
string | null
Slug of the product package this order was created from, if any.
Example:
"engineering-onboarding"
deliveryLocation
enum<string> | null
The order's delivery location type (mirrors the FE Orders 'Delivery location' column, where PERSON is shown as 'Employee'). Derived from deliverToOffice / deliverToPerson: OFFICE when deliverToOffice is set, otherwise PERSON when deliverToPerson is set.
Available options:
PERSON,
OFFICE
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Firstbase API","description":"Integration endpoints for provisioning, inventory, orders, and people management.","colors":{"primary":"#f2555a","light":"#f2555a","dark":"#d94449"},"logo":{"light":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/light.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=e22f02de6760918dfb83ad51b00a4dd8","dark":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/dark.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=8aa1a519222b541c81f34991b82a3990"},"favicon":"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/favicon.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=185b8a75ba7c0a1463d02bfb7faba5c7","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true},"url":"full","mdx":{"server":"https://apipub.firstbasehq.com"}},"navbar":{"links":[],"primary":{"type":"button","label":"App","href":"https://app.firstbasehq.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Getting Started","icon":"rocket","href":"/"},{"anchor":"Swagger UI","icon":"code","href":"https://apipub.firstbasehq.com/swagger-ui/index.html"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firstbase-cd088419","hasAudioNarration":false,"actualSubdomain":"firstbase-cd088419","customDomains":["developers.firstbase.com"],"gitSource":{"type":"github","owner":"appdirect","repo":"firstbase-app","deployBranch":"development","contentDirectory":"public-api-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afc966607e1f860fc0f5845","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"People","count":10},{"language":"default","tag":"Inventory","count":6},{"language":"default","tag":"Orders","count":6},{"language":"default","tag":"Packages","count":6},{"language":"default","tag":"Inventory Orders","count":5},{"language":"default","tag":"Returns","count":5},{"language":"default","tag":"Shipment Notices","count":5},{"language":"default","tag":"Catalog","count":4},{"language":"default","tag":"Inventory Levels","count":4},{"language":"default","tag":"ITAD","count":4}]},"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/orders/get-order","slug":"/api-reference/orders/get-order","pageMetadata":{"title":"Get order","description":"Returns full details for a single order belonging to the caller's organization, including order items, current status, and shipping address.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order","autogeneratedByOpenApi":true},"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: \"Returns full details for a single order belonging to the caller’s organization, including order items, current status, and shipping address.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get order","description":"Returns full details for a single order belonging to the caller's organization, including order items, current status, and shipping address.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstbase-cd088419/eb8be295fb0c99cf/test/security/dep-versions.test.js","/_mintlify/custom/firstbase-cd088419/a351a42a1eff512c/test/security/qs-dos.test.js"],"openApiReferenceData":{"operation":{"tags":["Orders"],"summary":"Get order","description":"Returns full details for a single order belonging to the caller's organization, including order items, current status, and shipping address.","operationId":"getOrderById","parameters":["235949ca-4ed4-413e-8d9a-b8ec0c313a89"],"responses":{"200":"d6e23970-eef3-4d7d-9ba5-1d451314d9c2","400":"a592e427-864e-4a89-8a4a-7bf003865793","404":"3eeac1f7-d41b-4ed3-858a-be41adbacbd3","409":"1d62f960-ad8d-427b-b340-967782d34720"},"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/orders/{orderId}' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json'"}],"method":"get","type":"path","servers":["c72a91e2-ce89-42c6-8eda-72a67db3f3b0"],"security":["1e65b031-3712-4e0e-af72-36a1881b7f28"],"path":"/api/v1/orders/{orderId}","baseUrlOptions":["https://apipub.firstbasehq.com"],"title":"Get order","codeSamples":[{"label":"cURL","lang":"curl","source":"curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/orders/{orderId}' \\\n -H 'Authorization: ApiKey YOUR_API_KEY' \\\n -H 'Accept: application/json'"}],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"235949ca-4ed4-413e-8d9a-b8ec0c313a89":{"name":"orderId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"d6e23970-eef3-4d7d-9ba5-1d451314d9c2":{"description":"The requested order","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Order's ID","example":"123E4567-E89B-12D3-A456-426614174000","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Order's status","enum":["AWAITING_APPROVAL","ORDERED","PROCESSING","ORDERED_NOT_SHIPPED","SHIPPED","COMPLETED","PARTIALLY_SHIPPED","DECLINED","AWAITING_DELIVERY_SCHEDULING","DELIVERY_SCHEDULED","DELIVERED","ACTIVATED","NONE","APPROVED","AWAITING_FULFILLMENT","ACTION_REQUIRED","PENDING","RETURN_KIT_SENT","RETURN_KIT_DELIVERED","RETURN_KIT_SENT_BACK","RECEIVED_IN_WAREHOUSE","RETURNED","NOT_RETURNED","OUT_FOR_DELIVERY","DELIVERY_EXCEPTION","SUBMITTED","CANCELLED","CONFIRMED","NOT_COMPLETED","PARTIALLY_COMPLETED"],"example":"COMPLETED","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"orderItems":{"type":"array","description":"All order item rows on the order, including lines in terminal states such as CANCELLED. Replacing products via PATCH cancels superseded rows rather than deleting them, so consumers should filter by each item's `status` when they care only about active lines.","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Order item's ID","example":"123E4567-E89B-12D3-A456-426614174000","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"skuId":{"type":"string","format":"uuid","description":"SKU ID","example":"123E4567-E89B-12D3-A456-426614174000","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].skuId","typeLabel":"string\u003cuuid>"},"title":{"type":"string","description":"Product title","example":"iPad Air - Silver, 64GB, WiFi","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].title","typeLabel":"string"},"categoryCode":{"type":"string","description":"Product category code","example":"COMPUTER","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].categoryCode","typeLabel":"string"},"status":{"type":"string","description":"Order item's status","enum":["AWAITING_APPROVAL","ORDERED","PROCESSING","ORDERED_NOT_SHIPPED","SHIPPED","COMPLETED","PARTIALLY_SHIPPED","DECLINED","AWAITING_DELIVERY_SCHEDULING","DELIVERY_SCHEDULED","DELIVERED","ACTIVATED","NONE","APPROVED","AWAITING_FULFILLMENT","ACTION_REQUIRED","PENDING","RETURN_KIT_SENT","RETURN_KIT_DELIVERED","RETURN_KIT_SENT_BACK","RECEIVED_IN_WAREHOUSE","RETURNED","NOT_RETURNED","OUT_FOR_DELIVERY","DELIVERY_EXCEPTION","SUBMITTED","CANCELLED","CONFIRMED","NOT_COMPLETED","PARTIALLY_COMPLETED"],"example":"PROCESSING","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"statusHistory":{"type":"array","description":"Chronological history of status changes","items":{"type":"object","properties":{"status":{"type":"string","description":"Order status at time of change","enum":["AWAITING_APPROVAL","ORDERED","PROCESSING","ORDERED_NOT_SHIPPED","SHIPPED","COMPLETED","PARTIALLY_SHIPPED","DECLINED","AWAITING_DELIVERY_SCHEDULING","DELIVERY_SCHEDULED","DELIVERED","ACTIVATED","NONE","APPROVED","AWAITING_FULFILLMENT","ACTION_REQUIRED","PENDING","RETURN_KIT_SENT","RETURN_KIT_DELIVERED","RETURN_KIT_SENT_BACK","RECEIVED_IN_WAREHOUSE","RETURNED","NOT_RETURNED","OUT_FOR_DELIVERY","DELIVERY_EXCEPTION","SUBMITTED","CANCELLED","CONFIRMED","NOT_COMPLETED","PARTIALLY_COMPLETED"],"example":"APPROVED","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].statusHistory.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of status change in UTC","example":"2023-01-01T12:00:00Z","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].statusHistory.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"}},"required":["status","timestamp"],"uniqueKey":"orderItems.items.[INDEX].statusHistory.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"orderItems.items.[INDEX].statusHistory","typeLabel":"object[]"},"shipment":{"type":"object","properties":{"trackingUrl":{"oneOf":[{"type":"string","description":"The carrier's tracking URL for this shipment. Open in a browser to view live shipment status.","uniqueKey":"orderItems.items.[INDEX].shipment.trackingUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"The carrier's tracking URL for this shipment. Open in a browser to view live shipment status.","uniqueKey":"orderItems.items.[INDEX].shipment.trackingUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].shipment.trackingUrl","typeLabel":"string | null"},"trackingCode":{"type":"string","description":"Tracking code","example":"1Z00000000","uniqueKey":"orderItems.items.[INDEX].shipment.trackingCode","typeLabel":"string"},"carrier":{"type":"string","description":"The carrier name","example":"UPS","uniqueKey":"orderItems.items.[INDEX].shipment.carrier","typeLabel":"string"},"status":{"type":"string","description":"The current status of the shipment","example":"DELIVERED","uniqueKey":"orderItems.items.[INDEX].shipment.status","typeLabel":"string"},"trackingHistory":{"type":"array","description":"A history of recorded shipment status updates in order of date received","items":{"type":"object","properties":{"status":{"type":"string","description":"The status of the shipment","example":"IN_TRANSIT","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].shipment.trackingHistory.items.[INDEX].status","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp at which the event was received","isRequired":true,"uniqueKey":"orderItems.items.[INDEX].shipment.trackingHistory.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"}},"required":["status","timestamp"],"uniqueKey":"orderItems.items.[INDEX].shipment.trackingHistory.items.[INDEX]","typeLabel":"object"},"uniqueKey":"orderItems.items.[INDEX].shipment.trackingHistory","typeLabel":"object[]"}},"description":"Order item's shipment details","uniqueKey":"orderItems.items.[INDEX].shipment","typeLabel":"object"},"fulfillmentMethod":{"type":"string","description":"Fulfill-time actual fulfillment method set by operations when the line is fulfilled (WAREHOUSE or DROPSHIP). Distinct from create-time intendedFulfillmentMethod.","enum":["WAREHOUSE","DROPSHIP"],"uniqueKey":"orderItems.items.[INDEX].fulfillmentMethod","typeLabel":"enum\u003cstring>"},"vendorSku":{"oneOf":[{"type":"string","description":"Vendor's own SKU identifier. Populated only when the underlying SKU has a vendor SKU on file.","example":"APL-MK183LL/A","uniqueKey":"orderItems.items.[INDEX].vendorSku.oneOf.0","typeLabel":"string"},{"type":"null","description":"Vendor's own SKU identifier. Populated only when the underlying SKU has a vendor SKU on file.","example":"APL-MK183LL/A","uniqueKey":"orderItems.items.[INDEX].vendorSku.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].vendorSku","typeLabel":"string | null"},"vendorCode":{"oneOf":[{"type":"string","description":"Vendor code of the SKU's vendor. Populated only when the SKU's vendor is known.","example":"APPLE","uniqueKey":"orderItems.items.[INDEX].vendorCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Vendor code of the SKU's vendor. Populated only when the SKU's vendor is known.","example":"APPLE","uniqueKey":"orderItems.items.[INDEX].vendorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].vendorCode","typeLabel":"string | null"},"serialNumber":{"oneOf":[{"type":"string","description":"Serial number assigned to this order item, if any.","example":"C02XL0AAJG5L","uniqueKey":"orderItems.items.[INDEX].serialNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Serial number assigned to this order item, if any.","example":"C02XL0AAJG5L","uniqueKey":"orderItems.items.[INDEX].serialNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].serialNumber","typeLabel":"string | null"},"justification":{"oneOf":[{"type":"string","description":"Justification text recorded for this order item, if any.","example":"Need higher RAM for local development workflows","uniqueKey":"orderItems.items.[INDEX].justification.oneOf.0","typeLabel":"string"},{"type":"null","description":"Justification text recorded for this order item, if any.","example":"Need higher RAM for local development workflows","uniqueKey":"orderItems.items.[INDEX].justification.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].justification","typeLabel":"string | null"},"purchaseOrderNumber":{"oneOf":[{"type":"string","description":"Regional purchase order number stamped on this order item when applicable.","example":"PO-US-LAPTOPS-001","uniqueKey":"orderItems.items.[INDEX].purchaseOrderNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Regional purchase order number stamped on this order item when applicable.","example":"PO-US-LAPTOPS-001","uniqueKey":"orderItems.items.[INDEX].purchaseOrderNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].purchaseOrderNumber","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"Order item type (PHYSICAL or SERVICE). Top-level order products are PHYSICAL only; SERVICE warranty lines appear nested under orderedWarrantyItem. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["PHYSICAL","SERVICE"],"uniqueKey":"orderItems.items.[INDEX].type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Order item type (PHYSICAL or SERVICE). Top-level order products are PHYSICAL only; SERVICE warranty lines appear nested under orderedWarrantyItem. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["PHYSICAL","SERVICE"],"uniqueKey":"orderItems.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].type","typeLabel":"enum\u003cstring> | null"},"intendedFulfillmentMethod":{"oneOf":[{"type":"string","description":"Create-time fulfillment intent (WAREHOUSE or DROPSHIP). Distinct from fulfill-time fulfillmentMethod. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["WAREHOUSE","DROPSHIP"],"uniqueKey":"orderItems.items.[INDEX].intendedFulfillmentMethod.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Create-time fulfillment intent (WAREHOUSE or DROPSHIP). Distinct from fulfill-time fulfillmentMethod. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["WAREHOUSE","DROPSHIP"],"uniqueKey":"orderItems.items.[INDEX].intendedFulfillmentMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].intendedFulfillmentMethod","typeLabel":"enum\u003cstring> | null"},"orderedPricing":{"type":"null","description":"Sticky catalog pricing snapshot when the line was created/modified with DROPSHIP intent. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null. Warehouse lines have no sticky money. Null when the line is Firstbase Managed (vendor pricing).","properties":{"id":{"oneOf":[{"type":"string","format":"uuid","description":"Catalog pricing row id","example":"123E4567-E89B-12D3-A456-426614174000"},{"type":"null","format":"uuid","description":"Catalog pricing row id","example":"123E4567-E89B-12D3-A456-426614174000"}]},"unitPrice":{"oneOf":[{"type":"number","description":"Unit price in major currency units","example":999},{"type":"null","description":"Unit price in major currency units","example":999}]},"currencyCode":{"oneOf":[{"type":"string","description":"ISO 4217 currency code","example":"USD"},{"type":"null","description":"ISO 4217 currency code","example":"USD"}]}},"uniqueKey":"orderItems.items.[INDEX].orderedPricing","typeLabel":"null"},"discountedPrice":{"oneOf":[{"type":"number","description":"Server-computed discounted unit price in major currency units when a catalog discount applies. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null. Null when the line is Firstbase Managed (vendor pricing).","example":899,"uniqueKey":"orderItems.items.[INDEX].discountedPrice.oneOf.0","typeLabel":"number"},{"type":"null","description":"Server-computed discounted unit price in major currency units when a catalog discount applies. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null. Null when the line is Firstbase Managed (vendor pricing).","example":899,"uniqueKey":"orderItems.items.[INDEX].discountedPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].discountedPrice","typeLabel":"number | null"},"orderedWarrantyItem":{"$circularRef":"5a1d3f79-dff5-4a59-a451-a45a3110bc00","type":"null","description":"Nested SERVICE warranty order item created with the PHYSICAL line when catalog warranty pricing applied under DROPSHIP. Nested warranty has no further orderedWarrantyItem. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","uniqueKey":"orderItems.items.[INDEX].orderedWarrantyItem","typeLabel":"null"},"firstbaseManaged":{"oneOf":[{"type":"boolean","description":"True when this procurement (DROPSHIP) line was snapshotted as Firstbase Managed at create/modify. Populated when feature flag fbs-4192-firstbase-managed-regions is on; otherwise null. Warehouse lines are false when the flag is on.","uniqueKey":"orderItems.items.[INDEX].firstbaseManaged.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"True when this procurement (DROPSHIP) line was snapshotted as Firstbase Managed at create/modify. Populated when feature flag fbs-4192-firstbase-managed-regions is on; otherwise null. Warehouse lines are false when the flag is on.","uniqueKey":"orderItems.items.[INDEX].firstbaseManaged.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].firstbaseManaged","typeLabel":"boolean | null"},"productGroupId":{"oneOf":[{"type":"string","format":"uuid","description":"Product group UUID when this line was expanded from a bundle. Null for standalone SKU lines.","uniqueKey":"orderItems.items.[INDEX].productGroupId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Product group UUID when this line was expanded from a bundle. Null for standalone SKU lines.","uniqueKey":"orderItems.items.[INDEX].productGroupId.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].productGroupId","typeLabel":"string\u003cuuid> | null"},"productGroupComponentId":{"oneOf":[{"type":"string","format":"uuid","description":"Product group component UUID for this expanded bundle line. Null for standalone SKU lines.","uniqueKey":"orderItems.items.[INDEX].productGroupComponentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Product group component UUID for this expanded bundle line. Null for standalone SKU lines.","uniqueKey":"orderItems.items.[INDEX].productGroupComponentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].productGroupComponentId","typeLabel":"string\u003cuuid> | null"},"productGroupInstanceId":{"oneOf":[{"type":"string","format":"uuid","description":"Shared id grouping all SKU lines from the same bundle selection on this order.","uniqueKey":"orderItems.items.[INDEX].productGroupInstanceId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Shared id grouping all SKU lines from the same bundle selection on this order.","uniqueKey":"orderItems.items.[INDEX].productGroupInstanceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].productGroupInstanceId","typeLabel":"string\u003cuuid> | null"},"productGroupFriendlyId":{"oneOf":[{"type":"string","description":"Snapshot of the bundle friendly id (GRP-*) at order time.","example":"GRP-260914-TEST0001","uniqueKey":"orderItems.items.[INDEX].productGroupFriendlyId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Snapshot of the bundle friendly id (GRP-*) at order time.","example":"GRP-260914-TEST0001","uniqueKey":"orderItems.items.[INDEX].productGroupFriendlyId.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].productGroupFriendlyId","typeLabel":"string | null"},"productGroupName":{"oneOf":[{"type":"string","description":"Snapshot of the bundle name at order time.","example":"Laptop Bundle","uniqueKey":"orderItems.items.[INDEX].productGroupName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Snapshot of the bundle name at order time.","example":"Laptop Bundle","uniqueKey":"orderItems.items.[INDEX].productGroupName.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderItems.items.[INDEX].productGroupName","typeLabel":"string | null"}},"required":["categoryCode","id","skuId","status","statusHistory","title"],"uniqueKey":"orderItems.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"orderItems","typeLabel":"object[]"},"statusHistory":{"type":"array","description":"Chronological history of status changes","items":{"type":"object","properties":{"status":{"type":"string","description":"Order status at time of change","enum":["AWAITING_APPROVAL","ORDERED","PROCESSING","ORDERED_NOT_SHIPPED","SHIPPED","COMPLETED","PARTIALLY_SHIPPED","DECLINED","AWAITING_DELIVERY_SCHEDULING","DELIVERY_SCHEDULED","DELIVERED","ACTIVATED","NONE","APPROVED","AWAITING_FULFILLMENT","ACTION_REQUIRED","PENDING","RETURN_KIT_SENT","RETURN_KIT_DELIVERED","RETURN_KIT_SENT_BACK","RECEIVED_IN_WAREHOUSE","RETURNED","NOT_RETURNED","OUT_FOR_DELIVERY","DELIVERY_EXCEPTION","SUBMITTED","CANCELLED","CONFIRMED","NOT_COMPLETED","PARTIALLY_COMPLETED"],"example":"APPROVED","isRequired":true,"uniqueKey":"statusHistory.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of status change in UTC","example":"2023-01-01T12:00:00Z","isRequired":true,"uniqueKey":"statusHistory.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time>"}},"required":["status","timestamp"],"uniqueKey":"statusHistory.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"statusHistory","typeLabel":"object[]"},"orderType":{"type":"string","description":"Type of order based on lifecycle context","enum":["ONE_OFF","ONBOARDING","REPLACEMENT"],"isRequired":true,"uniqueKey":"orderType","typeLabel":"enum\u003cstring>"},"personId":{"type":"string","format":"uuid","description":"The ID of the Person","example":"d7d0d906-425f-402f-bde1-39031c67c40b","uniqueKey":"personId","typeLabel":"string\u003cuuid>"},"officeId":{"type":"string","format":"uuid","description":"The ID of the Office","example":"d7d0d906-425f-402f-bde1-39031c67c40b","uniqueKey":"officeId","typeLabel":"string\u003cuuid>"},"shippingAddress":{"type":"null","properties":{"addressLine1":{"type":"string","description":"Street address line 1","example":"123 Sesame Street"},"addressLine2":{"type":"string","description":"Street address line 2","example":"Suite 103"},"administrativeArea":{"type":"string","description":"State, province, or county","example":"NY"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"US"},"locality":{"type":"string","description":"City or locality","example":"New York City"},"postalCode":{"type":"string","description":"Postal code or ZIP code","example":"10123"}},"required":["countryCode"],"description":"Order item's shipping address","uniqueKey":"shippingAddress","typeLabel":"null"},"submittedBy":{"type":"string","description":"Name of the person who submitted the order","example":"John S. (Firstbase)","uniqueKey":"submittedBy","typeLabel":"string"},"approvedBy":{"type":"string","description":"Name of the person who approved the order","example":"Jane Smith","uniqueKey":"approvedBy","typeLabel":"string"},"approvedAt":{"type":"string","format":"date","description":"Date when the order was approved","example":"2026-02-26","uniqueKey":"approvedAt","typeLabel":"string\u003cdate>"},"deliverToOffice":{"type":"object","description":"Office to which the order is delivered, when different from the assigned office","properties":{"id":{"type":"string","format":"uuid","description":"Office ID","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"deliverToOffice.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Office name","example":"NYC HQ","uniqueKey":"deliverToOffice.name","typeLabel":"string"},"address":{"type":"object","properties":{"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"US","isRequired":true,"uniqueKey":"deliverToOffice.address.countryCode","typeLabel":"string"},"addressLine1":{"type":"string","description":"Street address line 1","example":"123 Sesame Street","uniqueKey":"deliverToOffice.address.addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Street address line 2","example":"Suite 103","uniqueKey":"deliverToOffice.address.addressLine2","typeLabel":"string"},"administrativeArea":{"type":"string","description":"State, province, or county","example":"NY","uniqueKey":"deliverToOffice.address.administrativeArea","typeLabel":"string"},"locality":{"type":"string","description":"City or locality","example":"New York City","uniqueKey":"deliverToOffice.address.locality","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal code or ZIP code","example":"10123","uniqueKey":"deliverToOffice.address.postalCode","typeLabel":"string"}},"required":["countryCode"],"description":"Office address","uniqueKey":"deliverToOffice.address","typeLabel":"object"}},"required":["id"],"uniqueKey":"deliverToOffice","typeLabel":"object"},"deliverToPerson":{"type":"object","description":"Person to whom the order is delivered, when different from the assigned person","properties":{"id":{"type":"string","format":"uuid","description":"Person ID","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"deliverToPerson.id","typeLabel":"string\u003cuuid>"},"firstName":{"type":"string","description":"First name","example":"Jane","isRequired":true,"uniqueKey":"deliverToPerson.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name","example":"Smith","isRequired":true,"uniqueKey":"deliverToPerson.lastName","typeLabel":"string"},"email":{"type":"string","description":"Email address","example":"jane.smith@example.com","isRequired":true,"uniqueKey":"deliverToPerson.email","typeLabel":"string"}},"required":["email","firstName","id","lastName"],"uniqueKey":"deliverToPerson","typeLabel":"object"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","description":"UTC ISO-8601 timestamp when the order was created.","example":"2026-02-26T14:15:22.123Z","uniqueKey":"createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"UTC ISO-8601 timestamp when the order was created.","example":"2026-02-26T14:15:22.123Z","uniqueKey":"createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time> | null"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","description":"UTC ISO-8601 timestamp when the order was last updated.","example":"2026-03-15T09:00:00.000Z","uniqueKey":"updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"UTC ISO-8601 timestamp when the order was last updated.","example":"2026-03-15T09:00:00.000Z","uniqueKey":"updatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time> | null"},"expectedBy":{"oneOf":[{"type":"string","format":"date","description":"Date by which the order is expected to be delivered (calendar date, no time component).","example":"2026-03-10","uniqueKey":"expectedBy.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Date by which the order is expected to be delivered (calendar date, no time component).","example":"2026-03-10","uniqueKey":"expectedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedBy","typeLabel":"string\u003cdate> | null"},"packageSlug":{"oneOf":[{"type":"string","description":"Slug of the product package this order was created from, if any.","example":"engineering-onboarding","uniqueKey":"packageSlug.oneOf.0","typeLabel":"string"},{"type":"null","description":"Slug of the product package this order was created from, if any.","example":"engineering-onboarding","uniqueKey":"packageSlug.oneOf.1","typeLabel":"null"}],"uniqueKey":"packageSlug","typeLabel":"string | null"},"deliveryLocation":{"oneOf":[{"type":"string","description":"The order's delivery location type (mirrors the FE Orders 'Delivery location' column, where PERSON is shown as 'Employee'). Derived from `deliverToOffice` / `deliverToPerson`: OFFICE when `deliverToOffice` is set, otherwise PERSON when `deliverToPerson` is set.","enum":["PERSON","OFFICE"],"uniqueKey":"deliveryLocation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The order's delivery location type (mirrors the FE Orders 'Delivery location' column, where PERSON is shown as 'Employee'). Derived from `deliverToOffice` / `deliverToPerson`: OFFICE when `deliverToOffice` is set, otherwise PERSON when `deliverToPerson` is set.","enum":["PERSON","OFFICE"],"uniqueKey":"deliveryLocation.oneOf.1","typeLabel":"null"}],"uniqueKey":"deliveryLocation","typeLabel":"enum\u003cstring> | null"}},"required":["id","orderItems","orderType","status","statusHistory"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"123E4567-E89B-12D3-A456-426614174000","status":"COMPLETED","orderItems":[{"id":"123E4567-E89B-12D3-A456-426614174000","skuId":"123E4567-E89B-12D3-A456-426614174000","title":"iPad Air - Silver, 64GB, WiFi","categoryCode":"COMPUTER","status":"PROCESSING","statusHistory":[{"status":"APPROVED","timestamp":"2023-01-01T12:00:00Z"}],"shipment":{"trackingUrl":"\u003cstring>","trackingCode":"1Z00000000","carrier":"UPS","status":"DELIVERED","trackingHistory":[{"status":"IN_TRANSIT","timestamp":"2023-11-07T05:31:56Z"}]},"fulfillmentMethod":"WAREHOUSE","vendorSku":"APL-MK183LL/A","vendorCode":"APPLE","serialNumber":"C02XL0AAJG5L","justification":"Need higher RAM for local development workflows","purchaseOrderNumber":"PO-US-LAPTOPS-001","type":"PHYSICAL","intendedFulfillmentMethod":"WAREHOUSE","orderedPricing":null,"discountedPrice":899,"orderedWarrantyItem":null,"firstbaseManaged":true,"productGroupId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productGroupComponentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productGroupInstanceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productGroupFriendlyId":"GRP-260914-TEST0001","productGroupName":"Laptop Bundle"}],"statusHistory":[{"status":"APPROVED","timestamp":"2023-01-01T12:00:00Z"}],"orderType":"ONE_OFF","personId":"d7d0d906-425f-402f-bde1-39031c67c40b","officeId":"d7d0d906-425f-402f-bde1-39031c67c40b","shippingAddress":null,"submittedBy":"John S. (Firstbase)","approvedBy":"Jane Smith","approvedAt":"2026-02-26","deliverToOffice":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"NYC HQ","address":{"countryCode":"US","addressLine1":"123 Sesame Street","addressLine2":"Suite 103","administrativeArea":"NY","locality":"New York City","postalCode":"10123"}},"deliverToPerson":{"id":"123e4567-e89b-12d3-a456-426614174000","firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com"},"createdAt":"2026-02-26T14:15:22.123Z","updatedAt":"2026-03-15T09:00:00.000Z","expectedBy":"2026-03-10","packageSlug":"engineering-onboarding","deliveryLocation":"PERSON"}}},"exampleType":"generated"}},"exampleType":"generated"},"a592e427-864e-4a89-8a4a-7bf003865793":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3eeac1f7-d41b-4ed3-858a-be41adbacbd3":{"description":"Order not found or does not belong to the caller's organization","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1d62f960-ad8d-427b-b340-967782d34720":{"description":"Conflict","content":{"*/*":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"Human-readable description of the error","example":"Invalid request","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"string","description":"Entity or field path that caused the error (for example order, shipmentNotice, or person:email)","example":"request","isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string"}},"required":["detail","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"List of error details.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"detail":"Invalid request","source":"request"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1e65b031-3712-4e0e-af72-36a1881b7f28":{"ApiKey":{"type":"apiKey","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","name":"Authorization","in":"header","scopes":[],"schemeName":"ApiKey"}}},"servers":{"c72a91e2-ce89-42c6-8eda-72a67db3f3b0":{"url":"https://apipub.firstbasehq.com","description":"Production"}},"schemas":{"5a1d3f79-dff5-4a59-a451-a45a3110bc00":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Order item's ID","example":"123E4567-E89B-12D3-A456-426614174000","isRequired":true},"skuId":{"type":"string","format":"uuid","description":"SKU ID","example":"123E4567-E89B-12D3-A456-426614174000","isRequired":true},"title":{"type":"string","description":"Product title","example":"iPad Air - Silver, 64GB, WiFi","isRequired":true},"categoryCode":{"type":"string","description":"Product category code","example":"COMPUTER","isRequired":true},"status":{"type":"string","description":"Order item's status","enum":["AWAITING_APPROVAL","ORDERED","PROCESSING","ORDERED_NOT_SHIPPED","SHIPPED","COMPLETED","PARTIALLY_SHIPPED","DECLINED","AWAITING_DELIVERY_SCHEDULING","DELIVERY_SCHEDULED","DELIVERED","ACTIVATED","NONE","APPROVED","AWAITING_FULFILLMENT","ACTION_REQUIRED","PENDING","RETURN_KIT_SENT","RETURN_KIT_DELIVERED","RETURN_KIT_SENT_BACK","RECEIVED_IN_WAREHOUSE","RETURNED","NOT_RETURNED","OUT_FOR_DELIVERY","DELIVERY_EXCEPTION","SUBMITTED","CANCELLED","CONFIRMED","NOT_COMPLETED","PARTIALLY_COMPLETED"],"example":"PROCESSING","isRequired":true},"statusHistory":{"type":"array","description":"Chronological history of status changes","items":{"type":"object","properties":{"status":{"type":"string","description":"Order status at time of change","enum":["AWAITING_APPROVAL","ORDERED","PROCESSING","ORDERED_NOT_SHIPPED","SHIPPED","COMPLETED","PARTIALLY_SHIPPED","DECLINED","AWAITING_DELIVERY_SCHEDULING","DELIVERY_SCHEDULED","DELIVERED","ACTIVATED","NONE","APPROVED","AWAITING_FULFILLMENT","ACTION_REQUIRED","PENDING","RETURN_KIT_SENT","RETURN_KIT_DELIVERED","RETURN_KIT_SENT_BACK","RECEIVED_IN_WAREHOUSE","RETURNED","NOT_RETURNED","OUT_FOR_DELIVERY","DELIVERY_EXCEPTION","SUBMITTED","CANCELLED","CONFIRMED","NOT_COMPLETED","PARTIALLY_COMPLETED"],"example":"APPROVED","isRequired":true},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of status change in UTC","example":"2023-01-01T12:00:00Z","isRequired":true}},"required":["status","timestamp"]},"isRequired":true},"shipment":{"type":"object","properties":{"trackingUrl":{"oneOf":[{"type":"string","description":"The carrier's tracking URL for this shipment. Open in a browser to view live shipment status."},{"type":"null","description":"The carrier's tracking URL for this shipment. Open in a browser to view live shipment status."}]},"trackingCode":{"type":"string","description":"Tracking code","example":"1Z00000000"},"carrier":{"type":"string","description":"The carrier name","example":"UPS"},"status":{"type":"string","description":"The current status of the shipment","example":"DELIVERED"},"trackingHistory":{"type":"array","description":"A history of recorded shipment status updates in order of date received","items":{"type":"object","properties":{"status":{"type":"string","description":"The status of the shipment","example":"IN_TRANSIT","isRequired":true},"timestamp":{"type":"string","format":"date-time","description":"Timestamp at which the event was received","isRequired":true}},"required":["status","timestamp"]}}},"description":"Order item's shipment details"},"fulfillmentMethod":{"type":"string","description":"Fulfill-time actual fulfillment method set by operations when the line is fulfilled (WAREHOUSE or DROPSHIP). Distinct from create-time intendedFulfillmentMethod.","enum":["WAREHOUSE","DROPSHIP"]},"vendorSku":{"oneOf":[{"type":"string","description":"Vendor's own SKU identifier. Populated only when the underlying SKU has a vendor SKU on file.","example":"APL-MK183LL/A"},{"type":"null","description":"Vendor's own SKU identifier. Populated only when the underlying SKU has a vendor SKU on file.","example":"APL-MK183LL/A"}]},"vendorCode":{"oneOf":[{"type":"string","description":"Vendor code of the SKU's vendor. Populated only when the SKU's vendor is known.","example":"APPLE"},{"type":"null","description":"Vendor code of the SKU's vendor. Populated only when the SKU's vendor is known.","example":"APPLE"}]},"serialNumber":{"oneOf":[{"type":"string","description":"Serial number assigned to this order item, if any.","example":"C02XL0AAJG5L"},{"type":"null","description":"Serial number assigned to this order item, if any.","example":"C02XL0AAJG5L"}]},"justification":{"oneOf":[{"type":"string","description":"Justification text recorded for this order item, if any.","example":"Need higher RAM for local development workflows"},{"type":"null","description":"Justification text recorded for this order item, if any.","example":"Need higher RAM for local development workflows"}]},"purchaseOrderNumber":{"oneOf":[{"type":"string","description":"Regional purchase order number stamped on this order item when applicable.","example":"PO-US-LAPTOPS-001"},{"type":"null","description":"Regional purchase order number stamped on this order item when applicable.","example":"PO-US-LAPTOPS-001"}]},"type":{"oneOf":[{"type":"string","description":"Order item type (PHYSICAL or SERVICE). Top-level order products are PHYSICAL only; SERVICE warranty lines appear nested under orderedWarrantyItem. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["PHYSICAL","SERVICE"]},{"type":"null","description":"Order item type (PHYSICAL or SERVICE). Top-level order products are PHYSICAL only; SERVICE warranty lines appear nested under orderedWarrantyItem. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["PHYSICAL","SERVICE"]}]},"intendedFulfillmentMethod":{"oneOf":[{"type":"string","description":"Create-time fulfillment intent (WAREHOUSE or DROPSHIP). Distinct from fulfill-time fulfillmentMethod. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["WAREHOUSE","DROPSHIP"]},{"type":"null","description":"Create-time fulfillment intent (WAREHOUSE or DROPSHIP). Distinct from fulfill-time fulfillmentMethod. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null.","enum":["WAREHOUSE","DROPSHIP"]}]},"orderedPricing":{"type":"null","description":"Sticky catalog pricing snapshot when the line was created/modified with DROPSHIP intent. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null. Warehouse lines have no sticky money. Null when the line is Firstbase Managed (vendor pricing).","properties":{"id":{"oneOf":[{"type":"string","description":"Catalog pricing row id","format":"uuid","example":"123E4567-E89B-12D3-A456-426614174000"},{"type":"null","description":"Catalog pricing row id","format":"uuid","example":"123E4567-E89B-12D3-A456-426614174000"}]},"unitPrice":{"oneOf":[{"type":"number","description":"Unit price in major currency units","example":999},{"type":"null","description":"Unit price in major currency units","example":999}]},"currencyCode":{"oneOf":[{"type":"string","description":"ISO 4217 currency code","example":"USD"},{"type":"null","description":"ISO 4217 currency code","example":"USD"}]}}},"discountedPrice":{"oneOf":[{"type":"number","description":"Server-computed discounted unit price in major currency units when a catalog discount applies. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null. Null when the line is Firstbase Managed (vendor pricing).","example":899},{"type":"null","description":"Server-computed discounted unit price in major currency units when a catalog discount applies. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null. Null when the line is Firstbase Managed (vendor pricing).","example":899}]},"orderedWarrantyItem":{"$circularRef":"5a1d3f79-dff5-4a59-a451-a45a3110bc00","type":"null","description":"Nested SERVICE warranty order item created with the PHYSICAL line when catalog warranty pricing applied under DROPSHIP. Nested warranty has no further orderedWarrantyItem. Populated when feature flag fbs-4375-one-off-fulfillment-source is on; otherwise null."},"firstbaseManaged":{"oneOf":[{"type":"boolean","description":"True when this procurement (DROPSHIP) line was snapshotted as Firstbase Managed at create/modify. Populated when feature flag fbs-4192-firstbase-managed-regions is on; otherwise null. Warehouse lines are false when the flag is on."},{"type":"null","description":"True when this procurement (DROPSHIP) line was snapshotted as Firstbase Managed at create/modify. Populated when feature flag fbs-4192-firstbase-managed-regions is on; otherwise null. Warehouse lines are false when the flag is on."}]},"productGroupId":{"oneOf":[{"type":"string","description":"Product group UUID when this line was expanded from a bundle. Null for standalone SKU lines.","format":"uuid"},{"type":"null","description":"Product group UUID when this line was expanded from a bundle. Null for standalone SKU lines.","format":"uuid"}]},"productGroupComponentId":{"oneOf":[{"type":"string","description":"Product group component UUID for this expanded bundle line. Null for standalone SKU lines.","format":"uuid"},{"type":"null","description":"Product group component UUID for this expanded bundle line. Null for standalone SKU lines.","format":"uuid"}]},"productGroupInstanceId":{"oneOf":[{"type":"string","description":"Shared id grouping all SKU lines from the same bundle selection on this order.","format":"uuid"},{"type":"null","description":"Shared id grouping all SKU lines from the same bundle selection on this order.","format":"uuid"}]},"productGroupFriendlyId":{"oneOf":[{"type":"string","description":"Snapshot of the bundle friendly id (GRP-*) at order time.","example":"GRP-260914-TEST0001"},{"type":"null","description":"Snapshot of the bundle friendly id (GRP-*) at order time.","example":"GRP-260914-TEST0001"}]},"productGroupName":{"oneOf":[{"type":"string","description":"Snapshot of the bundle name at order time.","example":"Laptop Bundle"},{"type":"null","description":"Snapshot of the bundle name at order time.","example":"Laptop Bundle"}]}},"required":["categoryCode","id","skuId","status","statusHistory","title"]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","name":"Authorization","in":"header","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Authorization","type":"string","description":"Prefix the value with \"ApiKey\" to indicate the custom authorization type","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"firstbase-cd088419","siteName":"Firstbase API","title":"Get order - Firstbase API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T16:37:06.860Z","originalFileLocation":"api-reference/orders/get-order.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns full details for a single order belonging to the caller\u0026#x27;s organization, including order items, current status, and shipping address.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Firstbase 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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstbase-cd088419/TSOPyyp2sdxeuMY7/_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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get order - Firstbase API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns full details for a single order belonging to the caller\u0026#x27;s organization, including order items, current status, and shipping address.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Firstbase API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.firstbase.com/api-reference/orders/get-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstbase-cd088419.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Get+order\u0026amp;description=Returns+full+details+for+a+single+order+belonging+to+the+caller%27s+organization%2C+including+order+items%2C+current+status%2C+and+shipping+address.\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=b0d147b2f0209fb1637b7cde072dc7969eaa31fd745e9782aab4d4a7360118f9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get order - Firstbase API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns full details for a single order belonging to the caller\u0026#x27;s organization, including order items, current status, and shipping address.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstbase-cd088419.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Get+order\u0026amp;description=Returns+full+details+for+a+single+order+belonging+to+the+caller%27s+organization%2C+including+order+items%2C+current+status%2C+and+shipping+address.\u0026amp;theme=bfdcc2e7405570affd55a598\u0026amp;signature=b0d147b2f0209fb1637b7cde072dc7969eaa31fd745e9782aab4d4a7360118f9\">\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/firstbase-cd088419/TSOPyyp2sdxeuMY7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Firstbase API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f2555a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.firstbase.com/api-reference/orders/get-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/get-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.firstbase.com/#organization\",\"name\":\"Firstbase API\",\"url\":\"https://developers.firstbase.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firstbase-cd088419/DDV5t2EOeCNU8R4K/logo/light.svg?fit=max\u0026auto=format\u0026n=DDV5t2EOeCNU8R4K\u0026q=85\u0026s=e22f02de6760918dfb83ad51b00a4dd8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.firstbase.com#website\",\"name\":\"Firstbase API\",\"url\":\"https://developers.firstbase.com\",\"publisher\":{\"@id\":\"https://developers.firstbase.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.firstbase.com/api-reference/orders/get-order#webpage\",\"url\":\"https://developers.firstbase.com/api-reference/orders/get-order\",\"name\":\"Get order\",\"description\":\"Returns full details for a single order belonging to the caller's organization, including order items, current status, and shipping address.\",\"dateModified\":\"2026-11-13T16:37:06.860Z\",\"isPartOf\":{\"@id\":\"https://developers.firstbase.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.firstbase.com/api-reference/orders/get-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.firstbase.com/api-reference/orders/get-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orders\",\"item\":\"https://developers.firstbase.com/api-reference/orders/decline-an-order-awaiting-approval\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get order\",\"item\":\"https://developers.firstbase.com/api-reference/orders/get-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.firstbase.com/api-reference/orders/get-order#apireference\",\"headline\":\"Get order\",\"name\":\"Get order\",\"description\":\"Returns full details for a single order belonging to the caller's organization, including order items, current status, and shipping address.\",\"url\":\"https://developers.firstbase.com/api-reference/orders/get-order\",\"mainEntityOfPage\":{\"@id\":\"https://developers.firstbase.com/api-reference/orders/get-order#webpage\"},\"dateModified\":\"2026-11-13T16:37:06.860Z\",\"publisher\":{\"@id\":\"https://developers.firstbase.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.firstbase.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Firstbase API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Firstbase API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/orders/get-order.md","siteName":"Firstbase API","nav":{"global":{"anchors":[{"anchor":"Getting Started","icon":"rocket","href":"/"},{"anchor":"Swagger UI","icon":"code","href":"https://apipub.firstbasehq.com/swagger-ui/index.html"}]},"groups":[{"group":"Guides","pages":[{"title":"Rate limits","href":"/rate-limits"}]},{"group":"Catalog","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/categories","href":"/api-reference/catalog/list-categories"},{"title":"Get SKU","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/skus/{skuId}","href":"/api-reference/catalog/get-sku"},{"title":"List SKUs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/skus","href":"/api-reference/catalog/list-skus"},{"title":"List brands","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/brands","href":"/api-reference/catalog/list-brands"}]},{"group":"Inventory","pages":[{"title":"Add tags","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory/{inventoryId}/tags","href":"/api-reference/inventory/add-tags"},{"title":"Create asset","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/assets","href":"/api-reference/inventory/create-asset"},{"title":"Get inventory item","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory/{inventoryId}","href":"/api-reference/inventory/get-inventory-item"},{"title":"Update inventory","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory/{inventoryId}","href":"/api-reference/inventory/update-inventory"},{"title":"List inventory","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory","href":"/api-reference/inventory/list-inventory"},{"title":"Remove tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory/{inventoryId}/tags/{tagId}","href":"/api-reference/inventory/remove-tag"}]},{"group":"Inventory Levels","pages":[{"title":"List inventory levels","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-levels","href":"/api-reference/inventory-levels/list-inventory-levels"},{"title":"Create inventory level","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory-levels","href":"/api-reference/inventory-levels/create-inventory-level"},{"title":"Update inventory level","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory-levels/{id}","href":"/api-reference/inventory-levels/update-inventory-level"},{"title":"Delete inventory level","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory-levels/{id}","href":"/api-reference/inventory-levels/delete-inventory-level"}]},{"group":"Inventory Orders","pages":[{"title":"List inventory orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-orders","href":"/api-reference/inventory-orders/list-inventory-orders"},{"title":"Create inventory order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory-orders","href":"/api-reference/inventory-orders/create-inventory-order"},{"title":"Modify inventory order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/inventory-orders/{inventoryOrderId}","href":"/api-reference/inventory-orders/modify-inventory-order"},{"title":"Cancel inventory order","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/inventory-orders/{inventoryOrderId}","href":"/api-reference/inventory-orders/cancel-inventory-order"},{"title":"Get inventory order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/inventory-orders/{id}","href":"/api-reference/inventory-orders/get-inventory-order"}]},{"group":"ITAD","pages":[{"title":"List ITAD requests","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/requests","href":"/api-reference/itad/list-itad-requests"},{"title":"Create ITAD requests","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/itad/requests","href":"/api-reference/itad/create-itad-requests"},{"title":"Get ITAD request","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/requests/{requestId}","href":"/api-reference/itad/get-itad-request"},{"title":"List eligible assets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/itad/eligible-assets","href":"/api-reference/itad/list-eligible-assets"}]},{"group":"New Joiners","pages":[{"title":"Send reminder","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/new-joiners/{personId}/remind","href":"/api-reference/new-joiners/send-reminder"},{"title":"Get new joiner stats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/new-joiners/stats","href":"/api-reference/new-joiners/get-new-joiner-stats"},{"title":"List new joiners","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/new-joiners","href":"/api-reference/new-joiners/list-new-joiners"}]},{"group":"Offices","pages":[{"title":"Modify office","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/offices/{officeId}","href":"/api-reference/offices/modify-office"},{"title":"Get office","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/offices/{id}","href":"/api-reference/offices/get-office"},{"title":"List offices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/offices","href":"/api-reference/offices/list-offices"}]},{"group":"Orders","pages":[{"title":"Decline an order awaiting approval","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/decline","href":"/api-reference/orders/decline-an-order-awaiting-approval"},{"title":"Approve order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/approve","href":"/api-reference/orders/approve-order"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create order","description":"Places a new order for one or more SKUs, delivered to either a person or an office. Exactly one of `personId` or `officeId` must be provided. Shipping address is auto-resolved from the recipient when not explicitly supplied. Returns the newly created order, including its ID and initial status.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders","href":"/api-reference/orders/create-order"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Modify or cancel an existing order","description":"Partially update an existing order. Allowed before fulfilment. All request body fields are optional — omit any field to leave it unchanged.\n\n**Cancel an order:** send only `{\"status\": \"CANCELLED\"}`. Works for orders in ORDERED, AWAITING_APPROVAL, or DECLINED status (not SHIPPED). This is the correct way to cancel an equipment order; there is no DELETE endpoint for `/api/v1/orders`.\n\nOther modifiable fields: products, shippingAddress, deliverToPersonId, deliverToOfficeId. Address validation workflow is unchanged by this endpoint (same as logistics modify-order: `addressValidationNeeded` is not set via PATCH). Each `products[]` line uses the same `preferredCondition` rules as create order (`skus[]`): NEW, USED, or omitted (defaults to NEW-only preference server-side). When `products` is sent, omitted existing line ids are left unchanged; cancel a line with `cancelled: true` and its `id`. New lines omit `id`. The response `orderItems` list includes cancelled rows—filter by `status` for active lines only.","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/orders/{orderId}","href":"/api-reference/orders/modify-or-cancel-an-existing-order"}]},{"group":"Packages","pages":[{"title":"Duplicate an existing package","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/packages/{slug}/duplicate","href":"/api-reference/packages/duplicate-an-existing-package"},{"title":"List packages","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/packages","href":"/api-reference/packages/list-packages"},{"title":"Create package","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/packages","href":"/api-reference/packages/create-package"},{"title":"Modify package note","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/packages/{slug}/notes/{noteId}","href":"/api-reference/packages/modify-package-note"},{"title":"Get package","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/packages/{slug}","href":"/api-reference/packages/get-package"},{"title":"Modify package","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/packages/{slug}","href":"/api-reference/packages/modify-package"}]},{"group":"People","pages":[{"title":"Get person","deprecated":null,"version":null,"openapi":"/openapi.json get /scim/v2/Users/{id}","href":"/api-reference/people/get-person"},{"title":"Replace person","deprecated":null,"version":null,"openapi":"/openapi.json put /scim/v2/Users/{id}","href":"/api-reference/people/replace-person"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/openapi.json delete /scim/v2/Users/{id}","href":"/api-reference/people/delete-user"},{"title":"List people","deprecated":null,"version":null,"openapi":"/openapi.json get /scim/v2/Users","href":"/api-reference/people/list-people"},{"title":"Create person","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Users","href":"/api-reference/people/create-person"},{"title":"Bulk upsert users","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Users/csv","href":"/api-reference/people/bulk-upsert-users"},{"title":"Bulk operations","deprecated":null,"version":null,"openapi":"/openapi.json post /scim/v2/Bulk","href":"/api-reference/people/bulk-operations"},{"title":"Reactivate person","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/reactivate","href":"/api-reference/people/reactivate-person"},{"title":"Offboard person","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/offboard","href":"/api-reference/people/offboard-person"},{"title":"Send email","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/people/{personId}/emails","href":"/api-reference/people/send-email"}]},{"group":"Regions","pages":[{"title":"List regions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/regions","href":"/api-reference/regions/list-regions"},{"title":"Get region","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/regions/{id}","href":"/api-reference/regions/get-region"}]},{"group":"Replacements","pages":[{"title":"List replacements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/replacements","href":"/api-reference/replacements/list-replacements"},{"title":"Create replacement","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/replacements","href":"/api-reference/replacements/create-replacement"},{"title":"Get replacement","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/replacements/{id}","href":"/api-reference/replacements/get-replacement"},{"title":"Cancel replacement","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/replacements/{replacementId}","href":"/api-reference/replacements/cancel-replacement"}]},{"group":"Returns","pages":[{"title":"List returns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns","href":"/api-reference/returns/list-returns"},{"title":"Create return","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/returns","href":"/api-reference/returns/create-return"},{"title":"Process return items","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/return-orders/{returnOrderId}/items","href":"/api-reference/returns/process-return-items"},{"title":"Get return","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns/{id}","href":"/api-reference/returns/get-return"},{"title":"Cancel return","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/return-orders/{returnOrderId}","href":"/api-reference/returns/cancel-return"}]},{"group":"Shipment","pages":[{"title":"Get shipment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipments","href":"/api-reference/shipment/get-shipment"},{"title":"List carriers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/carriers","href":"/api-reference/shipment/list-carriers"}]},{"group":"Shipment Notices","pages":[{"title":"List shipment notices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipment-notices","href":"/api-reference/shipment-notices/list-shipment-notices"},{"title":"Create shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/shipment-notices","href":"/api-reference/shipment-notices/create-shipment-notice"},{"title":"Modify shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/modify-shipment-notice"},{"title":"Cancel shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/shipment-notices/{shipmentNoticeId}","href":"/api-reference/shipment-notices/cancel-shipment-notice"},{"title":"Get shipment notice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/shipment-notices/{id}","href":"/api-reference/shipment-notices/get-shipment-notice"}]},{"group":"Warehouses","pages":[{"title":"List warehouses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/warehouses","href":"/api-reference/warehouses/list-warehouses"},{"title":"Get warehouse","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/warehouses/{id}","href":"/api-reference/warehouses/get-warehouse"}]}]},"basePath":"","title":"Get order - Firstbase API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}