Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Trackstar","colors":{"primary":"#7691DA","light":"#D3D665","dark":"#2E3B72"},"logo":{"light":"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/light.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=eb832f4ffc768291fd95c4939b2ac6c2","dark":"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/dark.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=1a2845225060cfe1d75c91a7240341a0"},"favicon":"https://mintcdn.com/trackstar/ronaGfFeKtERpohJ/favicon.png?fit=max\u0026auto=format\u0026n=ronaGfFeKtERpohJ\u0026q=85\u0026s=b3a24a0d7d7c7acc8e7394c0640eb8c6","api":{"openapi":"https://production.trackstarhq.com/openapi.json","mdx":{"server":"https://production.trackstarhq.com"}},"navbar":{"primary":{"type":"button","label":"Get an API Key","href":"https://www.trackstarhq.com/#"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/trackstarhq","website":"https://www.trackstarhq.com/"}},"integrations":{"clearbit":{"publicApiKey":"pk_1c5d72a7b03149b504c277cee5b4032a"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp","add-mcp","download-spec"],"display":"header"},"markdown":{"instructions":["Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP.","Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them.","Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately.","A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed.","List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z.","Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts.","To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com"]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Request an API Key","icon":"key","href":"https://trackstarhq.com/get-started"},{"anchor":"Login to Dashboard","icon":"browser","href":"https://dashboard.trackstarhq.com"},{"anchor":"WMS Integrations","icon":"warehouse","href":"https://trackstarhq.com/integrations/wms"},{"anchor":"Cart Integrations","icon":"cart-shopping","href":"https://trackstarhq.com/integrations/cart"},{"anchor":"Carrier Integrations","icon":"truck","href":"https://trackstarhq.com/integrations/carrier"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trackstar","hasAudioNarration":false,"actualSubdomain":"trackstar","customDomains":["docs.trackstarhq.com"],"gitSource":{"type":"github","owner":"trackstarhq","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4f3ab7acf49fac9da16ec","collectionId":"8357bb4d-ef58-4cad-9f49-3af74e319ee4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4f3ab7acf49fac9da16ec"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4f3ab7acf49fac9da16ec","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Guides","count":67},{"language":"default","tag":"How-To Guides","count":58},{"language":"default","tag":"WMS API","count":55},{"language":"default","tag":"WMS API Reference","count":55},{"language":"default","tag":"Webhooks","count":48},{"language":"default","tag":"WMS","count":29},{"language":"default","tag":"Admin API","count":21},{"language":"default","tag":"Admin API Reference","count":20},{"language":"default","tag":"Orders","count":17},{"language":"default","tag":"Cart API","count":16}]},"assistantConfig":{"enableStarterQuestions":true},"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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/wms-api/inbound-shipments/receive","slug":"/api-reference/wms-api/inbound-shipments/receive","pageMetadata":{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}/receive","title":"Receive Inbound Shipment","description":"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.","href":"/api-reference/wms-api/inbound-shipments/receive"},"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: \"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.\"\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":{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}/receive","title":"Receive Inbound Shipment","description":"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.","href":"/api-reference/wms-api/inbound-shipments/receive"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/trackstar/30b448b1cb413b03/required.js","/_mintlify/custom/trackstar/a23a6fd668fcabff/tab-dropdown.js","/_mintlify/custom/trackstar/bf284930523528a1/write-fields.js"],"openApiReferenceData":{"operation":{"parameters":["8dedc746-72e1-478a-a379-4518287cf8a2","e5aac81f-c41b-420b-85b6-28d21bb2f0cb","caaa2cc9-fcc2-4c7c-8072-b902190d0213","e7cbdb51-ab2a-4d64-a106-6a81c60334c6"],"responses":{"200":"bb60e818-4c2e-4ffb-b556-84ac24790ff4","404":"db1413b6-d341-4024-9b76-0e98ab5ea498","422":"5f45f8e1-41d1-4cc3-9a72-cf34365480d3"},"tags":["wms","Inbound Shipments"],"summary":"Receive Inbound Shipment","description":"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.","operationId":"put_wms_create_receipt","requestBody":"459a167c-c648-4e94-8e9d-fe3bd06a9101","method":"put","type":"path","servers":["eb5659b4-6eec-462c-991a-7da8383bb677"],"security":[],"path":"/wms/inbound-shipments/{inbound_shipment_id}/receive","baseUrlOptions":["https://production.trackstarhq.com"],"title":"Receive Inbound Shipment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8dedc746-72e1-478a-a379-4518287cf8a2":{"in":"path","name":"inbound_shipment_id","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"e5aac81f-c41b-420b-85b6-28d21bb2f0cb":{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":"\u003cx-trackstar-api-key>","isRequired":true,"description":"Your organization-level Trackstar API key.","uniqueKey":"","typeLabel":"string"},"required":true},"caaa2cc9-fcc2-4c7c-8072-b902190d0213":{"in":"header","name":"x-trackstar-access-token","description":"Your user's access token for a specific integration (ShipHero, Extensiv, etc).","schema":{"type":"string","example":"\u003cx-trackstar-access-token>","isRequired":true,"description":"Your user's access token for a specific integration (ShipHero, Extensiv, etc).","uniqueKey":"","typeLabel":"string"},"required":true},"e7cbdb51-ab2a-4d64-a106-6a81c60334c6":{"in":"header","name":"Idempotency-Key","description":"Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00","isRequired":false,"description":"Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.","uniqueKey":"","typeLabel":"string"},"required":false}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"WMS Sandbox","required":["line_items"],"properties":{"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","quantity":1}],"items":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.0.line_items.items.[INDEX].sku","typeLabel":"enum\u003cstring>"},"quantity":{"type":"integer","description":"","example":1,"isRequired":true,"uniqueKey":"oneOf.0.line_items.items.[INDEX].quantity","typeLabel":"integer"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateReceiptLineItemsandbox","uniqueKey":"oneOf.0.line_items.items.[INDEX]","typeLabel":"WmsInboundShipmentCreateReceiptLineItemsandbox · object"},"isRequired":true,"uniqueKey":"oneOf.0.line_items","typeLabel":"WmsInboundShipmentCreateReceiptLineItemsandbox · object[]"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.0.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.0.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.trackstar_tags","typeLabel":"any[] | null"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"WMS Sandbox · object"},{"type":"object","title":"Extensiv (3PL Central)","properties":{},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"Extensiv (3PL Central) · object"},{"type":"object","title":"Luminous","required":["line_items","warehouse_id","warehouse_location_id"],"properties":{"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","quantity":1}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.2.line_items.items.[INDEX].sku","typeLabel":"string"},"quantity":{"type":"integer","description":"Total quantity of the item that has been received.","example":1,"isRequired":true,"uniqueKey":"oneOf.2.line_items.items.[INDEX].quantity","typeLabel":"integer"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentCreateReceiptLineItemluminous","uniqueKey":"oneOf.2.line_items.items.[INDEX]","typeLabel":"WmsInboundShipmentCreateReceiptLineItemluminous · object"},"isRequired":true,"uniqueKey":"oneOf.2.line_items","typeLabel":"WmsInboundShipmentCreateReceiptLineItemluminous · object[]"},"warehouse_location_id":{"type":"string","description":"Location where the item is being received.","example":"location","isRequired":true,"uniqueKey":"oneOf.2.warehouse_location_id","typeLabel":"string"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123","isRequired":true,"uniqueKey":"oneOf.2.warehouse_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"Luminous · object"},{"type":"object","title":"Linnworks Core (SKUVault)","required":["line_items","supplier_object"],"properties":{"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"sku":"sku","quantity":0}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU.","example":"sku","isRequired":true,"uniqueKey":"oneOf.3.line_items.items.[INDEX].sku","typeLabel":"string"},"quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.3.line_items.items.[INDEX].quantity","typeLabel":"integer"}},"required":["quantity","sku"],"additionalProperties":false,"title":"WmsInboundShipmentWriteLineItemskuvaultReceipt","uniqueKey":"oneOf.3.line_items.items.[INDEX]","typeLabel":"WmsInboundShipmentWriteLineItemskuvaultReceipt · object"},"isRequired":true,"uniqueKey":"oneOf.3.line_items","typeLabel":"WmsInboundShipmentWriteLineItemskuvaultReceipt · object[]"},"supplier_object":{"oneOf":[{"type":"object","title":"SupplierId","description":"The supplier from which the shipment is being sent.","required":["supplier_id"],"properties":{"supplier_id":{"type":"string","description":"The ID of the supplier.","example":"supplier_id","isRequired":true,"uniqueKey":"oneOf.3.supplier_object.oneOf.0.supplier_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.3.supplier_object.oneOf.0","typeLabel":"SupplierId · object"},{"type":"object","title":"WriteSupplierName","description":"The supplier from which the shipment is being sent.","required":["supplier_name"],"properties":{"supplier_name":{"type":"string","description":"The name of the supplier. If supplier ID is provided, that will take precedence over this.","example":"supplier_name","isRequired":true,"uniqueKey":"oneOf.3.supplier_object.oneOf.1.supplier_name","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.3.supplier_object.oneOf.1","typeLabel":"WriteSupplierName · object"}],"isRequired":true,"uniqueKey":"oneOf.3.supplier_object","typeLabel":"SupplierId · object | WriteSupplierName · object"},"warehouse_location_id":{"type":"string","description":"Location where the items are being received.","example":"warehouse_location_id","uniqueKey":"oneOf.3.warehouse_location_id","typeLabel":"string"},"warehouse_id":{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123","uniqueKey":"oneOf.3.warehouse_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.3","typeLabel":"Linnworks Core (SKUVault) · object"}],"uniqueKey":"","typeLabel":"WMS Sandbox · object | Extensiv (3PL Central) · object | Luminous · object | Linnworks Core (SKUVault) · object"},"examples":{"Example":{"title":"Example","value":{"line_items":[{"sku":"sku","quantity":1}],"trackstar_tags":["tag1","tag2",{"tag3":"value3"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bb60e818-4c2e-4ffb-b556-84ac24790ff4":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the object that has been created or modified","example":"id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"unused_fields":{"type":"array","description":"Unused fields","items":{"type":"string","description":"","example":"unused_fields","uniqueKey":"unused_fields.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"unused_fields","typeLabel":"string[]"},"data":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the inbound shipment.","example":"inbound_id","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"warehouse_customer_id":{"oneOf":[{"type":"string","description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id","isRequired":true,"uniqueKey":"data.warehouse_customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id","isRequired":true,"uniqueKey":"data.warehouse_customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.warehouse_customer_id","typeLabel":"string | null"},"created_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was created.","example":"2022-01-01T00:00:00Z","isRequired":true,"uniqueKey":"data.created_date","typeLabel":"string\u003cdate-time>"},"updated_date":{"type":"string","format":"date-time","description":"The date the inbound shipment was last updated.","example":"2022-01-02T05:05:05Z","isRequired":true,"uniqueKey":"data.updated_date","typeLabel":"string\u003cdate-time>"},"purchase_order_number":{"oneOf":[{"type":"string","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123","isRequired":true,"uniqueKey":"data.purchase_order_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The number of the purchase order associated with the inbound shipment.","example":"po_number_123","isRequired":true,"uniqueKey":"data.purchase_order_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.purchase_order_number","typeLabel":"string | null"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the inbound shipment. See the [inbound shipment information](info) for more details.","example":"receiving","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"raw_status":{"oneOf":[{"type":"string","description":"The raw status (if available) returned directly from the WMS.","example":"raw_status","isRequired":true,"uniqueKey":"data.raw_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The raw status (if available) returned directly from the WMS.","example":"raw_status","isRequired":true,"uniqueKey":"data.raw_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.raw_status","typeLabel":"string | null"},"supplier_object":{"oneOf":[{"type":"object","title":"InboundShipmentSupplier","required":["supplier_id","supplier_name"],"properties":{"supplier_id":{"type":"string","description":"The ID of the supplier.","example":"supplier_id","isRequired":true,"uniqueKey":"data.supplier_object.oneOf.0.supplier_id","typeLabel":"string"},"supplier_name":{"oneOf":[{"type":"string","description":"The name of the supplier.","example":"supplier_name","isRequired":true,"uniqueKey":"data.supplier_object.oneOf.0.supplier_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the supplier.","example":"supplier_name","isRequired":true,"uniqueKey":"data.supplier_object.oneOf.0.supplier_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.supplier_object.oneOf.0.supplier_name","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.supplier_object.oneOf.0","typeLabel":"InboundShipmentSupplier · object"},{"type":"null","isRequired":true,"uniqueKey":"data.supplier_object.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.supplier_object","typeLabel":"InboundShipmentSupplier · object | null"},"expected_arrival_date":{"oneOf":[{"type":"string","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z","isRequired":true,"uniqueKey":"data.expected_arrival_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date the shipment is expected to reach the warehouse.","example":"2022-10-10T01:02:03Z","isRequired":true,"uniqueKey":"data.expected_arrival_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.expected_arrival_date","typeLabel":"string\u003cdate-time> | null"},"warehouse_id":{"oneOf":[{"type":"string","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123","isRequired":true,"uniqueKey":"data.warehouse_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id123","isRequired":true,"uniqueKey":"data.warehouse_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.warehouse_id","typeLabel":"string | null"},"line_items":{"type":"array","description":"List of line items included in the shipment.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":2,"received_quantity":1,"unit_cost":1,"external_id":"external_sku"}],"items":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].inventory_item_id","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"sku","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].sku","typeLabel":"string | null"},"expected_quantity":{"type":"integer","description":"Total quantity of the item expected to be received.","example":2,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"received_quantity":{"type":"integer","description":"Total quantity of the item that has been received.","example":1,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].received_quantity","typeLabel":"integer"},"unit_cost":{"oneOf":[{"type":"number","description":"The cost per product that is charged by the manufacturer.","example":1,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].unit_cost.oneOf.0","typeLabel":"number"},{"type":"null","description":"The cost per product that is charged by the manufacturer.","example":1,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].unit_cost.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].unit_cost","typeLabel":"number | null"},"external_id":{"oneOf":[{"type":"string","description":"An identifier from an external system. e.g. vendor sku, external id, reference number, etc..","example":"external_sku","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"An identifier from an external system. e.g. vendor sku, external id, reference number, etc..","example":"external_sku","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].external_id","typeLabel":"string | null"}},"required":["expected_quantity","external_id","inventory_item_id","received_quantity","sku","unit_cost"],"additionalProperties":false,"title":"WmsInboundShipmentLineItem","uniqueKey":"data.line_items.items.[INDEX]","typeLabel":"WmsInboundShipmentLineItem · object"},"isRequired":true,"uniqueKey":"data.line_items","typeLabel":"WmsInboundShipmentLineItem · object[]"},"receipts":{"type":"array","description":"List of receiving events associated with the inbound shipment.","example":[{"id":"receipt_id","arrived_date":"2022-10-10T01:02:03Z","line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-10-10T01:02:03Z"}]}],"items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the receiving event.","example":"receipt_id","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].id","typeLabel":"string"},"arrived_date":{"type":"string","format":"date-time","description":"Date the items arrived.","example":"2022-10-10T01:02:03Z","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].arrived_date","typeLabel":"string\u003cdate-time>"},"line_items":{"type":"array","description":"List of line items included in the receiving event.","example":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-10-10T01:02:03Z"}],"items":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].inventory_item_id","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"sku","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].sku","typeLabel":"string | null"},"quantity":{"type":"integer","description":"Total quantity of the item that has been received.","example":1,"isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].quantity","typeLabel":"integer"},"lot_id":{"oneOf":[{"type":"string","description":"The ID of the lot the items belong to.","example":"lot_id","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].lot_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the lot the items belong to.","example":"lot_id","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].lot_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].lot_id","typeLabel":"string | null"},"expiration_date":{"oneOf":[{"type":"string","format":"date-time","description":"The expiration date of the lot the items belong to.","example":"2022-10-10T01:02:03Z","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].expiration_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The expiration date of the lot the items belong to.","example":"2022-10-10T01:02:03Z","isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].expiration_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX].expiration_date","typeLabel":"string\u003cdate-time> | null"}},"required":["expiration_date","inventory_item_id","lot_id","quantity","sku"],"additionalProperties":false,"title":"InboundReceiptLineItem","uniqueKey":"data.receipts.items.[INDEX].line_items.items.[INDEX]","typeLabel":"InboundReceiptLineItem · object"},"isRequired":true,"uniqueKey":"data.receipts.items.[INDEX].line_items","typeLabel":"InboundReceiptLineItem · object[]"}},"required":["arrived_date","id","line_items"],"additionalProperties":false,"title":"InboundReceipt","uniqueKey":"data.receipts.items.[INDEX]","typeLabel":"InboundReceipt · object"},"isRequired":true,"uniqueKey":"data.receipts","typeLabel":"InboundReceipt · object[]"},"ship_from_address":{"type":"object","properties":{"address1":{"oneOf":[{"type":"string","description":"","example":"123 Main St","isRequired":true,"uniqueKey":"data.ship_from_address.address1.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"123 Main St","isRequired":true,"uniqueKey":"data.ship_from_address.address1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ship_from_address.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"type":"string","description":"","example":"Apt 2","isRequired":true,"uniqueKey":"data.ship_from_address.address2.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"Apt 2","isRequired":true,"uniqueKey":"data.ship_from_address.address2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ship_from_address.address2","typeLabel":"string | null"},"address3":{"oneOf":[{"type":"string","description":"","example":"Floor 3","isRequired":true,"uniqueKey":"data.ship_from_address.address3.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"Floor 3","isRequired":true,"uniqueKey":"data.ship_from_address.address3.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ship_from_address.address3","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"","example":"New York","isRequired":true,"uniqueKey":"data.ship_from_address.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"New York","isRequired":true,"uniqueKey":"data.ship_from_address.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ship_from_address.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"","example":"NY","isRequired":true,"uniqueKey":"data.ship_from_address.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"NY","isRequired":true,"uniqueKey":"data.ship_from_address.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ship_from_address.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","description":"","example":"10001","isRequired":true,"uniqueKey":"data.ship_from_address.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"10001","isRequired":true,"uniqueKey":"data.ship_from_address.postal_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ship_from_address.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"","example":"United States","isRequired":true,"uniqueKey":"data.ship_from_address.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"United States","isRequired":true,"uniqueKey":"data.ship_from_address.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ship_from_address.country","typeLabel":"string | null"}},"required":["address1","address2","address3","city","country","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddress","isRequired":true,"uniqueKey":"data.ship_from_address","typeLabel":"ShipFromAddress · object"},"tracking_numbers":{"type":"array","description":"List of tracking numbers associated with the inbound shipment.","example":["tracking_number_1","tracking_number_2"],"items":{"type":"string","description":"Tracking number","example":"tracking_number","uniqueKey":"data.tracking_numbers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.tracking_numbers","typeLabel":"string[]"},"notes":{"type":"array","description":"List of notes associated with the inbound shipment.","example":["note_1","note_2"],"items":{"type":"string","description":"Note","example":"note","uniqueKey":"data.notes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.notes","typeLabel":"string[]"},"external_system_url":{"oneOf":[{"type":"string","description":"URL link to the inbound shipment in the external system (WMS/Freight etc).","example":"https://example.com/inboundshipment/123","isRequired":true,"uniqueKey":"data.external_system_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL link to the inbound shipment in the external system (WMS/Freight etc).","example":"https://example.com/inboundshipment/123","isRequired":true,"uniqueKey":"data.external_system_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.external_system_url","typeLabel":"string | null"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"data.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"isRequired":true,"uniqueKey":"data.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"isRequired":true,"uniqueKey":"data.trackstar_tags.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.trackstar_tags","typeLabel":"any[] | null"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.additional_fields.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"data.additional_fields","typeLabel":"object"},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.trackstar_created_date","typeLabel":"string\u003cdate-time>"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.trackstar_updated_date","typeLabel":"string\u003cdate-time>"}},"required":["additional_fields","created_date","expected_arrival_date","external_system_url","id","line_items","notes","purchase_order_number","raw_status","receipts","ship_from_address","status","supplier_object","tracking_numbers","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id","warehouse_id"],"additionalProperties":false,"title":"ReceiveInboundShipmentResponseDataSchema","uniqueKey":"data","typeLabel":"ReceiveInboundShipmentResponseDataSchema · object"}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsCreateReceiptInboundShipmentResponse","uniqueKey":"","typeLabel":"wmsCreateReceiptInboundShipmentResponse · object"},"examples":{"Example":{"title":"Example","value":{"id":"id","unused_fields":["unused_fields"],"data":{"id":"inbound_id","warehouse_customer_id":"warehouse_customer_id","created_date":"2022-01-01T00:00:00Z","updated_date":"2022-01-02T05:05:05Z","purchase_order_number":"po_number_123","status":"receiving","raw_status":"raw_status","supplier_object":{"supplier_id":"supplier_id","supplier_name":"supplier_name"},"expected_arrival_date":"2022-10-10T01:02:03Z","warehouse_id":"warehouse_id123","line_items":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":2,"received_quantity":1,"unit_cost":1,"external_id":"external_sku"}],"receipts":[{"id":"receipt_id","arrived_date":"2022-10-10T01:02:03Z","line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":1,"lot_id":"lot_id","expiration_date":"2022-10-10T01:02:03Z"}]}],"ship_from_address":{"address1":"123 Main St","address2":"Apt 2","address3":"Floor 3","city":"New York","state":"NY","postal_code":"10001","country":"United States"},"tracking_numbers":["tracking_number_1","tracking_number_2"],"notes":["note_1","note_2"],"external_system_url":"https://example.com/inboundshipment/123","trackstar_tags":["tag1","tag2",{"tag3":"value3"}],"additional_fields":{"key":"value"},"trackstar_created_date":"2023-03-15T13:45:30Z","trackstar_updated_date":"2023-03-15T13:45:30Z"}}}},"exampleType":"generated"}},"description":"Successful response","exampleType":"generated"},"db1413b6-d341-4024-9b76-0e98ab5ea498":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"id":{"type":"string","description":"The ID of the item that wasn't found.","uniqueKey":"id","typeLabel":"string"}},"required":["error"],"type":"object","title":"HTTPError","uniqueKey":"","typeLabel":"HTTPError · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","id":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not found","exampleType":"generated"},"5f45f8e1-41d1-4cc3-9a72-cf34365480d3":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"object","properties":{"\u003clocation>":{"type":"object","properties":{"\u003cfield_name>":{"type":"array","items":{"type":"string","uniqueKey":"detail.\u003clocation>.\u003cfield_name>.items.[INDEX]","typeLabel":"string"},"uniqueKey":"detail.\u003clocation>.\u003cfield_name>","typeLabel":"string[]"}},"uniqueKey":"detail.\u003clocation>","typeLabel":"object"}},"uniqueKey":"detail","typeLabel":"object"}},"required":["error"],"type":"object","title":"ValidationError","uniqueKey":"","typeLabel":"ValidationError · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","detail":{"\u003clocation>":{"\u003cfield_name>":["\u003cstring>"]}}}}},"exampleType":"generated"}},"description":"Validation error","exampleType":"generated"}},"security":{},"servers":{"eb5659b4-6eec-462c-991a-7da8383bb677":{"description":"Trackstar API","url":"https://production.trackstarhq.com"}}},"originalFileLocation":"https://production.trackstarhq.com/openapi.json"},"subdomain":"trackstar","siteName":"Trackstar","title":"Receive Inbound Shipment - Trackstar","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T22:40:27.803Z","originalFileLocation":"api-reference/wms-api/inbound-shipments/receive.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=\"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Trackstar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Receive Inbound Shipment - Trackstar\">\u003cmeta data-mint-head property=\"og:description\" content=\"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Trackstar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trackstar.mintlify.app/_mintlify/api/og/v2?division=Inbound+Shipments\u0026amp;title=Receive+Inbound+Shipment\u0026amp;description=Receive+an+inbound+shipment+for+the+WMS+connection+with+the+associated+inbound+shipment+id.\u0026amp;theme=a7581761d745b5f6f24e3162\u0026amp;signature=910b5e20c1b4337d0aa52f5294986d69d7ebc306b937aad616351395bf7346ea\">\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=\"Receive Inbound Shipment - Trackstar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trackstar.mintlify.app/_mintlify/api/og/v2?division=Inbound+Shipments\u0026amp;title=Receive+Inbound+Shipment\u0026amp;description=Receive+an+inbound+shipment+for+the+WMS+connection+with+the+associated+inbound+shipment+id.\u0026amp;theme=a7581761d745b5f6f24e3162\u0026amp;signature=910b5e20c1b4337d0aa52f5294986d69d7ebc306b937aad616351395bf7346ea\">\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/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Trackstar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7691DA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/wms-api/inbound-shipments/receive.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trackstarhq.com/#organization\",\"name\":\"Trackstar\",\"url\":\"https://docs.trackstarhq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/light.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=eb832f4ffc768291fd95c4939b2ac6c2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trackstarhq.com#website\",\"name\":\"Trackstar\",\"url\":\"https://docs.trackstarhq.com\",\"publisher\":{\"@id\":\"https://docs.trackstarhq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive#webpage\",\"url\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive\",\"name\":\"Receive Inbound Shipment\",\"description\":\"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.\",\"dateModified\":\"2026-01-28T22:40:27.803Z\",\"isPartOf\":{\"@id\":\"https://docs.trackstarhq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"WMS API Reference\",\"item\":\"https://docs.trackstarhq.com/api-reference/wms-api/inventory/info\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Inbound Shipments\",\"item\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/info\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Receive Inbound Shipment\",\"item\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive#apireference\",\"headline\":\"Receive Inbound Shipment\",\"name\":\"Receive Inbound Shipment\",\"description\":\"Receive an inbound shipment for the WMS connection with the associated inbound shipment id.\",\"url\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/receive#webpage\"},\"dateModified\":\"2026-01-28T22:40:27.803Z\",\"publisher\":{\"@id\":\"https://docs.trackstarhq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trackstarhq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Trackstar\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Trackstar","nav":{"global":{"anchors":[{"anchor":"Request an API Key","icon":"key","href":"https://trackstarhq.com/get-started"},{"anchor":"Login to Dashboard","icon":"browser","href":"https://dashboard.trackstarhq.com"},{"anchor":"WMS Integrations","icon":"warehouse","href":"https://trackstarhq.com/integrations/wms"},{"anchor":"Cart Integrations","icon":"cart-shopping","href":"https://trackstarhq.com/integrations/cart"},{"anchor":"Carrier Integrations","icon":"truck","href":"https://trackstarhq.com/integrations/carrier"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Admin API","pages":[{"title":"Admin API","href":"/api-reference/mgmt/create-link-token"}]},{"tab":"WMS API","groups":[{"group":"WMS API Reference","pages":[{"group":"Inventory","pages":[{"title":"Inventory","href":"/api-reference/wms-api/inventory/info"},{"openapi":"get /wms/inventory","title":"Get All Inventory Items","href":"/api-reference/wms-api/inventory/get"},{"openapi":"get /wms/inventory/{inventory_id}","title":"Get Inventory Item","href":"/api-reference/wms-api/inventory/get-item"},{"openapi":"get /wms/inventory/ledger","title":"Get Inventory Ledger","href":"/api-reference/wms-api/inventory/inventory-ledger"},{"openapi":"put /wms/inventory/{inventory_id}/adjust","title":"Adjust Inventory Item","href":"/api-reference/wms-api/inventory/adjust"},{"openapi":"put /wms/inventory/{inventory_id}/trackstar-tags","title":"Update Inventory Trackstar Tags","href":"/api-reference/wms-api/inventory/add-tag"}]},{"group":"Products","pages":[{"title":"Products","href":"/api-reference/wms-api/products/info"},{"openapi":"get /wms/products","title":"Get All Products","href":"/api-reference/wms-api/products/get"},{"openapi":"get /wms/products/{product_id}","title":"Get Product","href":"/api-reference/wms-api/products/get-item"},{"openapi":"post /wms/products","title":"Create Product","href":"/api-reference/wms-api/products/post"},{"openapi":"put /wms/products/{product_id}","title":"Update Product","href":"/api-reference/wms-api/products/put"},{"openapi":"post /wms/kits","title":"Create a Kit Product","href":"/api-reference/wms-api/products/kit-post"},{"openapi":"put /wms/kits/{kit_id}","title":"Update a Kit Product","href":"/api-reference/wms-api/products/kit-put"},{"openapi":"put /wms/products/{product_id}/trackstar-tags","title":"Update Product Trackstar Tags","href":"/api-reference/wms-api/products/add-tag"}]},{"group":"Orders","pages":[{"title":"Orders","href":"/api-reference/wms-api/orders/info"},{"openapi":"get /wms/orders","title":"Get All Orders","href":"/api-reference/wms-api/orders/get"},{"openapi":"get /wms/orders/{order_id}","title":"Get Order","href":"/api-reference/wms-api/orders/get-item"},{"openapi":"post /wms/orders","title":"Create Order","href":"/api-reference/wms-api/orders/post"},{"openapi":"put /wms/orders/{order_id}","title":"Update Order","href":"/api-reference/wms-api/orders/put"},{"openapi":"put /wms/orders/{order_id}/cancel","title":"Cancel Order","href":"/api-reference/wms-api/orders/cancel"},{"openapi":"get /wms/orders/{order_id}/packs","title":"Get Order Packs","href":"/api-reference/wms-api/orders/get-packs"},{"openapi":"post /wms/orders/{order_id}/shipments","title":"Ship Order","href":"/api-reference/wms-api/orders/create-shipment"},{"openapi":"post /wms/orders/{order_id}/file","title":"Create Order File","href":"/api-reference/wms-api/orders/attach-file"},{"openapi":"get /wms/orders/channels","title":"Get All Order Channels","href":"/api-reference/wms-api/orders/order-channels-get"},{"openapi":"put /wms/orders/{order_id}/trackstar-tags","title":"Update Order Trackstar Tags","href":"/api-reference/wms-api/orders/add-tag"}]},{"group":"Inbound Shipments","pages":[{"title":"Inbound Shipments","href":"/api-reference/wms-api/inbound-shipments/info"},{"openapi":"get /wms/inbound-shipments","title":"Get All Inbound Shipments","href":"/api-reference/wms-api/inbound-shipments/get"},{"openapi":"get /wms/inbound-shipments/{inbound_shipment_id}","title":"Get Inbound Shipment","href":"/api-reference/wms-api/inbound-shipments/get-item"},{"openapi":"post /wms/inbound-shipments","title":"Create Inbound Shipment","href":"/api-reference/wms-api/inbound-shipments/post"},{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}","title":"Update Inbound Shipment","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","href":"/api-reference/wms-api/inbound-shipments/put"},{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}/receive","title":"Receive Inbound Shipment","href":"/api-reference/wms-api/inbound-shipments/receive"},{"openapi":"get /wms/inbound-shipments/suppliers","title":"Get All Inbound Shipment Suppliers","description":null,"href":"/api-reference/wms-api/inbound-shipments/inbound-shipment-suppliers-get"},{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}/trackstar-tags","title":"Update Inbound Shipment Trackstar Tags","href":"/api-reference/wms-api/inbound-shipments/add-tag"}]},{"group":"Shipping Methods","pages":[{"title":"Shipping Methods","href":"/api-reference/wms-api/shipping-methods/info"},{"openapi":"get /wms/shipping-methods","title":"Get All Shipping Methods","href":"/api-reference/wms-api/shipping-methods/get"},{"openapi":"get /wms/shipping-methods/{shipping_method_id}","title":"Get Shipping Method","href":"/api-reference/wms-api/shipping-methods/get-item"}]},{"group":"Returns","pages":[{"title":"Returns","href":"/api-reference/wms-api/returns/info"},{"openapi":"get /wms/returns","title":"Get All Returns","href":"/api-reference/wms-api/returns/get"},{"openapi":"get /wms/returns/{return_id}","title":"Get Return","href":"/api-reference/wms-api/returns/get-item"},{"openapi":"post /wms/returns","title":"Create Return","href":"/api-reference/wms-api/returns/post"},{"openapi":"put /wms/returns/{return_id}","title":"Update Return","href":"/api-reference/wms-api/returns/put"},{"openapi":"put /wms/returns/{return_id}/cancel","title":"Cancel Return","href":"/api-reference/wms-api/returns/cancel"},{"openapi":"put /wms/returns/{return_id}/trackstar-tags","title":"Update Return Trackstar Tags","href":"/api-reference/wms-api/returns/add-tag"}]},{"group":"Billing","pages":[{"title":"Billing","href":"/api-reference/wms-api/billing/info"},{"openapi":"get /wms/billing","title":"Get All Bills","href":"/api-reference/wms-api/billing/get"},{"openapi":"get /wms/billing/{bill_id}","title":"Get Bill","href":"/api-reference/wms-api/billing/get-item"}]},{"group":"Warehouses","pages":[{"title":"Warehouses","href":"/api-reference/wms-api/warehouses/info"},{"openapi":"get /wms/warehouses","title":"Get All Warehouses","href":"/api-reference/wms-api/warehouses/get"},{"openapi":"get /wms/warehouses/{warehouse_id}","title":"Get Warehouse","href":"/api-reference/wms-api/warehouses/get-item"},{"openapi":"get /wms/warehouses/{warehouse_id}/locations","title":"Get All Warehouse Locations","href":"/api-reference/wms-api/warehouses/get-warehouse-locations"},{"openapi":"get /wms/warehouses/{warehouse_id}/locations/{location_id}","title":"Get Warehouse Location","href":"/api-reference/wms-api/warehouses/get-warehouse-locations-item"},{"openapi":"put /wms/warehouses/{warehouse_id}/trackstar-tags","title":"Update Warehouse Trackstar Tags","href":"/api-reference/wms-api/warehouses/add-tag"}]},{"group":"Warehouse Customers","pages":[{"title":"Warehouse Customers","href":"/api-reference/wms-api/warehouse-customers/info"},{"openapi":"get /wms/warehouse-customers","title":"Get All Warehouse Customers","href":"/api-reference/wms-api/warehouse-customers/get"},{"openapi":"get /wms/warehouse-customers/{warehouse_customer_id}","title":"Get Warehouse Customer","href":"/api-reference/wms-api/warehouse-customers/get-item"}]}]}]},{"tab":"Cart API","pages":[{"title":"Cart API","href":"/api-reference/cart-api/products/info"}]},{"tab":"Carrier API","pages":[{"title":"Carrier API","href":"/api-reference/carrier-api/invoice-line-items/info"}]}]},"basePath":"","title":"Receive Inbound Shipment - Trackstar","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}