[{"data":1,"prerenderedAt":1272},["ShallowReactive",2],{"navigation":3,"\u002Flogistics\u002Fshipments":526,"\u002Flogistics\u002Fshipments-surround":1267,"\u002Flogistics\u002Fshipments-reference":1261},[4,28,93,134,154,176,214],{"title":5,"path":6,"stem":7,"children":8,"icon":27},"Getting started","\u002Fgetting-started","1.getting-started\u002F1.index",[9,12,17,22],{"title":10,"path":6,"stem":7,"icon":11},"Introduction","i-lucide-house",{"title":13,"path":14,"stem":15,"icon":16},"Concepts","\u002Fgetting-started\u002Fconcepts","1.getting-started\u002F2.concepts","i-lucide-shapes",{"title":18,"path":19,"stem":20,"icon":21},"Quickstart in the portal","\u002Fgetting-started\u002Fquickstart","1.getting-started\u002F3.quickstart","i-lucide-mouse-pointer-click",{"title":23,"path":24,"stem":25,"icon":26},"Quickstart with the API","\u002Fgetting-started\u002Fapi-quickstart","1.getting-started\u002F4.api-quickstart","i-lucide-terminal",false,{"title":29,"icon":27,"path":30,"stem":31,"children":32,"page":27},"Guides","\u002Fguides","2.guides",[33,38,43,48,53,58,63,68,73,78,83,88],{"title":34,"path":35,"stem":36,"icon":37},"Products","\u002Fguides\u002Fproducts","2.guides\u002F01.products","i-lucide-package",{"title":39,"path":40,"stem":41,"icon":42},"Pricing","\u002Fguides\u002Fpricing","2.guides\u002F02.pricing","i-lucide-tags",{"title":44,"path":45,"stem":46,"icon":47},"Locations","\u002Fguides\u002Flocations","2.guides\u002F03.locations","i-lucide-map-pin",{"title":49,"path":50,"stem":51,"icon":52},"Inventory","\u002Fguides\u002Finventory","2.guides\u002F04.inventory","i-lucide-warehouse",{"title":54,"path":55,"stem":56,"icon":57},"Suppliers and purchasing","\u002Fguides\u002Fsuppliers-and-purchasing","2.guides\u002F05.suppliers-and-purchasing","i-lucide-truck",{"title":59,"path":60,"stem":61,"icon":62},"Transfer orders","\u002Fguides\u002Ftransfer-orders","2.guides\u002F06.transfer-orders","i-lucide-arrow-left-right",{"title":64,"path":65,"stem":66,"icon":67},"Bills of material","\u002Fguides\u002Fbills-of-material","2.guides\u002F07.bills-of-material","i-lucide-list-tree",{"title":69,"path":70,"stem":71,"icon":72},"Production","\u002Fguides\u002Fproduction","2.guides\u002F08.production","i-lucide-factory",{"title":74,"path":75,"stem":76,"icon":77},"Orders and shipments","\u002Fguides\u002Forders-and-shipments","2.guides\u002F09.orders-and-shipments","i-lucide-shopping-cart",{"title":79,"path":80,"stem":81,"icon":82},"Business hierarchy","\u002Fguides\u002Fbusiness-hierarchy","2.guides\u002F10.business-hierarchy","i-lucide-network",{"title":84,"path":85,"stem":86,"icon":87},"Users and roles","\u002Fguides\u002Fusers-and-roles","2.guides\u002F11.users-and-roles","i-lucide-users",{"title":89,"path":90,"stem":91,"icon":92},"Notifications","\u002Fguides\u002Fnotifications","2.guides\u002F12.notifications","i-lucide-bell",{"title":94,"path":95,"stem":96,"children":97,"icon":27},"Logistics (Cargopilot)","\u002Flogistics","3.logistics\u002F1.index",[98,100,104,109,114,119,124,129],{"title":99,"path":95,"stem":96,"icon":57},"Cargopilot overview",{"title":101,"path":102,"stem":103,"icon":37},"Shipments","\u002Flogistics\u002Fshipments","3.logistics\u002F2.shipments",{"title":105,"path":106,"stem":107,"icon":108},"Carriers and quotations","\u002Flogistics\u002Fcarriers-and-quotations","3.logistics\u002F3.carriers-and-quotations","i-lucide-receipt",{"title":110,"path":111,"stem":112,"icon":113},"Waybills and labels","\u002Flogistics\u002Fwaybills-and-labels","3.logistics\u002F4.waybills-and-labels","i-lucide-file-text",{"title":115,"path":116,"stem":117,"icon":118},"Delivery plans","\u002Flogistics\u002Fdelivery-plans","3.logistics\u002F5.delivery-plans","i-lucide-route",{"title":120,"path":121,"stem":122,"icon":123},"Fleet and tracking","\u002Flogistics\u002Ffleet-and-tracking","3.logistics\u002F6.fleet-and-tracking","i-lucide-bus",{"title":125,"path":126,"stem":127,"icon":128},"Delivery zones and rates","\u002Flogistics\u002Fdelivery-zones-and-rates","3.logistics\u002F7.delivery-zones-and-rates","i-lucide-map",{"title":130,"path":131,"stem":132,"icon":133},"Customs and HS codes","\u002Flogistics\u002Fcustoms-and-hs-codes","3.logistics\u002F8.customs-and-hs-codes","i-lucide-globe",{"title":135,"icon":27,"path":136,"stem":137,"children":138,"page":27},"Planning and AI","\u002Fplanning-and-ai","4.planning-and-ai",[139,144,149],{"title":140,"path":141,"stem":142,"icon":143},"Miridia Planner","\u002Fplanning-and-ai\u002Fmiridia-planner","4.planning-and-ai\u002F1.miridia-planner","i-lucide-chart-line",{"title":145,"path":146,"stem":147,"icon":148},"Miridia AI Studio","\u002Fplanning-and-ai\u002Fai-studio","4.planning-and-ai\u002F2.ai-studio","i-lucide-sparkles",{"title":150,"path":151,"stem":152,"icon":153},"Miridia Console","\u002Fplanning-and-ai\u002Fconsole","4.planning-and-ai\u002F3.console","i-lucide-monitor",{"title":155,"path":156,"stem":157,"children":158,"icon":27},"Integrations","\u002Fintegrations","5.integrations\u002F1.index",[159,162,167,172],{"title":160,"path":156,"stem":157,"icon":161},"Integrations overview","i-lucide-plug",{"title":163,"path":164,"stem":165,"icon":166},"Workflows and events","\u002Fintegrations\u002Fworkflows","5.integrations\u002F2.workflows","i-lucide-workflow",{"title":168,"path":169,"stem":170,"icon":171},"Build a connector","\u002Fintegrations\u002Fconnectors","5.integrations\u002F3.connectors","i-lucide-cable",{"title":173,"path":174,"stem":175,"icon":52},"Data warehouse","\u002Fintegrations\u002Fdata-warehouse","5.integrations\u002F4.data-warehouse",{"title":177,"path":178,"stem":179,"children":180,"icon":27},"Tutorials","\u002Ftutorials","6.tutorials\u002F01.index",[181,184,189,193,198,202,206,210],{"title":182,"path":178,"stem":179,"icon":183},"Video tutorials","i-lucide-circle-play",{"title":185,"path":186,"stem":187,"icon":188},"Set up your business","\u002Ftutorials\u002Fset-up-your-business","6.tutorials\u002F02.set-up-your-business","i-lucide-building-2",{"title":190,"path":191,"stem":192,"icon":42},"Add products and prices","\u002Ftutorials\u002Fadd-products-and-prices","6.tutorials\u002F03.add-products-and-prices",{"title":194,"path":195,"stem":196,"icon":197},"Receive a purchase order","\u002Ftutorials\u002Freceive-a-purchase-order","6.tutorials\u002F04.receive-a-purchase-order","i-lucide-package-check",{"title":199,"path":200,"stem":201,"icon":62},"Replenish a branch","\u002Ftutorials\u002Freplenish-a-branch","6.tutorials\u002F05.replenish-a-branch",{"title":203,"path":204,"stem":205,"icon":72},"Cost and produce a product","\u002Ftutorials\u002Fcost-and-produce","6.tutorials\u002F06.cost-and-produce",{"title":207,"path":208,"stem":209,"icon":166},"Automate with n8n","\u002Ftutorials\u002Fautomate-with-n8n","6.tutorials\u002F07.automate-with-n8n",{"title":211,"path":212,"stem":213,"icon":26},"Call the API","\u002Ftutorials\u002Fcall-the-api","6.tutorials\u002F08.call-the-api",{"title":215,"path":216,"stem":217,"children":218,"icon":27},"Developers","\u002Fdevelopers","7.developers\u002F1.index",[219,222,227,232,275],{"title":220,"path":216,"stem":217,"icon":221},"API overview","i-lucide-braces",{"title":223,"path":224,"stem":225,"icon":226},"Authentication","\u002Fdevelopers\u002Fauthentication","7.developers\u002F2.authentication","i-lucide-key-round",{"title":228,"path":229,"stem":230,"icon":231},"Conventions","\u002Fdevelopers\u002Fconventions","7.developers\u002F3.conventions","i-lucide-list-checks",{"title":233,"icon":27,"path":234,"stem":235,"children":236,"page":27},"Global API","\u002Fdevelopers\u002Fglobal-api","7.developers\u002F4.global-api",[237,240,245,250,255,260,265,270],{"title":223,"path":238,"stem":239,"icon":226},"\u002Fdevelopers\u002Fglobal-api\u002Fauth","7.developers\u002F4.global-api\u002F01.auth",{"title":241,"path":242,"stem":243,"icon":244},"Organizations","\u002Fdevelopers\u002Fglobal-api\u002Forganization","7.developers\u002F4.global-api\u002F02.organization","i-lucide-building",{"title":246,"path":247,"stem":248,"icon":249},"Users","\u002Fdevelopers\u002Fglobal-api\u002Fuser","7.developers\u002F4.global-api\u002F03.user","i-lucide-user",{"title":251,"path":252,"stem":253,"icon":254},"Linked accounts","\u002Fdevelopers\u002Fglobal-api\u002Flinked-accounts","7.developers\u002F4.global-api\u002F04.linked-accounts","i-lucide-link",{"title":256,"path":257,"stem":258,"icon":259},"Subscriptions","\u002Fdevelopers\u002Fglobal-api\u002Fsubscription","7.developers\u002F4.global-api\u002F05.subscription","i-lucide-credit-card",{"title":261,"path":262,"stem":263,"icon":264},"Support","\u002Fdevelopers\u002Fglobal-api\u002Fsupport","7.developers\u002F4.global-api\u002F06.support","i-lucide-life-buoy",{"title":266,"path":267,"stem":268,"icon":269},"Banners","\u002Fdevelopers\u002Fglobal-api\u002Fnotification","7.developers\u002F4.global-api\u002F07.notification","i-lucide-megaphone",{"title":271,"path":272,"stem":273,"icon":274},"Signing keys","\u002Fdevelopers\u002Fglobal-api\u002Fwell-known","7.developers\u002F4.global-api\u002F08.well-known","i-lucide-shield-check",{"title":276,"icon":27,"path":277,"stem":278,"children":279,"page":27},"Core API","\u002Fdevelopers\u002Fcore-api","7.developers\u002F5.core-api",[280,296,313,326,346,367,414,447,474],{"title":281,"icon":37,"path":282,"stem":283,"children":284,"page":27},"Catalogue","\u002Fdevelopers\u002Fcore-api\u002Fcatalogue","7.developers\u002F5.core-api\u002F01.catalogue",[285,288,292],{"title":34,"path":286,"stem":287,"icon":37},"\u002Fdevelopers\u002Fcore-api\u002Fcatalogue\u002Fproducts","7.developers\u002F5.core-api\u002F01.catalogue\u002F01.products",{"title":289,"path":290,"stem":291,"icon":37},"Product groups","\u002Fdevelopers\u002Fcore-api\u002Fcatalogue\u002Fproduct-groups","7.developers\u002F5.core-api\u002F01.catalogue\u002F02.product-groups",{"title":293,"path":294,"stem":295,"icon":37},"Price lists","\u002Fdevelopers\u002Fcore-api\u002Fcatalogue\u002Fprice-lists","7.developers\u002F5.core-api\u002F01.catalogue\u002F03.price-lists",{"title":49,"icon":52,"path":297,"stem":298,"children":299,"page":27},"\u002Fdevelopers\u002Fcore-api\u002Finventory","7.developers\u002F5.core-api\u002F02.inventory",[300,303,307,310],{"title":49,"path":301,"stem":302,"icon":52},"\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Finventory","7.developers\u002F5.core-api\u002F02.inventory\u002F01.inventory",{"title":304,"path":305,"stem":306,"icon":52},"Inventory lots","\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Finventory-lots","7.developers\u002F5.core-api\u002F02.inventory\u002F02.inventory-lots",{"title":44,"path":308,"stem":309,"icon":52},"\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Flocations","7.developers\u002F5.core-api\u002F02.inventory\u002F03.locations",{"title":59,"path":311,"stem":312,"icon":52},"\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Ftransfer-orders","7.developers\u002F5.core-api\u002F02.inventory\u002F04.transfer-orders",{"title":314,"icon":77,"path":315,"stem":316,"children":317,"page":27},"Procurement","\u002Fdevelopers\u002Fcore-api\u002Fprocurement","7.developers\u002F5.core-api\u002F03.procurement",[318,322],{"title":319,"path":320,"stem":321,"icon":77},"Suppliers","\u002Fdevelopers\u002Fcore-api\u002Fprocurement\u002Fsuppliers","7.developers\u002F5.core-api\u002F03.procurement\u002F01.suppliers",{"title":323,"path":324,"stem":325,"icon":77},"Purchase orders","\u002Fdevelopers\u002Fcore-api\u002Fprocurement\u002Fpurchase-orders","7.developers\u002F5.core-api\u002F03.procurement\u002F02.purchase-orders",{"title":327,"icon":72,"path":328,"stem":329,"children":330,"page":27},"Manufacturing","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing","7.developers\u002F5.core-api\u002F04.manufacturing",[331,334,338,342],{"title":64,"path":332,"stem":333,"icon":72},"\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fboms","7.developers\u002F5.core-api\u002F04.manufacturing\u002F01.boms",{"title":335,"path":336,"stem":337,"icon":72},"Production processes","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fproduction-processes","7.developers\u002F5.core-api\u002F04.manufacturing\u002F02.production-processes",{"title":339,"path":340,"stem":341,"icon":72},"Work orders","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fwork-orders","7.developers\u002F5.core-api\u002F04.manufacturing\u002F03.work-orders",{"title":343,"path":344,"stem":345,"icon":72},"Work order templates","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fwork-order-templates","7.developers\u002F5.core-api\u002F04.manufacturing\u002F04.work-order-templates",{"title":347,"icon":108,"path":348,"stem":349,"children":350,"page":27},"Sales","\u002Fdevelopers\u002Fcore-api\u002Fsales","7.developers\u002F5.core-api\u002F05.sales",[351,355,359,363],{"title":352,"path":353,"stem":354,"icon":108},"Orders","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Forders","7.developers\u002F5.core-api\u002F05.sales\u002F01.orders",{"title":356,"path":357,"stem":358,"icon":108},"Customers","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Fcustomers","7.developers\u002F5.core-api\u002F05.sales\u002F02.customers",{"title":360,"path":361,"stem":362,"icon":108},"Customer groups","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Fcustomer-groups","7.developers\u002F5.core-api\u002F05.sales\u002F03.customer-groups",{"title":364,"path":365,"stem":366,"icon":108},"Sales channels","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Fsales-channels","7.developers\u002F5.core-api\u002F05.sales\u002F04.sales-channels",{"title":368,"icon":57,"path":369,"stem":370,"children":371,"page":27},"Logistics","\u002Fdevelopers\u002Fcore-api\u002Flogistics","7.developers\u002F5.core-api\u002F06.logistics",[372,375,379,383,387,390,394,398,402,406,410],{"title":101,"path":373,"stem":374,"icon":57},"\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fshipment","7.developers\u002F5.core-api\u002F06.logistics\u002F01.shipment",{"title":376,"path":377,"stem":378,"icon":57},"Carriers","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fcarriers","7.developers\u002F5.core-api\u002F06.logistics\u002F02.carriers",{"title":380,"path":381,"stem":382,"icon":57},"Rates","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Frates","7.developers\u002F5.core-api\u002F06.logistics\u002F03.rates",{"title":384,"path":385,"stem":386,"icon":57},"Waybills","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fwaybill","7.developers\u002F5.core-api\u002F06.logistics\u002F04.waybill",{"title":115,"path":388,"stem":389,"icon":57},"\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdelivery-plans","7.developers\u002F5.core-api\u002F06.logistics\u002F05.delivery-plans",{"title":391,"path":392,"stem":393,"icon":57},"Delivery zones","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdelivery-zones","7.developers\u002F5.core-api\u002F06.logistics\u002F06.delivery-zones",{"title":395,"path":396,"stem":397,"icon":57},"Vehicles","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fvehicle","7.developers\u002F5.core-api\u002F06.logistics\u002F07.vehicle",{"title":399,"path":400,"stem":401,"icon":57},"Drivers","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdriver","7.developers\u002F5.core-api\u002F06.logistics\u002F08.driver",{"title":403,"path":404,"stem":405,"icon":57},"Dimension presets","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdimension-preset","7.developers\u002F5.core-api\u002F06.logistics\u002F09.dimension-preset",{"title":407,"path":408,"stem":409,"icon":57},"Fulfilment","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Ffulfillment","7.developers\u002F5.core-api\u002F06.logistics\u002F10.fulfillment",{"title":411,"path":412,"stem":413,"icon":57},"Schedules","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fschedule","7.developers\u002F5.core-api\u002F06.logistics\u002F11.schedule",{"title":415,"icon":143,"path":416,"stem":417,"children":418,"page":27},"Insights","\u002Fdevelopers\u002Fcore-api\u002Finsights","7.developers\u002F5.core-api\u002F07.insights",[419,423,427,431,435,439,443],{"title":420,"path":421,"stem":422,"icon":143},"Dashboard insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fdashboard-insights","7.developers\u002F5.core-api\u002F07.insights\u002F01.dashboard-insights",{"title":424,"path":425,"stem":426,"icon":143},"Sales insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fsales-insights","7.developers\u002F5.core-api\u002F07.insights\u002F02.sales-insights",{"title":428,"path":429,"stem":430,"icon":143},"Inventory insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Finventory-insights","7.developers\u002F5.core-api\u002F07.insights\u002F03.inventory-insights",{"title":432,"path":433,"stem":434,"icon":143},"Location insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Flocation-insights","7.developers\u002F5.core-api\u002F07.insights\u002F04.location-insights",{"title":436,"path":437,"stem":438,"icon":143},"Supplier insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fsupplier-insights","7.developers\u002F5.core-api\u002F07.insights\u002F05.supplier-insights",{"title":440,"path":441,"stem":442,"icon":143},"Network insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fnetwork-insights","7.developers\u002F5.core-api\u002F07.insights\u002F06.network-insights",{"title":444,"path":445,"stem":446,"icon":143},"AI Studio","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fai-studio","7.developers\u002F5.core-api\u002F07.insights\u002F07.ai-studio",{"title":155,"icon":161,"path":448,"stem":449,"children":450,"page":27},"\u002Fdevelopers\u002Fcore-api\u002Fintegrations","7.developers\u002F5.core-api\u002F08.integrations",[451,454,458,462,466,470],{"title":155,"path":452,"stem":453,"icon":161},"\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fintegrations","7.developers\u002F5.core-api\u002F08.integrations\u002F01.integrations",{"title":455,"path":456,"stem":457,"icon":161},"Workflows","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fworkflow","7.developers\u002F5.core-api\u002F08.integrations\u002F02.workflow",{"title":459,"path":460,"stem":461,"icon":161},"Triggers","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Ftriggers","7.developers\u002F5.core-api\u002F08.integrations\u002F03.triggers",{"title":463,"path":464,"stem":465,"icon":161},"Order integration","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Forder-integration","7.developers\u002F5.core-api\u002F08.integrations\u002F04.order-integration",{"title":467,"path":468,"stem":469,"icon":161},"Product integration","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fproduct-integration","7.developers\u002F5.core-api\u002F08.integrations\u002F05.product-integration",{"title":471,"path":472,"stem":473,"icon":161},"Shipment integration","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fshipment-integration","7.developers\u002F5.core-api\u002F08.integrations\u002F06.shipment-integration",{"title":475,"icon":476,"path":477,"stem":478,"children":479,"page":27},"Administration","i-lucide-settings","\u002Fdevelopers\u002Fcore-api\u002Fadministration","7.developers\u002F5.core-api\u002F09.administration",[480,484,488,492,496,500,503,506,510,514,518,522],{"title":481,"path":482,"stem":483,"icon":476},"Businesses","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fbusiness","7.developers\u002F5.core-api\u002F09.administration\u002F01.business",{"title":485,"path":486,"stem":487,"icon":476},"Configurations","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fconfigurations","7.developers\u002F5.core-api\u002F09.administration\u002F02.configurations",{"title":489,"path":490,"stem":491,"icon":476},"Roles","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Froles","7.developers\u002F5.core-api\u002F09.administration\u002F03.roles",{"title":493,"path":494,"stem":495,"icon":476},"Teams","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fteams","7.developers\u002F5.core-api\u002F09.administration\u002F04.teams",{"title":497,"path":498,"stem":499,"icon":476},"Employees","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Femployee","7.developers\u002F5.core-api\u002F09.administration\u002F05.employee",{"title":246,"path":501,"stem":502,"icon":476},"\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fuser","7.developers\u002F5.core-api\u002F09.administration\u002F06.user",{"title":89,"path":504,"stem":505,"icon":476},"\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fnotification","7.developers\u002F5.core-api\u002F09.administration\u002F07.notification",{"title":507,"path":508,"stem":509,"icon":476},"Push notifications","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fpush-notification","7.developers\u002F5.core-api\u002F09.administration\u002F08.push-notification",{"title":511,"path":512,"stem":513,"icon":476},"Files","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Ffiles","7.developers\u002F5.core-api\u002F09.administration\u002F09.files",{"title":515,"path":516,"stem":517,"icon":476},"Lookups","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Flookup","7.developers\u002F5.core-api\u002F09.administration\u002F10.lookup",{"title":519,"path":520,"stem":521,"icon":476},"Addresses","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Faddress","7.developers\u002F5.core-api\u002F09.administration\u002F11.address",{"title":523,"path":524,"stem":525,"icon":476},"PDF generator","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fpdf-generator","7.developers\u002F5.core-api\u002F09.administration\u002F12.pdf-generator",{"id":527,"title":101,"body":528,"description":1259,"extension":1260,"links":1261,"meta":1262,"navigation":1263,"path":102,"reference":27,"seo":1264,"sitemap":1265,"stem":103,"__hash__":1266},"docs\u002F3.logistics\u002F2.shipments.md",{"type":529,"value":530,"toc":1245},"minimark",[531,535,542,547,560,672,681,686,696,700,703,718,762,769,773,776,886,897,920,992,1014,1017,1021,1036,1040,1047,1051,1067,1071,1074,1122,1126,1156,1160,1190,1199,1219,1223,1241],[532,533,534],"p",{},"A shipment is a group of goods that move together from one address to another. It is the central record of Cargopilot. The quotations, the waybill, and the delivery plan all refer to a shipment.",[532,536,537,538,541],{},"A shipment usually comes from a sales order. Read ",[539,540,74],"a",{"href":75}," to split an order into shipments. You can also create a shipment directly, for example for a customer with no order in Miridia.",[543,544,546],"h2",{"id":545},"create-a-shipment","Create a shipment",[532,548,549,550,554,555,559],{},"Send ",[551,552,553],"code",{},"POST \u002Fapi\u002Fv1\u002Fshipments",", or select ",[556,557,558],"strong",{},"New shipment"," in the portal. A shipment has these parts:",[561,562,563,576],"table",{},[564,565,566],"thead",{},[567,568,569,573],"tr",{},[570,571,572],"th",{},"Part",[570,574,575],{},"Content",[577,578,579,588,603,624,639,652,660],"tbody",{},[567,580,581,585],{},[582,583,584],"td",{},"Customer",[582,586,587],{},"The customer who receives the goods.",[567,589,590,593],{},[582,591,592],{},"Handling type",[582,594,595,598,599,602],{},[551,596,597],{},"Delivery"," or ",[551,600,601],{},"Collection",".",[567,604,605,608],{},[582,606,607],{},"Fulfilment type",[582,609,610,613,614,613,617,620,621,602],{},[551,611,612],{},"Package",", ",[551,615,616],{},"Pallet",[551,618,619],{},"Container",", or ",[551,622,623],{},"Miscellaneous",[567,625,626,628],{},[582,627,601],{},[582,629,630,631,634,635,638],{},"The collection date, the earliest and the latest collection date, the time window (",[551,632,633],{},"collectAfterTime"," and ",[551,636,637],{},"collectBeforeTime","), and remarks.",[567,640,641,643],{},[582,642,597],{},[582,644,645,646,634,649,638],{},"The delivery date, the earliest and the latest delivery date, the time window (",[551,647,648],{},"deliverAfterTime",[551,650,651],{},"deliverBeforeTime",[567,653,654,657],{},[582,655,656],{},"Dimensions",[582,658,659],{},"The weight, the length, the width, and the height, with their units. You can use a dimension preset in place of the values.",[567,661,662,665],{},[582,663,664],{},"Approval",[582,666,667,668,671],{},"Set ",[551,669,670],{},"requiresApproval"," to true if a person must approve the shipment first.",[532,673,674,675,678,679,602],{},"Each shipment gets a code, for example for use on a label or in a conversation with a customer. When a shipment is created, Miridia raises the ",[551,676,677],{},"OnShipmentCreated"," event. A connected carrier then gets a request for a quotation. Read ",[539,680,105],{"href":106},[682,683,685],"h3",{"id":684},"times","Times",[532,687,688,689,598,692,695],{},"Write a time in 24-hour format, for example ",[551,690,691],{},"08:00",[551,693,694],{},"17:30",". Write a date in ISO 8601 format.",[543,697,699],{"id":698},"dimensions-and-presets","Dimensions and presets",[532,701,702],{},"A carrier price depends on the size and the weight of the goods. Thus give the dimensions of each shipment.",[532,704,705,706,709,710,713,714,717],{},"A ",[556,707,708],{},"dimension preset"," is a package size that you use often, for example \"Small box\" or \"Euro pallet\". It holds the fulfilment type, the weight, the length, the width, the height, and the units. Make one preset the default. Send ",[551,711,712],{},"GET \u002Fapi\u002Fdimensions\u002Fget-default-preset"," to read it. In the portal, manage the presets on the ",[556,715,716],{},"Fulfillment Presets"," page.",[719,720,721,738],"ul",{},[722,723,724,725,613,728,613,731,734,735,602],"li",{},"The units of length are ",[551,726,727],{},"Centimeter",[551,729,730],{},"Meter",[551,732,733],{},"Inch",", and ",[551,736,737],{},"Foot",[722,739,740,741,613,744,613,747,613,750,613,753,613,756,734,759,602],{},"The units of weight are ",[551,742,743],{},"Gram",[551,745,746],{},"Kilogram",[551,748,749],{},"Tonne",[551,751,752],{},"Pound",[551,754,755],{},"Stone",[551,757,758],{},"UsTon",[551,760,761],{},"ImperialTon",[532,763,764,765,768],{},"Miridia also gives preset templates for your country. Send ",[551,766,767],{},"GET \u002Fapi\u002Fdimensions\u002Ftemplates"," to read them, and copy a template into your own presets.",[543,770,772],{"id":771},"shipment-status","Shipment status",[532,774,775],{},"The status shows where the goods are. The statuses follow the path of a shipment:",[561,777,778,788],{},[564,779,780],{},[567,781,782,785],{},[570,783,784],{},"Step",[570,786,787],{},"Statuses",[577,789,790,800,827,846,873],{},[567,791,792,795],{},[582,793,794],{},"Start",[582,796,797],{},[551,798,799],{},"Active",[567,801,802,804],{},[582,803,601],{},[582,805,806,613,809,613,812,613,815,613,818,613,821,613,824],{},[551,807,808],{},"PendingCollection",[551,810,811],{},"CollectionUnassigned",[551,813,814],{},"CollectionAssigned",[551,816,817],{},"CollectionRejected",[551,819,820],{},"CollectionException",[551,822,823],{},"CollectionFailedAttempt",[551,825,826],{},"Collected",[567,828,829,832],{},[582,830,831],{},"Hub",[582,833,834,613,837,613,840,613,843],{},[551,835,836],{},"AtHub",[551,838,839],{},"ReturnedToHub",[551,841,842],{},"InTransit",[551,844,845],{},"AtDestinationHub",[567,847,848,850],{},[582,849,597],{},[582,851,852,613,855,613,858,613,861,613,864,613,867,613,870],{},[551,853,854],{},"DeliveryUnassigned",[551,856,857],{},"DeliveryAssigned",[551,859,860],{},"DeliveryRejected",[551,862,863],{},"DeliveryException",[551,865,866],{},"OutForDelivery",[551,868,869],{},"DeliveryFailedAttempt",[551,871,872],{},"InLocker",[567,874,875,878],{},[582,876,877],{},"End",[582,879,880,613,883],{},[551,881,882],{},"Delivered",[551,884,885],{},"Cancelled",[532,887,888,889,891,892,894,895,602],{},"A shipment does not have to pass through each status. For example, a shipment with your own vehicle can go from ",[551,890,799],{}," to ",[551,893,866],{}," and then to ",[551,896,882],{},[532,898,899,900,903,904,907,908,911,912,915,916,919],{},"To change the status, send ",[551,901,902],{},"PATCH \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}"," with the new ",[551,905,906],{},"status",". The same request can also set the ",[551,909,910],{},"dateOfPickup",", the ",[551,913,914],{},"dateOfDeparture",", and the ",[551,917,918],{},"dateOfDelivery",". The request changes only the fields that you send.",[921,922,930],"pre",{"className":923,"code":924,"filename":902,"highlights":925,"language":927,"meta":928,"style":929},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"status\": \"Delivered\",\n  \"dateOfDelivery\": \"2026-10-02T14:20:00Z\"\n}\n",[926],0,"json","[PATCH \u002Fapi\u002Fv1\u002Fshipments\u002F]","",[551,931,932,941,967,986],{"__ignoreMap":929},[933,934,937],"span",{"class":935,"line":936},"line",1,[933,938,940],{"class":939},"sMK4o","{\n",[933,942,944,947,950,953,956,959,962,964],{"class":935,"line":943},2,[933,945,946],{"class":939},"  \"",[933,948,906],{"class":949},"spNyl",[933,951,952],{"class":939},"\"",[933,954,955],{"class":939},":",[933,957,958],{"class":939}," \"",[933,960,882],{"class":961},"sfazB",[933,963,952],{"class":939},[933,965,966],{"class":939},",\n",[933,968,970,972,974,976,978,980,983],{"class":935,"line":969},3,[933,971,946],{"class":939},[933,973,918],{"class":949},[933,975,952],{"class":939},[933,977,955],{"class":939},[933,979,958],{"class":939},[933,981,982],{"class":961},"2026-10-02T14:20:00Z",[933,984,985],{"class":939},"\"\n",[933,987,989],{"class":935,"line":988},4,[933,990,991],{"class":939},"}\n",[532,993,994,995,998,999,634,1001,1003,1004,634,1007,1010,1011,602],{},"Each change raises the ",[551,996,997],{},"OnShipmentStatusChanged"," event. The statuses ",[551,1000,882],{},[551,1002,885],{}," also raise ",[551,1005,1006],{},"OnShipmentDelivered",[551,1008,1009],{},"OnShipmentCancelled",". The status of the shipment also moves the status of its sales order. Read ",[539,1012,74],{"href":1013},"\u002Fguides\u002Forders-and-shipments#order-status",[532,1015,1016],{},"The carrier of the shipment sends its status updates to Cargopilot, and Cargopilot sets the status. A person, a workflow, or an API client can also set the status.",[543,1018,1020],{"id":1019},"request-a-collection","Request a collection",[532,1022,1023,1024,1027,1028,1031,1032,1035],{},"When a carrier is assigned to a shipment, you can ask for a collection. Send ",[551,1025,1026],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcollect"," with the ",[551,1029,1030],{},"dateOfCollection",". Miridia raises the ",[551,1033,1034],{},"OnShipmentDeliveryRequested"," event. A workflow can then send the request to the carrier.",[543,1037,1039],{"id":1038},"waypoints","Waypoints",[532,1041,1042,1043,1046],{},"A waypoint is a stop between the origin and the destination, for example a hub or a cross-dock. Add a waypoint with ",[551,1044,1045],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints",", and give a Miridia location. Each waypoint records the time when the goods arrive (check-in) and leave (check-out).",[543,1048,1050],{"id":1049},"tracking-number-and-barcode","Tracking number and barcode",[532,1052,1053,1054,1057,1058,1061,1062,1064,1065,602],{},"Each shipment has a ",[551,1055,1056],{},"trackingId"," and a ",[551,1059,1060],{},"barcode",". Use ",[551,1063,1056],{}," for the tracking number of the carrier. For the shipment document, read ",[539,1066,110],{"href":111},[543,1068,1070],{"id":1069},"history-of-a-shipment","History of a shipment",[532,1072,1073],{},"Keep all the data about a shipment on the shipment:",[719,1075,1076,1086,1099,1113],{},[722,1077,1078,1081,1082,1085],{},[556,1079,1080],{},"Comments."," Your team adds comments with ",[551,1083,1084],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments",". Miridia records the author and the time.",[722,1087,1088,1091,1092,1095,1096,602],{},[556,1089,1090],{},"Attachments."," Add a file or a link, for example a photo of the goods or a signed delivery note. First upload the file with ",[551,1093,1094],{},"POST \u002Fapi\u002Ffiles\u002Fsingle",". Then add it with ",[551,1097,1098],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments",[722,1100,1101,1104,1105,1108,1109,1112],{},[556,1102,1103],{},"Metadata."," Add free key and value pairs with ",[551,1106,1107],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fmetadata",". A value of ",[551,1110,1111],{},"null"," removes the key.",[722,1114,1115,1118,1119,602],{},[556,1116,1117],{},"Traces."," Miridia records each change to the shipment. Read the log with ",[551,1120,1121],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Ftraces",[543,1123,1125],{"id":1124},"find-shipments","Find shipments",[532,1127,1128,1131,1132,613,1134,1137,1138,634,1141,1061,1144,1147,1148,1151,1152,1155],{},[551,1129,1130],{},"GET \u002Fapi\u002Fv1\u002Fshipments"," returns a page of shipments. Filter by ",[551,1133,906],{},[551,1135,1136],{},"customerId",", and a date range with ",[551,1139,1140],{},"from",[551,1142,1143],{},"to",[551,1145,1146],{},"$search"," to find a code or a name. ",[551,1149,1150],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002Funassigned"," returns the shipments that are not in a delivery plan yet. ",[551,1153,1154],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002Foverview"," returns the numbers for the shipment dashboard.",[543,1157,1159],{"id":1158},"service-levels-and-fulfilment-options","Service levels and fulfilment options",[532,1161,1162,1163,613,1166,613,1169,613,1172,613,1175,613,1178,613,1181,613,1184,620,1187,602],{},"A shipment has a service level, for example ",[551,1164,1165],{},"Standard",[551,1167,1168],{},"Express",[551,1170,1171],{},"SameDay",[551,1173,1174],{},"Overnight",[551,1176,1177],{},"TwoDay",[551,1179,1180],{},"InternationalStandard",[551,1182,1183],{},"InternationalExpress",[551,1185,1186],{},"OnDemand",[551,1188,1189],{},"Freight",[532,1191,705,1192,1195,1196,602],{},[556,1193,1194],{},"service level template"," gives a service level your own name, price, time window, and description. An example is \"Before 10:00, R 150\". Manage the templates with ",[551,1197,1198],{},"\u002Fapi\u002Ffulfillments\u002Fservice-level-templates",[532,1200,1201,1202,598,1205,1208,1209,598,1212,1215,1216,602],{},"The fulfilment lookups list the sub-types of each fulfilment type, for example ",[551,1203,1204],{},"StandardEuroPallet",[551,1206,1207],{},"Reefer40Ft",", and the delivery types, for example ",[551,1210,1211],{},"DoorToDoor",[551,1213,1214],{},"LockerToLocker",". Read the ",[539,1217,1218],{"href":408},"Fulfilment reference",[543,1220,1222],{"id":1221},"api-reference","API reference",[719,1224,1225,1229,1233,1237],{},[722,1226,1227],{},[539,1228,101],{"href":373},[722,1230,1231],{},[539,1232,403],{"href":404},[722,1234,1235],{},[539,1236,407],{"href":408},[722,1238,1239],{},[539,1240,511],{"href":512},[1242,1243,1244],"style",{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":929,"searchDepth":936,"depth":943,"links":1246},[1247,1250,1251,1252,1253,1254,1255,1256,1257,1258],{"id":545,"depth":943,"text":546,"children":1248},[1249],{"id":684,"depth":969,"text":685},{"id":698,"depth":943,"text":699},{"id":771,"depth":943,"text":772},{"id":1019,"depth":943,"text":1020},{"id":1038,"depth":943,"text":1039},{"id":1049,"depth":943,"text":1050},{"id":1069,"depth":943,"text":1070},{"id":1124,"depth":943,"text":1125},{"id":1158,"depth":943,"text":1159},{"id":1221,"depth":943,"text":1222},"Create a shipment, give its dimensions and time windows, follow its status from collection to delivery, and keep its history in one place.","md",null,{},{"icon":37},{"title":101,"description":1259},{"loc":102},"8Q2nRb9FXDaIVMgDC5iwYsUpjRZemKiAVPKQVWd5uRQ",[1268,1270],{"title":99,"path":95,"stem":96,"description":1269,"icon":57,"children":-1},"Cargopilot is the logistics module of Miridia. Learn what it does and how it uses the Miridia records.",{"title":105,"path":106,"stem":107,"description":1271,"icon":108,"children":-1},"Configure the carriers of your business, get carrier quotations for each shipment, and accept the quotation that you want.",1790760092112]