[{"data":1,"prerenderedAt":1118},["ShallowReactive",2],{"navigation":3,"\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fshipment":488,"\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fshipment-surround":1112,"\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fshipment-reference":1117},[4,28,93,113,135,173],{"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,"icon":27,"path":95,"stem":96,"children":97,"page":27},"Planning and AI","\u002Fplanning-and-ai","3.planning-and-ai",[98,103,108],{"title":99,"path":100,"stem":101,"icon":102},"Miridia Planner","\u002Fplanning-and-ai\u002Fmiridia-planner","3.planning-and-ai\u002F1.miridia-planner","i-lucide-chart-line",{"title":104,"path":105,"stem":106,"icon":107},"Miridia AI Studio","\u002Fplanning-and-ai\u002Fai-studio","3.planning-and-ai\u002F2.ai-studio","i-lucide-sparkles",{"title":109,"path":110,"stem":111,"icon":112},"Miridia Console","\u002Fplanning-and-ai\u002Fconsole","3.planning-and-ai\u002F3.console","i-lucide-monitor",{"title":114,"path":115,"stem":116,"children":117,"icon":27},"Integrations","\u002Fintegrations","4.integrations\u002F1.index",[118,121,126,131],{"title":119,"path":115,"stem":116,"icon":120},"Integrations overview","i-lucide-plug",{"title":122,"path":123,"stem":124,"icon":125},"Workflows and events","\u002Fintegrations\u002Fworkflows","4.integrations\u002F2.workflows","i-lucide-workflow",{"title":127,"path":128,"stem":129,"icon":130},"Build a connector","\u002Fintegrations\u002Fconnectors","4.integrations\u002F3.connectors","i-lucide-cable",{"title":132,"path":133,"stem":134,"icon":52},"Data warehouse","\u002Fintegrations\u002Fdata-warehouse","4.integrations\u002F4.data-warehouse",{"title":136,"path":137,"stem":138,"children":139,"icon":27},"Tutorials","\u002Ftutorials","5.tutorials\u002F01.index",[140,143,148,152,157,161,165,169],{"title":141,"path":137,"stem":138,"icon":142},"Video tutorials","i-lucide-circle-play",{"title":144,"path":145,"stem":146,"icon":147},"Set up your business","\u002Ftutorials\u002Fset-up-your-business","5.tutorials\u002F02.set-up-your-business","i-lucide-building-2",{"title":149,"path":150,"stem":151,"icon":42},"Add products and prices","\u002Ftutorials\u002Fadd-products-and-prices","5.tutorials\u002F03.add-products-and-prices",{"title":153,"path":154,"stem":155,"icon":156},"Receive a purchase order","\u002Ftutorials\u002Freceive-a-purchase-order","5.tutorials\u002F04.receive-a-purchase-order","i-lucide-package-check",{"title":158,"path":159,"stem":160,"icon":62},"Replenish a branch","\u002Ftutorials\u002Freplenish-a-branch","5.tutorials\u002F05.replenish-a-branch",{"title":162,"path":163,"stem":164,"icon":72},"Cost and produce a product","\u002Ftutorials\u002Fcost-and-produce","5.tutorials\u002F06.cost-and-produce",{"title":166,"path":167,"stem":168,"icon":125},"Automate with n8n","\u002Ftutorials\u002Fautomate-with-n8n","5.tutorials\u002F07.automate-with-n8n",{"title":170,"path":171,"stem":172,"icon":26},"Call the API","\u002Ftutorials\u002Fcall-the-api","5.tutorials\u002F08.call-the-api",{"title":174,"path":175,"stem":176,"children":177,"icon":27},"Developers","\u002Fdevelopers","6.developers\u002F1.index",[178,181,186,191,234],{"title":179,"path":175,"stem":176,"icon":180},"API overview","i-lucide-braces",{"title":182,"path":183,"stem":184,"icon":185},"Authentication","\u002Fdevelopers\u002Fauthentication","6.developers\u002F2.authentication","i-lucide-key-round",{"title":187,"path":188,"stem":189,"icon":190},"Conventions","\u002Fdevelopers\u002Fconventions","6.developers\u002F3.conventions","i-lucide-list-checks",{"title":192,"icon":27,"path":193,"stem":194,"children":195,"page":27},"Global API","\u002Fdevelopers\u002Fglobal-api","6.developers\u002F4.global-api",[196,199,204,209,214,219,224,229],{"title":182,"path":197,"stem":198,"icon":185},"\u002Fdevelopers\u002Fglobal-api\u002Fauth","6.developers\u002F4.global-api\u002F01.auth",{"title":200,"path":201,"stem":202,"icon":203},"Organizations","\u002Fdevelopers\u002Fglobal-api\u002Forganization","6.developers\u002F4.global-api\u002F02.organization","i-lucide-building",{"title":205,"path":206,"stem":207,"icon":208},"Users","\u002Fdevelopers\u002Fglobal-api\u002Fuser","6.developers\u002F4.global-api\u002F03.user","i-lucide-user",{"title":210,"path":211,"stem":212,"icon":213},"Linked accounts","\u002Fdevelopers\u002Fglobal-api\u002Flinked-accounts","6.developers\u002F4.global-api\u002F04.linked-accounts","i-lucide-link",{"title":215,"path":216,"stem":217,"icon":218},"Subscriptions","\u002Fdevelopers\u002Fglobal-api\u002Fsubscription","6.developers\u002F4.global-api\u002F05.subscription","i-lucide-credit-card",{"title":220,"path":221,"stem":222,"icon":223},"Support","\u002Fdevelopers\u002Fglobal-api\u002Fsupport","6.developers\u002F4.global-api\u002F06.support","i-lucide-life-buoy",{"title":225,"path":226,"stem":227,"icon":228},"Banners","\u002Fdevelopers\u002Fglobal-api\u002Fnotification","6.developers\u002F4.global-api\u002F07.notification","i-lucide-megaphone",{"title":230,"path":231,"stem":232,"icon":233},"Signing keys","\u002Fdevelopers\u002Fglobal-api\u002Fwell-known","6.developers\u002F4.global-api\u002F08.well-known","i-lucide-shield-check",{"title":235,"icon":27,"path":236,"stem":237,"children":238,"page":27},"Core API","\u002Fdevelopers\u002Fcore-api","6.developers\u002F5.core-api",[239,255,272,285,305,327,376,409,436],{"title":240,"icon":37,"path":241,"stem":242,"children":243,"page":27},"Catalogue","\u002Fdevelopers\u002Fcore-api\u002Fcatalogue","6.developers\u002F5.core-api\u002F01.catalogue",[244,247,251],{"title":34,"path":245,"stem":246,"icon":37},"\u002Fdevelopers\u002Fcore-api\u002Fcatalogue\u002Fproducts","6.developers\u002F5.core-api\u002F01.catalogue\u002F01.products",{"title":248,"path":249,"stem":250,"icon":37},"Product groups","\u002Fdevelopers\u002Fcore-api\u002Fcatalogue\u002Fproduct-groups","6.developers\u002F5.core-api\u002F01.catalogue\u002F02.product-groups",{"title":252,"path":253,"stem":254,"icon":37},"Price lists","\u002Fdevelopers\u002Fcore-api\u002Fcatalogue\u002Fprice-lists","6.developers\u002F5.core-api\u002F01.catalogue\u002F03.price-lists",{"title":49,"icon":52,"path":256,"stem":257,"children":258,"page":27},"\u002Fdevelopers\u002Fcore-api\u002Finventory","6.developers\u002F5.core-api\u002F02.inventory",[259,262,266,269],{"title":49,"path":260,"stem":261,"icon":52},"\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Finventory","6.developers\u002F5.core-api\u002F02.inventory\u002F01.inventory",{"title":263,"path":264,"stem":265,"icon":52},"Inventory lots","\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Finventory-lots","6.developers\u002F5.core-api\u002F02.inventory\u002F02.inventory-lots",{"title":44,"path":267,"stem":268,"icon":52},"\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Flocations","6.developers\u002F5.core-api\u002F02.inventory\u002F03.locations",{"title":59,"path":270,"stem":271,"icon":52},"\u002Fdevelopers\u002Fcore-api\u002Finventory\u002Ftransfer-orders","6.developers\u002F5.core-api\u002F02.inventory\u002F04.transfer-orders",{"title":273,"icon":77,"path":274,"stem":275,"children":276,"page":27},"Procurement","\u002Fdevelopers\u002Fcore-api\u002Fprocurement","6.developers\u002F5.core-api\u002F03.procurement",[277,281],{"title":278,"path":279,"stem":280,"icon":77},"Suppliers","\u002Fdevelopers\u002Fcore-api\u002Fprocurement\u002Fsuppliers","6.developers\u002F5.core-api\u002F03.procurement\u002F01.suppliers",{"title":282,"path":283,"stem":284,"icon":77},"Purchase orders","\u002Fdevelopers\u002Fcore-api\u002Fprocurement\u002Fpurchase-orders","6.developers\u002F5.core-api\u002F03.procurement\u002F02.purchase-orders",{"title":286,"icon":72,"path":287,"stem":288,"children":289,"page":27},"Manufacturing","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing","6.developers\u002F5.core-api\u002F04.manufacturing",[290,293,297,301],{"title":64,"path":291,"stem":292,"icon":72},"\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fboms","6.developers\u002F5.core-api\u002F04.manufacturing\u002F01.boms",{"title":294,"path":295,"stem":296,"icon":72},"Production processes","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fproduction-processes","6.developers\u002F5.core-api\u002F04.manufacturing\u002F02.production-processes",{"title":298,"path":299,"stem":300,"icon":72},"Work orders","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fwork-orders","6.developers\u002F5.core-api\u002F04.manufacturing\u002F03.work-orders",{"title":302,"path":303,"stem":304,"icon":72},"Work order templates","\u002Fdevelopers\u002Fcore-api\u002Fmanufacturing\u002Fwork-order-templates","6.developers\u002F5.core-api\u002F04.manufacturing\u002F04.work-order-templates",{"title":306,"icon":307,"path":308,"stem":309,"children":310,"page":27},"Sales","i-lucide-receipt","\u002Fdevelopers\u002Fcore-api\u002Fsales","6.developers\u002F5.core-api\u002F05.sales",[311,315,319,323],{"title":312,"path":313,"stem":314,"icon":307},"Orders","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Forders","6.developers\u002F5.core-api\u002F05.sales\u002F01.orders",{"title":316,"path":317,"stem":318,"icon":307},"Customers","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Fcustomers","6.developers\u002F5.core-api\u002F05.sales\u002F02.customers",{"title":320,"path":321,"stem":322,"icon":307},"Customer groups","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Fcustomer-groups","6.developers\u002F5.core-api\u002F05.sales\u002F03.customer-groups",{"title":324,"path":325,"stem":326,"icon":307},"Sales channels","\u002Fdevelopers\u002Fcore-api\u002Fsales\u002Fsales-channels","6.developers\u002F5.core-api\u002F05.sales\u002F04.sales-channels",{"title":328,"icon":57,"path":329,"stem":330,"children":331,"page":27},"Logistics","\u002Fdevelopers\u002Fcore-api\u002Flogistics","6.developers\u002F5.core-api\u002F06.logistics",[332,336,340,344,348,352,356,360,364,368,372],{"title":333,"path":334,"stem":335,"icon":57},"Shipments","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fshipment","6.developers\u002F5.core-api\u002F06.logistics\u002F01.shipment",{"title":337,"path":338,"stem":339,"icon":57},"Carriers","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fcarriers","6.developers\u002F5.core-api\u002F06.logistics\u002F02.carriers",{"title":341,"path":342,"stem":343,"icon":57},"Rates","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Frates","6.developers\u002F5.core-api\u002F06.logistics\u002F03.rates",{"title":345,"path":346,"stem":347,"icon":57},"Waybills","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fwaybill","6.developers\u002F5.core-api\u002F06.logistics\u002F04.waybill",{"title":349,"path":350,"stem":351,"icon":57},"Delivery plans","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdelivery-plans","6.developers\u002F5.core-api\u002F06.logistics\u002F05.delivery-plans",{"title":353,"path":354,"stem":355,"icon":57},"Delivery zones","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdelivery-zones","6.developers\u002F5.core-api\u002F06.logistics\u002F06.delivery-zones",{"title":357,"path":358,"stem":359,"icon":57},"Vehicles","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fvehicle","6.developers\u002F5.core-api\u002F06.logistics\u002F07.vehicle",{"title":361,"path":362,"stem":363,"icon":57},"Drivers","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdriver","6.developers\u002F5.core-api\u002F06.logistics\u002F08.driver",{"title":365,"path":366,"stem":367,"icon":57},"Dimension presets","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fdimension-preset","6.developers\u002F5.core-api\u002F06.logistics\u002F09.dimension-preset",{"title":369,"path":370,"stem":371,"icon":57},"Fulfilment","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Ffulfillment","6.developers\u002F5.core-api\u002F06.logistics\u002F10.fulfillment",{"title":373,"path":374,"stem":375,"icon":57},"Schedules","\u002Fdevelopers\u002Fcore-api\u002Flogistics\u002Fschedule","6.developers\u002F5.core-api\u002F06.logistics\u002F11.schedule",{"title":377,"icon":102,"path":378,"stem":379,"children":380,"page":27},"Insights","\u002Fdevelopers\u002Fcore-api\u002Finsights","6.developers\u002F5.core-api\u002F07.insights",[381,385,389,393,397,401,405],{"title":382,"path":383,"stem":384,"icon":102},"Dashboard insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fdashboard-insights","6.developers\u002F5.core-api\u002F07.insights\u002F01.dashboard-insights",{"title":386,"path":387,"stem":388,"icon":102},"Sales insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fsales-insights","6.developers\u002F5.core-api\u002F07.insights\u002F02.sales-insights",{"title":390,"path":391,"stem":392,"icon":102},"Inventory insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Finventory-insights","6.developers\u002F5.core-api\u002F07.insights\u002F03.inventory-insights",{"title":394,"path":395,"stem":396,"icon":102},"Location insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Flocation-insights","6.developers\u002F5.core-api\u002F07.insights\u002F04.location-insights",{"title":398,"path":399,"stem":400,"icon":102},"Supplier insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fsupplier-insights","6.developers\u002F5.core-api\u002F07.insights\u002F05.supplier-insights",{"title":402,"path":403,"stem":404,"icon":102},"Network insights","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fnetwork-insights","6.developers\u002F5.core-api\u002F07.insights\u002F06.network-insights",{"title":406,"path":407,"stem":408,"icon":102},"AI Studio","\u002Fdevelopers\u002Fcore-api\u002Finsights\u002Fai-studio","6.developers\u002F5.core-api\u002F07.insights\u002F07.ai-studio",{"title":114,"icon":120,"path":410,"stem":411,"children":412,"page":27},"\u002Fdevelopers\u002Fcore-api\u002Fintegrations","6.developers\u002F5.core-api\u002F08.integrations",[413,416,420,424,428,432],{"title":114,"path":414,"stem":415,"icon":120},"\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fintegrations","6.developers\u002F5.core-api\u002F08.integrations\u002F01.integrations",{"title":417,"path":418,"stem":419,"icon":120},"Workflows","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fworkflow","6.developers\u002F5.core-api\u002F08.integrations\u002F02.workflow",{"title":421,"path":422,"stem":423,"icon":120},"Triggers","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Ftriggers","6.developers\u002F5.core-api\u002F08.integrations\u002F03.triggers",{"title":425,"path":426,"stem":427,"icon":120},"Order integration","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Forder-integration","6.developers\u002F5.core-api\u002F08.integrations\u002F04.order-integration",{"title":429,"path":430,"stem":431,"icon":120},"Product integration","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fproduct-integration","6.developers\u002F5.core-api\u002F08.integrations\u002F05.product-integration",{"title":433,"path":434,"stem":435,"icon":120},"Shipment integration","\u002Fdevelopers\u002Fcore-api\u002Fintegrations\u002Fshipment-integration","6.developers\u002F5.core-api\u002F08.integrations\u002F06.shipment-integration",{"title":437,"icon":438,"path":439,"stem":440,"children":441,"page":27},"Administration","i-lucide-settings","\u002Fdevelopers\u002Fcore-api\u002Fadministration","6.developers\u002F5.core-api\u002F09.administration",[442,446,450,454,458,462,465,468,472,476,480,484],{"title":443,"path":444,"stem":445,"icon":438},"Businesses","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fbusiness","6.developers\u002F5.core-api\u002F09.administration\u002F01.business",{"title":447,"path":448,"stem":449,"icon":438},"Configurations","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fconfigurations","6.developers\u002F5.core-api\u002F09.administration\u002F02.configurations",{"title":451,"path":452,"stem":453,"icon":438},"Roles","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Froles","6.developers\u002F5.core-api\u002F09.administration\u002F03.roles",{"title":455,"path":456,"stem":457,"icon":438},"Teams","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fteams","6.developers\u002F5.core-api\u002F09.administration\u002F04.teams",{"title":459,"path":460,"stem":461,"icon":438},"Employees","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Femployee","6.developers\u002F5.core-api\u002F09.administration\u002F05.employee",{"title":205,"path":463,"stem":464,"icon":438},"\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fuser","6.developers\u002F5.core-api\u002F09.administration\u002F06.user",{"title":89,"path":466,"stem":467,"icon":438},"\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fnotification","6.developers\u002F5.core-api\u002F09.administration\u002F07.notification",{"title":469,"path":470,"stem":471,"icon":438},"Push notifications","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fpush-notification","6.developers\u002F5.core-api\u002F09.administration\u002F08.push-notification",{"title":473,"path":474,"stem":475,"icon":438},"Files","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Ffiles","6.developers\u002F5.core-api\u002F09.administration\u002F09.files",{"title":477,"path":478,"stem":479,"icon":438},"Lookups","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Flookup","6.developers\u002F5.core-api\u002F09.administration\u002F10.lookup",{"title":481,"path":482,"stem":483,"icon":438},"Addresses","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Faddress","6.developers\u002F5.core-api\u002F09.administration\u002F11.address",{"title":485,"path":486,"stem":487,"icon":438},"PDF generator","\u002Fdevelopers\u002Fcore-api\u002Fadministration\u002Fpdf-generator","6.developers\u002F5.core-api\u002F09.administration\u002F12.pdf-generator",{"id":489,"title":333,"body":490,"description":1103,"extension":1104,"links":1105,"meta":1106,"navigation":1107,"path":334,"reference":1108,"seo":1109,"sitemap":1110,"stem":335,"__hash__":1111},"docs\u002F6.developers\u002F5.core-api\u002F06.logistics\u002F01.shipment.md",{"type":491,"value":492,"toc":1072},"minimark",[493,502,507,512,523,527,532,538,542,547,554,558,563,570,576,580,585,592,596,601,607,611,616,622,626,631,637,641,646,649,655,659,664,670,674,679,682,688,692,697,700,706,710,715,718,724,728,733,736,742,746,751,754,760,764,769,772,778,782,787,790,796,800,805,808,814,818,823,826,832,836,841,844,850,854,859,865,869,874,880,884,889,892,898,902,907,910,916,920,925,928,934,938],[494,495,496,497,501],"p",{},"Base URL: ",[498,499,500],"code",{},"https:\u002F\u002Fapi.miridia.io",". This page lists the shipments operations of the Core API.",[503,504,506],"h2",{"id":505},"get-shipment-overview","Get shipment overview",[494,508,509],{},[498,510,511],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002Foverview",[494,513,514,515,519,520,522],{},"Send a ",[516,517,518],"a",{"href":183},"bearer token or an API key",". The caller needs the ",[498,521,333],{}," view permission.",[503,524,526],{"id":525},"get-shipment","Get shipment",[494,528,529],{},[498,530,531],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}",[494,533,514,534,519,536,522],{},[516,535,518],{"href":183},[498,537,333],{},[503,539,541],{"id":540},"update-shipment","Update shipment",[494,543,544],{},[498,545,546],{},"PUT \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}",[494,548,514,549,519,551,553],{},[516,550,518],{"href":183},[498,552,333],{}," modify permission.",[503,555,557],{"id":556},"patch-shipment","Patch shipment",[494,559,560],{},[498,561,562],{},"PATCH \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}",[494,564,565,566,569],{},"Partially update a shipment's status and\u002For pickup\u002Fdelivery\u002Fdeparture dates. Only\nfields present (non-null) in the body are applied. Absorbs the former dates-only\nendpoint; ",[498,567,568],{},"Status"," is a raw override (same power as the full PUT update).",[494,571,514,572,519,574,553],{},[516,573,518],{"href":183},[498,575,333],{},[503,577,579],{"id":578},"delete-shipment","Delete shipment",[494,581,582],{},[498,583,584],{},"DELETE \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}",[494,586,514,587,519,589,591],{},[516,588,518],{"href":183},[498,590,333],{}," delete permission.",[503,593,595],{"id":594},"get-shipments","Get shipments",[494,597,598],{},[498,599,600],{},"GET \u002Fapi\u002Fv1\u002Fshipments",[494,602,514,603,519,605,522],{},[516,604,518],{"href":183},[498,606,333],{},[503,608,610],{"id":609},"create-shipment","Create shipment",[494,612,613],{},[498,614,615],{},"POST \u002Fapi\u002Fv1\u002Fshipments",[494,617,514,618,519,620,553],{},[516,619,518],{"href":183},[498,621,333],{},[503,623,625],{"id":624},"get-unassigned-shipments","Get unassigned shipments",[494,627,628],{},[498,629,630],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002Funassigned",[494,632,514,633,519,635,522],{},[516,634,518],{"href":183},[498,636,333],{},[503,638,640],{"id":639},"bulk-delete-shipments","Bulk delete shipments",[494,642,643],{},[498,644,645],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002Fdelete",[494,647,648],{},"Bulk delete shipments handled as HTTP POST (action endpoint for bulk operations)",[494,650,514,651,519,653,591],{},[516,652,518],{"href":183},[498,654,333],{},[503,656,658],{"id":657},"get-shipment-traces","Get shipment traces",[494,660,661],{},[498,662,663],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Ftraces",[494,665,514,666,519,668,522],{},[516,667,518],{"href":183},[498,669,333],{},[503,671,673],{"id":672},"request-shipment-collection","Request shipment collection",[494,675,676],{},[498,677,678],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcollect",[494,680,681],{},"Once a carrier has been assigned to a shipment, a collection can be requested by scheduling\na collection date.",[494,683,514,684,519,686,553],{},[516,685,518],{"href":183},[498,687,333],{},[503,689,691],{"id":690},"get-shipment-comments","Get shipment comments",[494,693,694],{},[498,695,696],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments",[494,698,699],{},"Returns the user-authored comments on this shipment, oldest first.",[494,701,514,702,519,704,522],{},[516,703,518],{"href":183},[498,705,333],{},[503,707,709],{"id":708},"add-shipment-comment","Add shipment comment",[494,711,712],{},[498,713,714],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments",[494,716,717],{},"Adds a comment to the shipment, attributed to the authenticated user.",[494,719,514,720,519,722,553],{},[516,721,518],{"href":183},[498,723,333],{},[503,725,727],{"id":726},"delete-shipment-comment","Delete shipment comment",[494,729,730],{},[498,731,732],{},"DELETE \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u002F{commentId}",[494,734,735],{},"Deletes a comment from the shipment.",[494,737,514,738,519,740,553],{},[516,739,518],{"href":183},[498,741,333],{},[503,743,745],{"id":744},"get-shipment-quotations","Get shipment quotations",[494,747,748],{},[498,749,750],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations",[494,752,753],{},"Retrieves all quotations for a shipment.",[494,755,514,756,519,758,522],{},[516,757,518],{"href":183},[498,759,333],{},[503,761,763],{"id":762},"get-shipment-quotation","Get shipment quotation",[494,765,766],{},[498,767,768],{},"GET \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}",[494,770,771],{},"Retrieves one quotation of a shipment.",[494,773,514,774,519,776,522],{},[516,775,518],{"href":183},[498,777,333],{},[503,779,781],{"id":780},"delete-shipment-quotation","Delete shipment quotation",[494,783,784],{},[498,785,786],{},"DELETE \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}",[494,788,789],{},"Deletes one quotation of a shipment. The accepted quotation cannot be deleted.",[494,791,514,792,519,794,553],{},[516,793,518],{"href":183},[498,795,333],{},[503,797,799],{"id":798},"accept-shipment-quotation","Accept shipment quotation",[494,801,802],{},[498,803,804],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept",[494,806,807],{},"Accepts one quotation of a shipment. Any other accepted quotation of the same shipment is\nreset, so a shipment never carries two accepted prices.",[494,809,514,810,519,812,553],{},[516,811,518],{"href":183},[498,813,333],{},[503,815,817],{"id":816},"withdraw-shipment-quotation-acceptance","Withdraw shipment quotation acceptance",[494,819,820],{},[498,821,822],{},"DELETE \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept",[494,824,825],{},"Withdraws the acceptance of a quotation. The quotation stays, and the shipment carries no\naccepted price until one is accepted again.",[494,827,514,828,519,830,553],{},[516,829,518],{"href":183},[498,831,333],{},[503,833,835],{"id":834},"refresh-shipment-quotations","Refresh shipment quotations",[494,837,838],{},[498,839,840],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002Frefresh",[494,842,843],{},"Clears the quotations of a shipment and asks the carriers to quote it again. The new prices\narrive through the integration callback, so the response returns the shipment, not the\nquotations.",[494,845,514,846,519,848,553],{},[516,847,518],{"href":183},[498,849,333],{},[503,851,853],{"id":852},"create-shipment-waypoint","Create shipment waypoint",[494,855,856],{},[498,857,858],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints",[494,860,514,861,519,863,553],{},[516,862,518],{"href":183},[498,864,333],{},[503,866,868],{"id":867},"delete-shipment-waypoint","Delete shipment waypoint",[494,870,871],{},[498,872,873],{},"DELETE \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints\u002F{waypointId}",[494,875,514,876,519,878,591],{},[516,877,518],{"href":183},[498,879,333],{},[503,881,883],{"id":882},"add-shipment-file-attachment","Add shipment file attachment",[494,885,886],{},[498,887,888],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments",[494,890,891],{},"Step 2 of file attachment: associates a previously uploaded file with this shipment. Upload the file first via POST \u002Fapi\u002Ffiles\u002Fsingle, then pass the returned FileAttachment id here.",[494,893,514,894,519,896,553],{},[516,895,518],{"href":183},[498,897,333],{},[503,899,901],{"id":900},"remove-shipment-file-attachment","Remove shipment file attachment",[494,903,904],{},[498,905,906],{},"DELETE \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments\u002F{attachmentId}",[494,908,909],{},"Removes a previously associated attachment (file or link) from this shipment by its metadata\nattachment entry id.",[494,911,514,912,519,914,553],{},[516,913,518],{"href":183},[498,915,333],{},[503,917,919],{"id":918},"add-shipment-metadata","Add shipment metadata",[494,921,922],{},[498,923,924],{},"POST \u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fmetadata",[494,926,927],{},"Merges the provided key\u002Fvalue pairs into the shipment's free-form metadata dictionary. A non-null value adds or overwrites the key; a null value removes the key.",[494,929,514,930,519,932,553],{},[516,931,518],{"href":183},[498,933,333],{},[503,935,937],{"id":936},"models","Models",[494,939,940,941,944,945,944,948,944,951,944,954,944,957,944,960,944,963,944,966,944,969,944,972,944,975,944,978,944,981,944,984,944,987,944,990,944,993,944,996,944,999,944,1002,944,1005,944,1008,944,1011,944,1014,944,1017,944,1020,944,1023,944,1026,944,1029,944,1032,944,1035,944,1038,944,1041,944,1044,944,1047,944,1050,944,1053,944,1056,944,1059,944,1062,944,1065,944,1068,1071],{},"The operations on this page use these object types: ",[498,942,943],{},"AddressResponse",", ",[498,946,947],{},"BusinessResponse",[498,949,950],{},"CollectionRequest",[498,952,953],{},"CollectionResponse",[498,955,956],{},"ContactResponse",[498,958,959],{},"CurrencyResponse",[498,961,962],{},"CustomerIntegrationProviderResponse",[498,964,965],{},"CustomerResponse",[498,967,968],{},"DeleteShipmentCommand",[498,970,971],{},"DeliveryRequest",[498,973,974],{},"DeliveryResponse",[498,976,977],{},"DimensionTypeWithSymbols",[498,979,980],{},"DispatchResponse",[498,982,983],{},"DriverResponse",[498,985,986],{},"DriverUserResponse",[498,988,989],{},"FulfillmentItemResponse",[498,991,992],{},"FulfillmentProviderServiceTypeModel",[498,994,995],{},"FulfillmentRequirementTypeModel",[498,997,998],{},"GeometryFieldsResponse",[498,1000,1001],{},"MetadataFileAttachment",[498,1003,1004],{},"OrderCarrierMetadata",[498,1006,1007],{},"OrderIntegrationDetailsResponse",[498,1009,1010],{},"OrderItemResponse",[498,1012,1013],{},"OrderPackageMetadata",[498,1015,1016],{},"OrderResponse",[498,1018,1019],{},"OrderShipmentResponse",[498,1021,1022],{},"OrderShippingCostsResponse",[498,1024,1025],{},"PriceDetailsResponse",[498,1027,1028],{},"PrimitiveDimensionPreset",[498,1030,1031],{},"PrimitiveIntegrationProviderResponse",[498,1033,1034],{},"PrimitiveUserResponse",[498,1036,1037],{},"ProductResponse",[498,1039,1040],{},"SalesChannelResponse",[498,1042,1043],{},"ShipmentCommentResponse",[498,1045,1046],{},"ShipmentDimensionsRequest",[498,1048,1049],{},"ShipmentItemResponse",[498,1051,1052],{},"ShipmentOverview",[498,1054,1055],{},"ShipmentQuotationResponse",[498,1057,1058],{},"ShipmentResponse",[498,1060,1061],{},"ShipmentTraceResponse",[498,1063,1064],{},"ShipmentWaypointResponse",[498,1066,1067],{},"UpdateAddressRequest",[498,1069,1070],{},"VehicleResponse",".",{"title":1073,"searchDepth":1074,"depth":1075,"links":1076},"",1,2,[1077,1078,1079,1080,1081,1082,1083,1084,1085,1086,1087,1088,1089,1090,1091,1092,1093,1094,1095,1096,1097,1098,1099,1100,1101,1102],{"id":505,"depth":1075,"text":506},{"id":525,"depth":1075,"text":526},{"id":540,"depth":1075,"text":541},{"id":556,"depth":1075,"text":557},{"id":578,"depth":1075,"text":579},{"id":594,"depth":1075,"text":595},{"id":609,"depth":1075,"text":610},{"id":624,"depth":1075,"text":625},{"id":639,"depth":1075,"text":640},{"id":657,"depth":1075,"text":658},{"id":672,"depth":1075,"text":673},{"id":690,"depth":1075,"text":691},{"id":708,"depth":1075,"text":709},{"id":726,"depth":1075,"text":727},{"id":744,"depth":1075,"text":745},{"id":762,"depth":1075,"text":763},{"id":780,"depth":1075,"text":781},{"id":798,"depth":1075,"text":799},{"id":816,"depth":1075,"text":817},{"id":834,"depth":1075,"text":835},{"id":852,"depth":1075,"text":853},{"id":867,"depth":1075,"text":868},{"id":882,"depth":1075,"text":883},{"id":900,"depth":1075,"text":901},{"id":918,"depth":1075,"text":919},{"id":936,"depth":1075,"text":937},"The shipments operations of the Core API.","md",null,{},{"icon":57},true,{"title":333,"description":1103},{"loc":334},"pCzcCk5vutDGvQ5B1Na--iO2y0OaGQIb-G9CirHB0JA",[1113,1115],{"title":324,"path":325,"stem":326,"description":1114,"icon":307,"children":-1},"The sales channels operations of the Core API.",{"title":337,"path":338,"stem":339,"description":1116,"icon":57,"children":-1},"The carriers operations of the Core API.","\u003Cp>Base URL: \u003Ccode>https:\u002F\u002Fapi.miridia.io\u003C\u002Fcode>. Read \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">Authentication\u003C\u002Fa> and \u003Ca href=\"\u002Fdevelopers\u002Fconventions\">Conventions\u003C\u002Fa> before you call these operations.\u003C\u002Fp>\n\u003Cdiv class=\"api-table\">\u003Ctable class=\"api-summary\">\u003Cthead>\u003Ctr>\u003Cth>Method\u003C\u002Fth>\u003Cth>Path\u003C\u002Fth>\u003Cth>Operation\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002Foverview\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-shipment-overview\">Get shipment overview\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-shipment\">Get shipment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-put\">PUT\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#update-shipment\">Update shipment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-patch\">PATCH\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#patch-shipment\">Patch shipment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#delete-shipment\">Delete shipment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-shipments\">Get shipments\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#create-shipment\">Create shipment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002Funassigned\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-unassigned-shipments\">Get unassigned shipments\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002Fdelete\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#bulk-delete-shipments\">Bulk delete shipments\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Ftraces\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-shipment-traces\">Get shipment traces\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcollect\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#request-shipment-collection\">Request shipment collection\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-shipment-comments\">Get shipment comments\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#add-shipment-comment\">Add shipment comment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u002F{commentId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#delete-shipment-comment\">Delete shipment comment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-shipment-quotations\">Get shipment quotations\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#get-shipment-quotation\">Get shipment quotation\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#delete-shipment-quotation\">Delete shipment quotation\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#accept-shipment-quotation\">Accept shipment quotation\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#withdraw-shipment-quotation-acceptance\">Withdraw shipment quotation acceptance\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002Frefresh\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#refresh-shipment-quotations\">Refresh shipment quotations\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#create-shipment-waypoint\">Create shipment waypoint\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints\u002F{waypointId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#delete-shipment-waypoint\">Delete shipment waypoint\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#add-shipment-file-attachment\">Add shipment file attachment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments\u002F{attachmentId}\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#remove-shipment-file-attachment\">Remove shipment file attachment\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fmetadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#add-shipment-metadata\">Add shipment metadata\u003C\u002Fa>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-shipment-overview\">\u003Ca href=\"#get-shipment-overview\">Get shipment overview\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002Foverview\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentoverview\" class=\"api-model-link\">\u003Ccode>ShipmentOverview\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002Foverview" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "message": "string",\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ],\n  "data": {\n    "total": 0,\n    "active": 0,\n    "pending": 0,\n    "closed": 0,\n    "complete": 0\n  },\n  "statusCode": "OK",\n  "canRead": true,\n  "canEdit": true,\n  "canDelete": true\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-shipment\">\u003Ca href=\"#get-shipment\">Get shipment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"update-shipment\">\u003Ca href=\"#update-shipment\">Update shipment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-put\">PUT\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON with the shape \u003Ccode>UpdateShipmentCommand\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>originAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-updateaddressrequest\" class=\"api-model-link\">\u003Ccode>UpdateAddressRequest\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>destinationAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-updateaddressrequest\" class=\"api-model-link\">\u003Ccode>UpdateAddressRequest\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>handlingType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum HandlingType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Delivery\u003C\u002Fcode>, \u003Ccode>Collection\u003C\u002Fcode>, \u003Ccode>Unassigned\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Package\u003C\u002Fcode>, \u003Ccode>Pallet\u003C\u002Fcode>, \u003Ccode>Container\u003C\u002Fcode>, \u003Ccode>Miscellaneous\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ShipmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Active\u003C\u002Fcode>, \u003Ccode>PendingCollection\u003C\u002Fcode>, \u003Ccode>CollectionUnassigned\u003C\u002Fcode>, \u003Ccode>CollectionAssigned\u003C\u002Fcode>, \u003Ccode>CollectionRejected\u003C\u002Fcode>, \u003Ccode>CollectionException\u003C\u002Fcode>, \u003Ccode>CollectionFailedAttempt\u003C\u002Fcode>, \u003Ccode>Collected\u003C\u002Fcode>, \u003Ccode>AtHub\u003C\u002Fcode>, \u003Ccode>ReturnedToHub\u003C\u002Fcode>, \u003Ccode>InTransit\u003C\u002Fcode>, \u003Ccode>AtDestinationHub\u003C\u002Fcode>, \u003Ccode>DeliveryUnassigned\u003C\u002Fcode>, \u003Ccode>DeliveryAssigned\u003C\u002Fcode>, \u003Ccode>DeliveryRejected\u003C\u002Fcode>, \u003Ccode>DeliveryException\u003C\u002Fcode>, \u003Ccode>OutForDelivery\u003C\u002Fcode>, \u003Ccode>DeliveryFailedAttempt\u003C\u002Fcode>, \u003Ccode>InLocker\u003C\u002Fcode>, \u003Ccode>Delivered\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>hasDimensions\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weight\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>height\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>width\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>length\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDeparture\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfScheduledDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>earliestDateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>latestDateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliveryTimeUpperLimit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliveryTimeLowerLimit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfScheduledCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>earliestDateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>latestDateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectionTimeUpperLimit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectionTimeLowerLimit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X PUT "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "originAddress": {\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "placeId": "string",\n    "name": "string",\n    "website": "https:\u002F\u002Fexample.com",\n    "fullAddress": "string",\n    "street": "string",\n    "suburb": "string",\n    "city": "string",\n    "country": "string",\n    "postcode": "string",\n    "unit": "string",\n    "number": "string",\n    "province": "string",\n    "latitude": 0,\n    "longitude": 0\n  },\n  "destinationAddress": {\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "placeId": "string",\n    "name": "string",\n    "website": "https:\u002F\u002Fexample.com",\n    "fullAddress": "string",\n    "street": "string",\n    "suburb": "string",\n    "city": "string",\n    "country": "string",\n    "postcode": "string",\n    "unit": "string",\n    "number": "string",\n    "province": "string",\n    "latitude": 0,\n    "longitude": 0\n  },\n  "handlingType": "Delivery",\n  "fulfillmentType": "Package",\n  "status": "Active",\n  "hasDimensions": true,\n  "description": "string",\n  "weight": 0,\n  "height": 0,\n  "width": 0,\n  "length": 0,\n  "dateOfDeparture": "2026-09-29T08:00:00Z",\n  "dateOfScheduledDelivery": "2026-09-29T08:00:00Z",\n  "earliestDateOfDelivery": "2026-09-29T08:00:00Z",\n  "latestDateOfDelivery": "2026-09-29T08:00:00Z",\n  "deliveryTimeUpperLimit": "2026-09-29T08:00:00Z",\n  "deliveryTimeLowerLimit": "2026-09-29T08:00:00Z",\n  "dateOfScheduledCollection": "2026-09-29T08:00:00Z",\n  "earliestDateOfCollection": "2026-09-29T08:00:00Z",\n  "latestDateOfCollection": "2026-09-29T08:00:00Z",\n  "collectionTimeUpperLimit": "2026-09-29T08:00:00Z",\n  "collectionTimeLowerLimit": "2026-09-29T08:00:00Z"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"patch-shipment\">\u003Ca href=\"#patch-shipment\">Patch shipment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-patch\">PATCH\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Partially update a shipment's status and\u002For pickup\u002Fdelivery\u002Fdeparture dates. Only fields present (non-null) in the body are applied. Absorbs the former dates-only endpoint; \u003Ccode>Status\u003C\u002Fcode> is a raw override (same power as the full PUT update).\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON with the shape \u003Ccode>PatchShipmentCommand\u003C\u002Fcode>. Partial update of a shipment's editable header fields. Every field is nullable and only applied when non-null, so a caller can PATCH a single property without supplying (and clobbering) the rest of the shipment. Absorbs the former dates-only endpoint.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Bound from the route, not the body.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ShipmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Active\u003C\u002Fcode>, \u003Ccode>PendingCollection\u003C\u002Fcode>, \u003Ccode>CollectionUnassigned\u003C\u002Fcode>, \u003Ccode>CollectionAssigned\u003C\u002Fcode>, \u003Ccode>CollectionRejected\u003C\u002Fcode>, \u003Ccode>CollectionException\u003C\u002Fcode>, \u003Ccode>CollectionFailedAttempt\u003C\u002Fcode>, \u003Ccode>Collected\u003C\u002Fcode>, \u003Ccode>AtHub\u003C\u002Fcode>, \u003Ccode>ReturnedToHub\u003C\u002Fcode>, \u003Ccode>InTransit\u003C\u002Fcode>, \u003Ccode>AtDestinationHub\u003C\u002Fcode>, \u003Ccode>DeliveryUnassigned\u003C\u002Fcode>, \u003Ccode>DeliveryAssigned\u003C\u002Fcode>, \u003Ccode>DeliveryRejected\u003C\u002Fcode>, \u003Ccode>DeliveryException\u003C\u002Fcode>, \u003Ccode>OutForDelivery\u003C\u002Fcode>, \u003Ccode>DeliveryFailedAttempt\u003C\u002Fcode>, \u003Ccode>InLocker\u003C\u002Fcode>, \u003Ccode>Delivered\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfPickup\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDeparture\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X PATCH "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "status": "Active",\n  "dateOfPickup": "2026-09-29T08:00:00Z",\n  "dateOfDelivery": "2026-09-29T08:00:00Z",\n  "dateOfDeparture": "2026-09-29T08:00:00Z"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"delete-shipment\">\u003Ca href=\"#delete-shipment\">Delete shipment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> delete permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ccode>boolean\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X DELETE "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "message": "string",\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ],\n  "data": true,\n  "statusCode": "OK",\n  "canRead": true,\n  "canEdit": true,\n  "canDelete": true\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-shipments\">\u003Ca href=\"#get-shipments\">Get shipments\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>Page\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Limits: minimum 1.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>PageSize\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Limits: minimum 1, maximum 100.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>$orderby\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Example: "created_at desc" or "name asc"\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>$filter\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Apply a ODATA style filter to the query to add a fixed constraint. For example, if you want to filter by the creation date, you would set the filter to "created_at ge 2022-01-01". Or if you want to filter by a specific status, you would set the filter to "status eq 'active'".\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>$search\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Provide a search value which would inherit the 'CONTAINS' behaviour.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>from\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>to\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>customerId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#paged-result\">\u003Ccode>PagedResult\u003C\u002Fcode>\u003C\u002Fa> envelope. Each item in \u003Ccode>data\u003C\u002Fcode> is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"create-shipment\">\u003Ca href=\"#create-shipment\">Create shipment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON with the shape \u003Ccode>CreateShipmentCommand\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>requiresApproval\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Limits: maximum 3000 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>handlingType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum HandlingType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Delivery\u003C\u002Fcode>, \u003Ccode>Collection\u003C\u002Fcode>, \u003Ccode>Unassigned\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Package\u003C\u002Fcode>, \u003Ccode>Pallet\u003C\u002Fcode>, \u003Ccode>Container\u003C\u002Fcode>, \u003Ccode>Miscellaneous\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ShipmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Active\u003C\u002Fcode>, \u003Ccode>PendingCollection\u003C\u002Fcode>, \u003Ccode>CollectionUnassigned\u003C\u002Fcode>, \u003Ccode>CollectionAssigned\u003C\u002Fcode>, \u003Ccode>CollectionRejected\u003C\u002Fcode>, \u003Ccode>CollectionException\u003C\u002Fcode>, \u003Ccode>CollectionFailedAttempt\u003C\u002Fcode>, \u003Ccode>Collected\u003C\u002Fcode>, \u003Ccode>AtHub\u003C\u002Fcode>, \u003Ccode>ReturnedToHub\u003C\u002Fcode>, \u003Ccode>InTransit\u003C\u002Fcode>, \u003Ccode>AtDestinationHub\u003C\u002Fcode>, \u003Ccode>DeliveryUnassigned\u003C\u002Fcode>, \u003Ccode>DeliveryAssigned\u003C\u002Fcode>, \u003Ccode>DeliveryRejected\u003C\u002Fcode>, \u003Ccode>DeliveryException\u003C\u002Fcode>, \u003Ccode>OutForDelivery\u003C\u002Fcode>, \u003Ccode>DeliveryFailedAttempt\u003C\u002Fcode>, \u003Ccode>InLocker\u003C\u002Fcode>, \u003Ccode>Delivered\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>hasDimensions\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>geometry\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentdimensionsrequest\" class=\"api-model-link\">\u003Ccode>ShipmentDimensionsRequest\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDeparture\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>delivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-deliveryrequest\" class=\"api-model-link\">\u003Ccode>DeliveryRequest\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-collectionrequest\" class=\"api-model-link\">\u003Ccode>CollectionRequest\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>customerId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "requiresApproval": true,\n  "description": "string",\n  "handlingType": "Delivery",\n  "fulfillmentType": "Package",\n  "status": "Active",\n  "hasDimensions": true,\n  "geometry": {\n    "weight": 0,\n    "width": 0,\n    "length": 0,\n    "height": 0,\n    "lengthType": "Centimeter",\n    "weightType": "Kilogram",\n    "presetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  },\n  "dateOfDeparture": "2026-09-29T08:00:00Z",\n  "delivery": {\n    "estimatedDateOfDelivery": "2026-09-29T08:00:00Z",\n    "dateOfDelivery": "2026-09-29T08:00:00Z",\n    "earliestDateOfDelivery": "2026-09-29T08:00:00Z",\n    "latestDateOfDelivery": "2026-09-29T08:00:00Z",\n    "deliverBeforeTime": "string",\n    "deliverAfterTime": "string",\n    "additionalRemarks": "string"\n  },\n  "collection": {\n    "dateOfCollection": "2026-09-29T08:00:00Z",\n    "estimatedDateOfCollection": "2026-09-29T08:00:00Z",\n    "dateOfScheduledCollection": "2026-09-29T08:00:00Z",\n    "earliestDateOfCollection": "2026-09-29T08:00:00Z",\n    "latestDateOfCollection": "2026-09-29T08:00:00Z",\n    "collectBeforeTime": "string",\n    "collectAfterTime": "string",\n    "additionalRemarks": "string"\n  },\n  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-unassigned-shipments\">\u003Ca href=\"#get-unassigned-shipments\">Get unassigned shipments\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002Funassigned\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#paged-result\">\u003Ccode>PagedResult\u003C\u002Fcode>\u003C\u002Fa> envelope. Each item in \u003Ccode>data\u003C\u002Fcode> is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002Funassigned" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"bulk-delete-shipments\">\u003Ca href=\"#bulk-delete-shipments\">Bulk delete shipments\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002Fdelete\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Bulk delete shipments handled as HTTP POST (action endpoint for bulk operations)\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> delete permission.\u003C\u002Fp>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON of type \u003Ca href=\"#model-deleteshipmentcommand\" class=\"api-model-link\">\u003Ccode>DeleteShipmentCommand[]\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#paged-result\">\u003Ccode>PagedResult\u003C\u002Fcode>\u003C\u002Fa> envelope. Each item in \u003Ccode>data\u003C\u002Fcode> is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002Fdelete" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '[\n  {\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n  }\n]'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-shipment-traces\">\u003Ca href=\"#get-shipment-traces\">Get shipment traces\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Ftraces\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#paged-result\">\u003Ccode>PagedResult\u003C\u002Fcode>\u003C\u002Fa> envelope. Each item in \u003Ccode>data\u003C\u002Fcode> is \u003Ca href=\"#model-shipmenttraceresponse\" class=\"api-model-link\">\u003Ccode>ShipmentTraceResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Ftraces" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "count": 0,\n  "totalCount": 0,\n  "page": 0,\n  "finalPage": 0,\n  "pageSize": 0,\n  "hasMore": true,\n  "statusCode": "OK",\n  "data": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "title": "string",\n      "message": "string",\n      "shipmentStatus": "Active",\n      "activityAction": "StatusChange",\n      "dateCreated": "2026-09-29T08:00:00Z",\n      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "activityType": "System"\n    }\n  ],\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ]\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"request-shipment-collection\">\u003Ca href=\"#request-shipment-collection\">Request shipment collection\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcollect\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Once a carrier has been assigned to a shipment, a collection can be requested by scheduling a collection date.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON with the shape \u003Ccode>RequestShipmentCollectionRequest\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>dateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcollect" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "dateOfCollection": "2026-09-29T08:00:00Z"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-shipment-comments\">\u003Ca href=\"#get-shipment-comments\">Get shipment comments\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Returns the user-authored comments on this shipment, oldest first.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#paged-result\">\u003Ccode>PagedResult\u003C\u002Fcode>\u003C\u002Fa> envelope. Each item in \u003Ccode>data\u003C\u002Fcode> is \u003Ca href=\"#model-shipmentcommentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentCommentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "count": 0,\n  "totalCount": 0,\n  "page": 0,\n  "finalPage": 0,\n  "pageSize": 0,\n  "hasMore": true,\n  "statusCode": "OK",\n  "data": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "comment": "string",\n      "user": {},\n      "dateCreated": "2026-09-29T08:00:00Z"\n    }\n  ],\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ]\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"add-shipment-comment\">\u003Ca href=\"#add-shipment-comment\">Add shipment comment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Adds a comment to the shipment, attributed to the authenticated user.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON with the shape \u003Ccode>ShipmentCommentRequest\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>comment\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>Limits: maximum 4000 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentcommentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentCommentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "comment": "string"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "message": "string",\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ],\n  "data": {\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "comment": "string",\n    "user": {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "displayName": "string",\n      "firstName": "string",\n      "lastName": "string",\n      "email": "string",\n      "phoneNumber": "string"\n    },\n    "dateCreated": "2026-09-29T08:00:00Z"\n  },\n  "statusCode": "OK",\n  "canRead": true,\n  "canEdit": true,\n  "canDelete": true\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"delete-shipment-comment\">\u003Ca href=\"#delete-shipment-comment\">Delete shipment comment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u002F{commentId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Deletes a comment from the shipment.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>commentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ccode>boolean\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X DELETE "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fcomments\u002F{commentId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "message": "string",\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ],\n  "data": true,\n  "statusCode": "OK",\n  "canRead": true,\n  "canEdit": true,\n  "canDelete": true\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-shipment-quotations\">\u003Ca href=\"#get-shipment-quotations\">Get shipment quotations\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Retrieves all quotations for a shipment.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#paged-result\">\u003Ccode>PagedResult\u003C\u002Fcode>\u003C\u002Fa> envelope. Each item in \u003Ccode>data\u003C\u002Fcode> is \u003Ca href=\"#model-shipmentquotationresponse\" class=\"api-model-link\">\u003Ccode>ShipmentQuotationResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"get-shipment-quotation\">\u003Ca href=\"#get-shipment-quotation\">Get shipment quotation\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-get\">GET\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Retrieves one quotation of a shipment.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> view permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quotationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentquotationresponse\" class=\"api-model-link\">\u003Ccode>ShipmentQuotationResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X GET "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"delete-shipment-quotation\">\u003Ca href=\"#delete-shipment-quotation\">Delete shipment quotation\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Deletes one quotation of a shipment. The accepted quotation cannot be deleted.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quotationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ccode>boolean\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X DELETE "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "message": "string",\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ],\n  "data": true,\n  "statusCode": "OK",\n  "canRead": true,\n  "canEdit": true,\n  "canDelete": true\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"accept-shipment-quotation\">\u003Ca href=\"#accept-shipment-quotation\">Accept shipment quotation\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Accepts one quotation of a shipment. Any other accepted quotation of the same shipment is reset, so a shipment never carries two accepted prices.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quotationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"withdraw-shipment-quotation-acceptance\">\u003Ca href=\"#withdraw-shipment-quotation-acceptance\">Withdraw shipment quotation acceptance\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Withdraws the acceptance of a quotation. The quotation stays, and the shipment carries no accepted price until one is accepted again.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quotationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X DELETE "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002F{quotationId}\u002Faccept" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"refresh-shipment-quotations\">\u003Ca href=\"#refresh-shipment-quotations\">Refresh shipment quotations\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002Frefresh\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Clears the quotations of a shipment and asks the carriers to quote it again. The new prices arrive through the integration callback, so the response returns the shipment, not the quotations.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>The shipment GUID\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentProviderId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>query\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Limits the request to one carrier\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fquotations\u002Frefresh" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"create-shipment-waypoint\">\u003Ca href=\"#create-shipment-waypoint\">Create shipment waypoint\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON with the shape \u003Ccode>CreateShipmentWaypointCommand\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>locationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Limits: maximum 150 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentwaypointresponse\" class=\"api-model-link\">\u003Ccode>ShipmentWaypointResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "string"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "message": "string",\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ],\n  "data": {\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "segmentPosition": 0,\n    "title": "string",\n    "dateCheckedIn": "2026-09-29T08:00:00Z",\n    "dateCheckedOut": "2026-09-29T08:00:00Z",\n    "dateCreated": "2026-09-29T08:00:00Z",\n    "dateModified": "2026-09-29T08:00:00Z",\n    "address": {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "placeId": "string",\n      "name": "string",\n      "website": "string",\n      "fullAddress": "string",\n      "street": "string",\n      "suburb": "string",\n      "city": "string",\n      "country": "string",\n      "postcode": "string",\n      "unit": "string",\n      "number": "string",\n      "province": "string",\n      "latitude": 0,\n      "longitude": 0\n    }\n  },\n  "statusCode": "OK",\n  "canRead": true,\n  "canEdit": true,\n  "canDelete": true\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"delete-shipment-waypoint\">\u003Ca href=\"#delete-shipment-waypoint\">Delete shipment waypoint\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints\u002F{waypointId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> delete permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>waypointId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentwaypointresponse\" class=\"api-model-link\">\u003Ccode>ShipmentWaypointResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X DELETE "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fwaypoints\u002F{waypointId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003Cfigure class=\"api-code\">\u003Cfigcaption>Response\u003C\u002Ffigcaption>\u003Cpre data-language=\"json\">\u003Ccode>{\n  "message": "string",\n  "messages": [\n    {\n      "title": "string",\n      "message": "string",\n      "level": "Standard",\n      "icon": "SyncAlert",\n      "code": "string"\n    }\n  ],\n  "data": {\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "segmentPosition": 0,\n    "title": "string",\n    "dateCheckedIn": "2026-09-29T08:00:00Z",\n    "dateCheckedOut": "2026-09-29T08:00:00Z",\n    "dateCreated": "2026-09-29T08:00:00Z",\n    "dateModified": "2026-09-29T08:00:00Z",\n    "address": {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "placeId": "string",\n      "name": "string",\n      "website": "string",\n      "fullAddress": "string",\n      "street": "string",\n      "suburb": "string",\n      "city": "string",\n      "country": "string",\n      "postcode": "string",\n      "unit": "string",\n      "number": "string",\n      "province": "string",\n      "latitude": 0,\n      "longitude": 0\n    }\n  },\n  "statusCode": "OK",\n  "canRead": true,\n  "canEdit": true,\n  "canDelete": true\n}\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"add-shipment-file-attachment\">\u003Ca href=\"#add-shipment-file-attachment\">Add shipment file attachment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Step 2 of file attachment: associates a previously uploaded file with this shipment. Upload the file first via POST \u002Fapi\u002Ffiles\u002Fsingle, then pass the returned FileAttachment id here.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON with the shape \u003Ccode>AddFileAttachmentRequest\u003C\u002Fcode>. Adds an attachment to an entity's metadata attachment collection. Two shapes, discriminated by \u003Ccode>Type\u003C\u002Fcode>: - \u003Ccode>File\u003C\u002Fcode> (default). \u003Ccode>title\u003C\u002Fcode> and \u003Ccode>url\u003C\u002Fcode> are required and taken as-is from the request; \u003Ccode>FileAttachmentId\u003C\u002Fcode> on the resulting metadata entry stays \u003Ccode>Guid.Empty\u003C\u002Fcode>.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>type\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum MetadataAttachmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>File\u003C\u002Fcode>, \u003Ccode>Link\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fileId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Required when \u003Ccode>Type\u003C\u002Fcode> is \u003Ccode>File\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Required when \u003Ccode>Type\u003C\u002Fcode> is \u003Ccode>Link\u003C\u002Fcode>. Ignored for \u003Ccode>File\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>url\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>Required when \u003Ccode>Type\u003C\u002Fcode> is \u003Ccode>Link\u003C\u002Fcode>. Ignored for \u003Ccode>File\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>No\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "type": "File",\n  "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "title": "string",\n  "url": "string",\n  "description": "string"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"remove-shipment-file-attachment\">\u003Ca href=\"#remove-shipment-file-attachment\">Remove shipment file attachment\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-delete\">DELETE\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments\u002F{attachmentId}\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Removes a previously associated attachment (file or link) from this shipment by its metadata attachment entry id.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>attachmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X DELETE "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fattachments\u002F{attachmentId}" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-operation\">\u003Ch2 id=\"add-shipment-metadata\">\u003Ca href=\"#add-shipment-metadata\">Add shipment metadata\u003C\u002Fa>\u003C\u002Fh2>\u003Cp class=\"api-endpoint\">\u003Cspan class=\"api-method api-method-post\">POST\u003C\u002Fspan>\u003Ccode>\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fmetadata\u003C\u002Fcode>\u003C\u002Fp>\u003Cp>Merges the provided key\u002Fvalue pairs into the shipment's free-form metadata dictionary. A non-null value adds or overwrites the key; a null value removes the key.\u003C\u002Fp>\u003Cp class=\"api-access\">\u003Cstrong>Access.\u003C\u002Fstrong> Send a \u003Ca href=\"\u002Fdevelopers\u002Fauthentication\">bearer token or an API key\u003C\u002Fa>. The caller needs the \u003Ccode>Shipments\u003C\u002Fcode> modify permission.\u003C\u002Fp>\u003Ch4>Parameters\u003C\u002Fh4>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Name\u003C\u002Fth>\u003Cth>In\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Required\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>path\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Cspan class=\"api-required\">Yes\u003C\u002Fspan>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003Ch4>Request body\u003C\u002Fh4>\u003Cp>Send JSON of type \u003Ccode>map<string, string>\u003C\u002Fcode>.\u003C\u002Fp>\u003Ch4>Response\u003C\u002Fh4>\u003Cp>\u003Ccode>200\u003C\u002Fcode>. Returns a \u003Ca href=\"\u002Fdevelopers\u002Fconventions#single-result\">\u003Ccode>SingleResult\u003C\u002Fcode>\u003C\u002Fa> envelope. The \u003Ccode>data\u003C\u002Fcode> field is \u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>.\u003C\u002Fp>\u003Cdiv class=\"api-examples\">\u003Cfigure class=\"api-code\">\u003Cfigcaption>Request\u003C\u002Ffigcaption>\u003Cpre data-language=\"bash\">\u003Ccode>curl -X POST "https:\u002F\u002Fapi.miridia.io\u002Fapi\u002Fv1\u002Fshipments\u002F{shipmentId}\u002Fmetadata" \\\n  -H "Authorization: Bearer $MIRIDIA_TOKEN" \\\n  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \\\n  -H "Content-Type: application\u002Fjson" \\\n  -d '{\n  "key": "string"\n}'\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Ffigure>\u003C\u002Fdiv>\u003C\u002Fsection>\n\u003Csection class=\"api-models\">\u003Ch2 id=\"models\">\u003Ca href=\"#models\">Models\u003C\u002Fa>\u003C\u002Fh2>\u003Cp>The operations on this page use these object types. Select a type to see its fields.\u003C\u002Fp>\n\u003Cdetails class=\"api-model\" id=\"model-addressresponse\">\u003Csummary>\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>placeId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>website\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fullAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>street\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>suburb\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>city\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>country\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>postcode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>unit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>number\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>province\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>latitude\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>longitude\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-businessresponse\">\u003Csummary>\u003Ccode>BusinessResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>registeredName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>registrationNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>displayName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>phoneNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>website\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>email\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requiresOrderIntegration\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requiresOrderFulfillment\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requiresAccountingIntegration\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requiresDispatchBuilder\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>billingAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shippingAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currentUser\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveuserresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveUserResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-collectionrequest\">\u003Csummary>\u003Ccode>CollectionRequest\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>dateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>estimatedDateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfScheduledCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>earliestDateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>latestDateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectBeforeTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectAfterTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>additionalRemarks\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-collectionresponse\">\u003Csummary>\u003Ccode>CollectionResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>address\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>instructions\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>contact\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-contactresponse\" class=\"api-model-link\">\u003Ccode>ContactResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>businessName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectAfterTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Formatted in HH not hh (24 hours)\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectBeforeTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Formatted in HH not hh (24 hours)\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-contactresponse\">\u003Csummary>\u003Ccode>ContactResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>firstName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lastName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>email\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>phoneNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>mobileNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-currencyresponse\">\u003Csummary>\u003Ccode>CurrencyResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>iso4217\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>utf8Symbol\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currencyCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum CurrencyCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Invalid\u003C\u002Fcode>, \u003Ccode>Eur\u003C\u002Fcode>, \u003Ccode>Usd\u003C\u002Fcode>, \u003Ccode>Gbp\u003C\u002Fcode>, \u003Ccode>Zar\u003C\u002Fcode>, \u003Ccode>Zmw\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-customerintegrationproviderresponse\">\u003Csummary>\u003Ccode>CustomerIntegrationProviderResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>provider\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveintegrationproviderresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveIntegrationProviderResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>customer\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-customerresponse\" class=\"api-model-link\">\u003Ccode>CustomerResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-customerresponse\">\u003Csummary>\u003Ccode>CustomerResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>isBusiness\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>website\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>email\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>businessName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>groupId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>The customer group this customer belongs to, if any. Used as a price-list assignment scope.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>phoneNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>This would generally represent the phone number for the customer if the customer is a business. Otherwise, the contact details should be part of the contact, and not the customer. Limits: maximum 20 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>integrationType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum IntegrationProviderType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>None\u003C\u002Fcode>, \u003Ccode>Commerce\u003C\u002Fcode>, \u003Ccode>Accounting\u003C\u002Fcode>, \u003Ccode>Erp\u003C\u002Fcode>, \u003Ccode>Crm\u003C\u002Fcode>, \u003Ccode>Fulfillment\u003C\u002Fcode>, \u003Ccode>Warehouse\u003C\u002Fcode>, \u003Ccode>WorkflowManager\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>billingAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shippingAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>integrations\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-customerintegrationproviderresponse\" class=\"api-model-link\">\u003Ccode>CustomerIntegrationProviderResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>contacts\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-contactresponse\" class=\"api-model-link\">\u003Ccode>ContactResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>primaryContact\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-contactresponse\" class=\"api-model-link\">\u003Ccode>ContactResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>parent\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-customerresponse\" class=\"api-model-link\">\u003Ccode>CustomerResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>attachments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-metadatafileattachment\" class=\"api-model-link\">\u003Ccode>MetadataFileAttachment[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalSales\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalSpent\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>metadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>map<string, string>\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-deleteshipmentcommand\">\u003Csummary>\u003Ccode>DeleteShipmentCommand\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-deliveryrequest\">\u003Csummary>\u003Ccode>DeliveryRequest\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>estimatedDateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>earliestDateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>latestDateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliverBeforeTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliverAfterTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>additionalRemarks\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-deliveryresponse\">\u003Csummary>\u003Ccode>DeliveryResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>address\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>instructions\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>contact\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-contactresponse\" class=\"api-model-link\">\u003Ccode>ContactResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>businessName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliverAfterTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Formatted in HH not hh (24 hours)\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliverBeforeTime\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Formatted in HH not hh (24 hours)\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-dimensiontypewithsymbols\">\u003Csummary>\u003Ccode>DimensionTypeWithSymbols\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>lengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum LengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Centimeter\u003C\u002Fcode>, \u003Ccode>Meter\u003C\u002Fcode>, \u003Ccode>Inch\u003C\u002Fcode>, \u003Ccode>Foot\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum WeightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Tonne\u003C\u002Fcode>, \u003Ccode>Pound\u003C\u002Fcode>, \u003Ccode>Stone\u003C\u002Fcode>, \u003Ccode>UsTon\u003C\u002Fcode>, \u003Ccode>ImperialTon\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>volumeType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum VolumeType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>None\u003C\u002Fcode>, \u003Ccode>Litre\u003C\u002Fcode>, \u003Ccode>CubicCentimeter\u003C\u002Fcode>, \u003Ccode>CubicMeter\u003C\u002Fcode>, \u003Ccode>Gallon\u003C\u002Fcode>, \u003Ccode>CubicInch\u003C\u002Fcode>, \u003Ccode>CubicFoot\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lengthSymbol\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightSymbol\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>volumeSymbol\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-dispatchresponse\">\u003Csummary>\u003Ccode>DispatchResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>code\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dispatchStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum DispatchStatuses\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Active\u003C\u002Fcode>, \u003Ccode>Pending\u003C\u002Fcode>, \u003Ccode>Dispatched\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>, \u003Ccode>Complete\u003C\u002Fcode>, \u003Ccode>Draft\u003C\u002Fcode>, \u003Ccode>InTransit\u003C\u002Fcode>, \u003Ccode>Unassigned\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDeparture\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>scheduledDateOfDeparture\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfCompletion\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shipments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>drivers\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-driverresponse\" class=\"api-model-link\">\u003Ccode>DriverResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>vehicle\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-vehicleresponse\" class=\"api-model-link\">\u003Ccode>VehicleResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>business\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-businessresponse\" class=\"api-model-link\">\u003Ccode>BusinessResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-driverresponse\">\u003Csummary>\u003Ccode>DriverResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>idNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>licenseNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>licenseTypeId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>licenseRenewalDate\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>licenseIssuedDate\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>user\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-driveruserresponse\" class=\"api-model-link\">\u003Ccode>DriverUserResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-driveruserresponse\">\u003Csummary>\u003Ccode>DriverUserResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>firstName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lastName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>email\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>phoneNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-fulfillmentitemresponse\">\u003Csummary>\u003Ccode>FulfillmentItemResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>weight\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>width\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>length\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>height\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quantity\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>declaredValue\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-fulfillmentproviderservicetypemodel\">\u003Csummary>\u003Ccode>FulfillmentProviderServiceTypeModel\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cp>This model represents the different services which the fulfillment provider provides.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>value\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-fulfillmentrequirementtypemodel\">\u003Csummary>\u003Ccode>FulfillmentRequirementTypeModel\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>value\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-geometryfieldsresponse\">\u003Csummary>\u003Ccode>GeometryFieldsResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>weight\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>width\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>length\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>height\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum LengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Centimeter\u003C\u002Fcode>, \u003Ccode>Meter\u003C\u002Fcode>, \u003Ccode>Inch\u003C\u002Fcode>, \u003Ccode>Foot\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum WeightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Tonne\u003C\u002Fcode>, \u003Ccode>Pound\u003C\u002Fcode>, \u003Ccode>Stone\u003C\u002Fcode>, \u003Ccode>UsTon\u003C\u002Fcode>, \u003Ccode>ImperialTon\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightSymbol\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lengthSymbol\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-metadatafileattachment\">\u003Csummary>\u003Ccode>MetadataFileAttachment\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cp>Not quite as complete as the normal \u003Ccode>FileAttachment\u003C\u002Fcode> aggregate.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>type\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum MetadataAttachmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>File\u003C\u002Fcode>, \u003Ccode>Link\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fileAttachmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Left as \u003Ccode>Guid.Empty\u003C\u002Fcode> for \u003Ccode>Link\u003C\u002Fcode> entries.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>url\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>contentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-ordercarriermetadata\">\u003Csummary>\u003Ccode>OrderCarrierMetadata\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>carrierId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>earliestCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectionRequested\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collectionAfterRequest\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateDelivered\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfReturnRequested\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>timeframe\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requestedCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shipmentLabelGenerated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requestedReturn\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>packageCount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>packages\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-orderpackagemetadata\" class=\"api-model-link\">\u003Ccode>OrderPackageMetadata[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-orderintegrationdetailsresponse\">\u003Csummary>\u003Ccode>OrderIntegrationDetailsResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>integrationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>The integration id as displayed on the relevant integration\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>provider\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveintegrationproviderresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveIntegrationProviderResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-orderitemresponse\">\u003Csummary>\u003Ccode>OrderItemResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cp>Order Item maps onto ProductOrder and contains a property with all of the product information.\u003C\u002Fp>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>code\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quantityOrdered\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>unit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum UnitOfMeasure\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Each\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>, \u003Ccode>Litre\u003C\u002Fcode>, \u003Ccode>Millilitre\u003C\u002Fcode>, \u003Ccode>Metre\u003C\u002Fcode>, \u003Ccode>Centimetre\u003C\u002Fcode>, \u003Ccode>SquareMetre\u003C\u002Fcode>, \u003Ccode>CubicMetre\u003C\u002Fcode>, \u003Ccode>Pair\u003C\u002Fcode>, \u003Ccode>Pack\u003C\u002Fcode>, \u003Ccode>Box\u003C\u002Fcode>, \u003Ccode>Roll\u003C\u002Fcode>, \u003Ccode>Sheet\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>orderShipment\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-ordershipmentresponse\" class=\"api-model-link\">\u003Ccode>OrderShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>product\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-productresponse\" class=\"api-model-link\">\u003Ccode>ProductResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shipment\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>carrier\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveintegrationproviderresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveIntegrationProviderResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dimensionPreset\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitivedimensionpreset\" class=\"api-model-link\">\u003Ccode>PrimitiveDimensionPreset\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>primaryImageUrl\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>geometry\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-geometryfieldsresponse\" class=\"api-model-link\">\u003Ccode>GeometryFieldsResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>billing\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-pricedetailsresponse\" class=\"api-model-link\">\u003Ccode>PriceDetailsResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-orderpackagemetadata\">\u003Csummary>\u003Ccode>OrderPackageMetadata\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>productId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dimensions\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>Geometry\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-orderresponse\">\u003Csummary>\u003Ccode>OrderResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateModified\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>code\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliveryItemCount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>orderItemCount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Total quantity of items ordered across all line items. Surfaced for list views.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>purchaseOrderNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>The customer's purchase order number, when this order was raised from a received customer PO.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>billing\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-pricedetailsresponse\" class=\"api-model-link\">\u003Ccode>PriceDetailsResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shippingCosts\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-ordershippingcostsresponse\" class=\"api-model-link\">\u003Ccode>OrderShippingCostsResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Unassigned\u003C\u002Fcode>, \u003Ccode>PendingCollection\u003C\u002Fcode>, \u003Ccode>PendingDelivery\u003C\u002Fcode>, \u003Ccode>Fulfilled\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>customerIpAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>serviceLevel\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ServiceLevel\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Standard\u003C\u002Fcode>, \u003Ccode>Express\u003C\u002Fcode>, \u003Ccode>SameDay\u003C\u002Fcode>, \u003Ccode>Overnight\u003C\u002Fcode>, \u003Ccode>TwoDay\u003C\u002Fcode>, \u003Ccode>InternationalStandard\u003C\u002Fcode>, \u003Ccode>InternationalExpress\u003C\u002Fcode>, \u003Ccode>OnDemand\u003C\u002Fcode>, \u003Ccode>Freight\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum WeightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Tonne\u003C\u002Fcode>, \u003Ccode>Pound\u003C\u002Fcode>, \u003Ccode>Stone\u003C\u002Fcode>, \u003Ccode>UsTon\u003C\u002Fcode>, \u003Ccode>ImperialTon\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum LengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Centimeter\u003C\u002Fcode>, \u003Ccode>Meter\u003C\u002Fcode>, \u003Ccode>Inch\u003C\u002Fcode>, \u003Ccode>Foot\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum OrderStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>New\u003C\u002Fcode>, \u003Ccode>PendingCollection\u003C\u002Fcode>, \u003Ccode>PendingDelivery\u003C\u002Fcode>, \u003Ccode>Complete\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>, \u003Ccode>PendingReturn\u003C\u002Fcode>, \u003Ccode>Returned\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Package\u003C\u002Fcode>, \u003Ccode>Pallet\u003C\u002Fcode>, \u003Ccode>Container\u003C\u002Fcode>, \u003Ccode>Miscellaneous\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentSubType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentSubType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>GeneralPackage\u003C\u002Fcode>, \u003Ccode>FoodDelivery\u003C\u002Fcode>, \u003Ccode>MedicalDelivery\u003C\u002Fcode>, \u003Ccode>GroceriesDelivery\u003C\u002Fcode>, \u003Ccode>StandardPallet\u003C\u002Fcode>, \u003Ccode>StandardInternationalPallet\u003C\u002Fcode>, \u003Ccode>StandardUsPallet\u003C\u002Fcode>, \u003Ccode>StandardEuroPallet\u003C\u002Fcode>, \u003Ccode>CustomPallet\u003C\u002Fcode>, \u003Ccode>General10Ft\u003C\u002Fcode>, \u003Ccode>General20Ft\u003C\u002Fcode>, \u003Ccode>HighCube20Ft\u003C\u002Fcode>, \u003Ccode>General40Ft\u003C\u002Fcode>, \u003Ccode>HighCube40Ft\u003C\u002Fcode>, \u003Ccode>General45Ft\u003C\u002Fcode>, \u003Ccode>HighCube45Ft\u003C\u002Fcode>, \u003Ccode>FlatRack20FtWithSides\u003C\u002Fcode>, \u003Ccode>FlatRack20FtWithoutSides\u003C\u002Fcode>, \u003Ccode>FlatRack40FtWithSides\u003C\u002Fcode>, \u003Ccode>FlatRack40FtWithoutSides\u003C\u002Fcode>, \u003Ccode>OpenTop20Ft\u003C\u002Fcode>, \u003Ccode>OpenTop40Ft\u003C\u002Fcode>, \u003Ccode>Reefer20Ft\u003C\u002Fcode>, \u003Ccode>Reefer40Ft\u003C\u002Fcode>, \u003Ccode>MiniVan\u003C\u002Fcode>, \u003Ccode>DryVan\u003C\u002Fcode>, \u003Ccode>Flatbed\u003C\u002Fcode>, \u003Ccode>Tanker\u003C\u002Fcode>, \u003Ccode>AutoHauler\u003C\u002Fcode>, \u003Ccode>BoxTruck\u003C\u002Fcode>, \u003Ccode>Trailer\u003C\u002Fcode>, \u003Ccode>LowBoy\u003C\u002Fcode>, \u003Ccode>Dumper\u003C\u002Fcode>, \u003Ccode>Pickup\u003C\u002Fcode>, \u003Ccode>TowTruck\u003C\u002Fcode>, \u003Ccode>DumpTruck\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfScheduledCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCreatedOnIntegration\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>effectiveDate\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDeliveryCompletion\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateImported\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>countryCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum CountryCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Invalid\u003C\u002Fcode>, \u003Ccode>Global\u003C\u002Fcode>, \u003Ccode>FallbackZa\u003C\u002Fcode>, \u003Ccode>Be\u003C\u002Fcode>, \u003Ccode>De\u003C\u002Fcode>, \u003Ccode>Lu\u003C\u002Fcode>, \u003Ccode>Nl\u003C\u002Fcode>, \u003Ccode>Za\u003C\u002Fcode>, \u003Ccode>Zw\u003C\u002Fcode>, \u003Ccode>Gb\u003C\u002Fcode>, \u003Ccode>Us\u003C\u002Fcode>, \u003Ccode>Zm\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>paymentProcessed\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>paymentUrl\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>integrationOrderUrl\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>multiCarrier\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currencyCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum CurrencyCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Invalid\u003C\u002Fcode>, \u003Ccode>Eur\u003C\u002Fcode>, \u003Ccode>Usd\u003C\u002Fcode>, \u003Ccode>Gbp\u003C\u002Fcode>, \u003Ccode>Zar\u003C\u002Fcode>, \u003Ccode>Zmw\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>paymentMethod\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum PaymentMethod\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Cash\u003C\u002Fcode>, \u003Ccode>Card\u003C\u002Fcode>, \u003Ccode>CashOnDelivery\u003C\u002Fcode>, \u003Ccode>CardOnDelivery\u003C\u002Fcode>, \u003Ccode>Eft\u003C\u002Fcode>, \u003Ccode>Crypto\u003C\u002Fcode>, \u003Ccode>Paypal\u003C\u002Fcode>, \u003Ccode>WireTransfer\u003C\u002Fcode>, \u003Ccode>DebitOrder\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>attachments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-metadatafileattachment\" class=\"api-model-link\">\u003Ccode>MetadataFileAttachment[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>orderItems\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-orderitemresponse\" class=\"api-model-link\">\u003Ccode>OrderItemResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>orderShipments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-ordershipmentresponse\" class=\"api-model-link\">\u003Ccode>OrderShipmentResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>destinationAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>originAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>originLocationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>The location\u002Fstore the order is attributed to (trace which store it came from).\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>originLocationTitle\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>sourceChannelId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>The sales channel (medium) the order came through.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>sourceChannelTitle\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>sourceChannel\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-saleschannelresponse\" class=\"api-model-link\">\u003Ccode>SalesChannelResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>customer\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-customerresponse\" class=\"api-model-link\">\u003Ccode>CustomerResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>carrierMetadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-ordercarriermetadata\" class=\"api-model-link\">\u003Ccode>OrderCarrierMetadata\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dimensionType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-dimensiontypewithsymbols\" class=\"api-model-link\">\u003Ccode>DimensionTypeWithSymbols\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currencyMetadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-currencyresponse\" class=\"api-model-link\">\u003Ccode>CurrencyResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentProviders\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveintegrationproviderresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveIntegrationProviderResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>packageSizes\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitivedimensionpreset\" class=\"api-model-link\">\u003Ccode>PrimitiveDimensionPreset[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>integrations\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-orderintegrationdetailsresponse\" class=\"api-model-link\">\u003Ccode>OrderIntegrationDetailsResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>metadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>map<string, string>\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-ordershipmentresponse\">\u003Csummary>\u003Ccode>OrderShipmentResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shipmentQuotation\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentquotationresponse\" class=\"api-model-link\">\u003Ccode>ShipmentQuotationResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>order\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-orderresponse\" class=\"api-model-link\">\u003Ccode>OrderResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shipment\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentProvider\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveintegrationproviderresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveIntegrationProviderResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>canModifyItems\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Whether the item set of this shipment can still be changed, through \u003Ccode>PUT \u002Forders\u002F{orderId}\u002Fshipments\u002F{shipmentId}\u002Fitems\u003C\u002Fcode>. False once the shipment leaves the Active status, or once a label, an invoice, a fulfillment request, an approved quotation, or a manual lock names the load it carries.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-ordershippingcostsresponse\">\u003Csummary>\u003Ccode>OrderShippingCostsResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>shippingSubTotal\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shippingDiscount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shippingTax\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shippingTotal\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-pricedetailsresponse\">\u003Csummary>\u003Ccode>PriceDetailsResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>subTotal\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalPrice\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalTax\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalDiscount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>discount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>discountType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum DiscountType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>None\u003C\u002Fcode>, \u003Ccode>Percentage\u003C\u002Fcode>, \u003Ccode>FixedValue\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>taxIncluded\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>taxRate\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>taxType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum TaxType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>None\u003C\u002Fcode>, \u003Ccode>Sales\u003C\u002Fcode>, \u003Ccode>Vat\u003C\u002Fcode>, \u003Ccode>Gst\u003C\u002Fcode>, \u003Ccode>Pst\u003C\u002Fcode>, \u003Ccode>Hst\u003C\u002Fcode>, \u003Ccode>Qst\u003C\u002Fcode>, \u003Ccode>Ist\u003C\u002Fcode>, \u003Ccode>Ust\u003C\u002Fcode>, \u003Ccode>Cst\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currency\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-currencyresponse\" class=\"api-model-link\">\u003Ccode>CurrencyResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-primitivedimensionpreset\">\u003Csummary>\u003Ccode>PrimitiveDimensionPreset\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weight\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>width\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>length\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>height\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Package\u003C\u002Fcode>, \u003Ccode>Pallet\u003C\u002Fcode>, \u003Ccode>Container\u003C\u002Fcode>, \u003Ccode>Miscellaneous\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum LengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Centimeter\u003C\u002Fcode>, \u003Ccode>Meter\u003C\u002Fcode>, \u003Ccode>Inch\u003C\u002Fcode>, \u003Ccode>Foot\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum WeightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Tonne\u003C\u002Fcode>, \u003Ccode>Pound\u003C\u002Fcode>, \u003Ccode>Stone\u003C\u002Fcode>, \u003Ccode>UsTon\u003C\u002Fcode>, \u003Ccode>ImperialTon\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-primitiveintegrationproviderresponse\">\u003Csummary>\u003Ccode>PrimitiveIntegrationProviderResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>configuredProviderId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>logoUrl\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-primitiveuserresponse\">\u003Csummary>\u003Ccode>PrimitiveUserResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>displayName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>firstName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lastName\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>email\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>phoneNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-productresponse\">\u003Csummary>\u003Ccode>ProductResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>code\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>sku\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>barcode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>upc\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>ean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>mpn\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>body\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>productLink\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>productType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ProductType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>FinishedGood\u003C\u002Fcode>, \u003Ccode>RawMaterial\u003C\u002Fcode>, \u003Ccode>Component\u003C\u002Fcode>, \u003Ccode>Consumable\u003C\u002Fcode>, \u003Ccode>Service\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ProductStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Active\u003C\u002Fcode>, \u003Ccode>Inactive\u003C\u002Fcode>, \u003Ccode>Discontinued\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>unit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum UnitOfMeasure\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Each\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>, \u003Ccode>Litre\u003C\u002Fcode>, \u003Ccode>Millilitre\u003C\u002Fcode>, \u003Ccode>Metre\u003C\u002Fcode>, \u003Ccode>Centimetre\u003C\u002Fcode>, \u003Ccode>SquareMetre\u003C\u002Fcode>, \u003Ccode>CubicMetre\u003C\u002Fcode>, \u003Ccode>Pair\u003C\u002Fcode>, \u003Ccode>Pack\u003C\u002Fcode>, \u003Ccode>Box\u003C\u002Fcode>, \u003Ccode>Roll\u003C\u002Fcode>, \u003Ccode>Sheet\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>purchasable\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>isSellable\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>isPurchasable\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>isTaxable\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requiresShipping\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalAvailableQuantity\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Available stock derived from the inventory ledger: the sum of (on-hand − reserved) across the product's inventory records at all locations.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalSold\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalSoldValue\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>onSale\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currentPrice\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ProductPriceDetailsResponse\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>traces\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ActionMessage[]\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Get the historical view of changes for this object\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>defaultImage\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-metadatafileattachment\" class=\"api-model-link\">\u003Ccode>MetadataFileAttachment\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>images\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-metadatafileattachment\" class=\"api-model-link\">\u003Ccode>MetadataFileAttachment[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>attachments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-metadatafileattachment\" class=\"api-model-link\">\u003Ccode>MetadataFileAttachment[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>geometry\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ProductGeometryFieldsResponse\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>integrations\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ProductIntegrationProviderResponse[]\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>locale\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>SymbolicLocaleMetadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dimensionPreset\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>DimensionPresetResponse\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dimensionPresets\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>DimensionPresetResponse[]\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>categories\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ProductCategoryPrimitive[]\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>supplier\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>SupplierResponse\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>group\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ProductGroupSummaryResponse\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>tags\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string[]\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>hasRating\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>rating\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>metadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>map<string, string>\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-saleschannelresponse\">\u003Csummary>\u003Ccode>SalesChannelResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum SalesChannelKind\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Direct\u003C\u002Fcode>, \u003Ccode>PointOfSale\u003C\u002Fcode>, \u003Ccode>Online\u003C\u002Fcode>, \u003Ccode>Marketplace\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>defaultLocationId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmentcommentresponse\">\u003Csummary>\u003Ccode>ShipmentCommentResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shipmentId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>comment\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>user\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveuserresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveUserResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmentdimensionsrequest\">\u003Csummary>\u003Ccode>ShipmentDimensionsRequest\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>weight\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>width\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>length\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>height\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum LengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Centimeter\u003C\u002Fcode>, \u003Ccode>Meter\u003C\u002Fcode>, \u003Ccode>Inch\u003C\u002Fcode>, \u003Ccode>Foot\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum WeightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Tonne\u003C\u002Fcode>, \u003Ccode>Pound\u003C\u002Fcode>, \u003Ccode>Stone\u003C\u002Fcode>, \u003Ccode>UsTon\u003C\u002Fcode>, \u003Ccode>ImperialTon\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>presetId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmentitemresponse\">\u003Csummary>\u003Ccode>ShipmentItemResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>orderItemId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>productId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quantity\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>unit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum UnitOfMeasure\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Each\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>, \u003Ccode>Litre\u003C\u002Fcode>, \u003Ccode>Millilitre\u003C\u002Fcode>, \u003Ccode>Metre\u003C\u002Fcode>, \u003Ccode>Centimetre\u003C\u002Fcode>, \u003Ccode>SquareMetre\u003C\u002Fcode>, \u003Ccode>CubicMetre\u003C\u002Fcode>, \u003Ccode>Pair\u003C\u002Fcode>, \u003Ccode>Pack\u003C\u002Fcode>, \u003Ccode>Box\u003C\u002Fcode>, \u003Ccode>Roll\u003C\u002Fcode>, \u003Ccode>Sheet\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>geometry\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-geometryfieldsresponse\" class=\"api-model-link\">\u003Ccode>GeometryFieldsResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>subTotal\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalPrice\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalTax\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalDiscount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>discount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>discountType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum DiscountType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>None\u003C\u002Fcode>, \u003Ccode>Percentage\u003C\u002Fcode>, \u003Ccode>FixedValue\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmentoverview\">\u003Csummary>\u003Ccode>ShipmentOverview\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>total\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>active\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>pending\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>closed\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>complete\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmentquotationresponse\">\u003Csummary>\u003Ccode>ShipmentQuotationResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>provider\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-primitiveintegrationproviderresponse\" class=\"api-model-link\">\u003Ccode>PrimitiveIntegrationProviderResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>items\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-fulfillmentitemresponse\" class=\"api-model-link\">\u003Ccode>FulfillmentItemResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requiredServices\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-fulfillmentproviderservicetypemodel\" class=\"api-model-link\">\u003Ccode>FulfillmentProviderServiceTypeModel[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requirements\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-fulfillmentrequirementtypemodel\" class=\"api-model-link\">\u003Ccode>FulfillmentRequirementTypeModel[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-collectionresponse\" class=\"api-model-link\">\u003Ccode>CollectionResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>delivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-deliveryresponse\" class=\"api-model-link\">\u003Ccode>DeliveryResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalDeclaredValue\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>isInternational\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>isApprovedByUser\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalItems\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>serviceLevelText\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>serviceLevel\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ServiceLevel\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Standard\u003C\u002Fcode>, \u003Ccode>Express\u003C\u002Fcode>, \u003Ccode>SameDay\u003C\u002Fcode>, \u003Ccode>Overnight\u003C\u002Fcode>, \u003Ccode>TwoDay\u003C\u002Fcode>, \u003Ccode>InternationalStandard\u003C\u002Fcode>, \u003Ccode>InternationalExpress\u003C\u002Fcode>, \u003Ccode>OnDemand\u003C\u002Fcode>, \u003Ccode>Freight\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Package\u003C\u002Fcode>, \u003Ccode>Pallet\u003C\u002Fcode>, \u003Ccode>Container\u003C\u002Fcode>, \u003Ccode>Miscellaneous\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>deliveryType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentDeliveryType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>DoorToDoor\u003C\u002Fcode>, \u003Ccode>DoorToCollectionPoint\u003C\u002Fcode>, \u003Ccode>CollectionPointToDoor\u003C\u002Fcode>, \u003Ccode>CollectionPointToCollectionPoint\u003C\u002Fcode>, \u003Ccode>DoorToPort\u003C\u002Fcode>, \u003Ccode>PortToDoor\u003C\u002Fcode>, \u003Ccode>PortToPort\u003C\u002Fcode>, \u003Ccode>LockerToLocker\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>weightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum WeightType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Kilogram\u003C\u002Fcode>, \u003Ccode>Tonne\u003C\u002Fcode>, \u003Ccode>Pound\u003C\u002Fcode>, \u003Ccode>Stone\u003C\u002Fcode>, \u003Ccode>UsTon\u003C\u002Fcode>, \u003Ccode>ImperialTon\u003C\u002Fcode>, \u003Ccode>Gram\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>lengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum LengthType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Centimeter\u003C\u002Fcode>, \u003Ccode>Meter\u003C\u002Fcode>, \u003Ccode>Inch\u003C\u002Fcode>, \u003Ccode>Foot\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>countryCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum CountryCode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Invalid\u003C\u002Fcode>, \u003Ccode>Global\u003C\u002Fcode>, \u003Ccode>FallbackZa\u003C\u002Fcode>, \u003Ccode>Be\u003C\u002Fcode>, \u003Ccode>De\u003C\u002Fcode>, \u003Ccode>Lu\u003C\u002Fcode>, \u003Ccode>Nl\u003C\u002Fcode>, \u003Ccode>Za\u003C\u002Fcode>, \u003Ccode>Zw\u003C\u002Fcode>, \u003Ccode>Gb\u003C\u002Fcode>, \u003Ccode>Us\u003C\u002Fcode>, \u003Ccode>Zm\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfEstimatedCollection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>The estimated collection and delivery dates, when they are known. They are null when no estimate exists. Do not substitute today's date.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfEstimatedDelivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currency\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-currencyresponse\" class=\"api-model-link\">\u003Ccode>CurrencyResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>subTotal\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalPrice\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalTax\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalDiscount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>discount\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>discountType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum DiscountType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>None\u003C\u002Fcode>, \u003Ccode>Percentage\u003C\u002Fcode>, \u003Ccode>FixedValue\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>taxIncluded\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shipment\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentresponse\" class=\"api-model-link\">\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmentresponse\">\u003Csummary>\u003Ccode>ShipmentResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateModified\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum FulfillmentType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Package\u003C\u002Fcode>, \u003Ccode>Pallet\u003C\u002Fcode>, \u003Ccode>Container\u003C\u002Fcode>, \u003Ccode>Miscellaneous\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ShipmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Active\u003C\u002Fcode>, \u003Ccode>PendingCollection\u003C\u002Fcode>, \u003Ccode>CollectionUnassigned\u003C\u002Fcode>, \u003Ccode>CollectionAssigned\u003C\u002Fcode>, \u003Ccode>CollectionRejected\u003C\u002Fcode>, \u003Ccode>CollectionException\u003C\u002Fcode>, \u003Ccode>CollectionFailedAttempt\u003C\u002Fcode>, \u003Ccode>Collected\u003C\u002Fcode>, \u003Ccode>AtHub\u003C\u002Fcode>, \u003Ccode>ReturnedToHub\u003C\u002Fcode>, \u003Ccode>InTransit\u003C\u002Fcode>, \u003Ccode>AtDestinationHub\u003C\u002Fcode>, \u003Ccode>DeliveryUnassigned\u003C\u002Fcode>, \u003Ccode>DeliveryAssigned\u003C\u002Fcode>, \u003Ccode>DeliveryRejected\u003C\u002Fcode>, \u003Ccode>DeliveryException\u003C\u002Fcode>, \u003Ccode>OutForDelivery\u003C\u002Fcode>, \u003Ccode>DeliveryFailedAttempt\u003C\u002Fcode>, \u003Ccode>InLocker\u003C\u002Fcode>, \u003Ccode>Delivered\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>hasDimensions\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfDeparture\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 100 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>providerServiceLevelId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>Uid\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>providerServiceLevelIdType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum UidType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Long\u003C\u002Fcode>, \u003Ccode>Guid\u003C\u002Fcode>, \u003Ccode>String\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>serviceLevel\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ServiceLevel\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Standard\u003C\u002Fcode>, \u003Ccode>Express\u003C\u002Fcode>, \u003Ccode>SameDay\u003C\u002Fcode>, \u003Ccode>Overnight\u003C\u002Fcode>, \u003Ccode>TwoDay\u003C\u002Fcode>, \u003Ccode>InternationalStandard\u003C\u002Fcode>, \u003Ccode>InternationalExpress\u003C\u002Fcode>, \u003Ccode>OnDemand\u003C\u002Fcode>, \u003Ccode>Freight\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>code\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 3000 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>handlingType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum HandlingType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Delivery\u003C\u002Fcode>, \u003Ccode>Collection\u003C\u002Fcode>, \u003Ccode>Unassigned\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>requiresApproval\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>boolean\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>totalDeclaredValue\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>quantityOfItems\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>trackingId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>barcode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>delivery\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-deliveryresponse\" class=\"api-model-link\">\u003Ccode>DeliveryResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>collection\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-collectionresponse\" class=\"api-model-link\">\u003Ccode>CollectionResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>currency\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-currencyresponse\" class=\"api-model-link\">\u003Ccode>CurrencyResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dispatch\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-dispatchresponse\" class=\"api-model-link\">\u003Ccode>DispatchResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>business\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-businessresponse\" class=\"api-model-link\">\u003Ccode>BusinessResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>customer\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-customerresponse\" class=\"api-model-link\">\u003Ccode>CustomerResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>items\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentitemresponse\" class=\"api-model-link\">\u003Ccode>ShipmentItemResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fulfillmentContacts\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-contactresponse\" class=\"api-model-link\">\u003Ccode>ContactResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>orderShipments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-ordershipmentresponse\" class=\"api-model-link\">\u003Ccode>OrderShipmentResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>waypoints\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-shipmentwaypointresponse\" class=\"api-model-link\">\u003Ccode>ShipmentWaypointResponse[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>metadata\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>map<string, string>\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>attachments\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-metadatafileattachment\" class=\"api-model-link\">\u003Ccode>MetadataFileAttachment[]\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmenttraceresponse\">\u003Csummary>\u003Ccode>ShipmentTraceResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>message\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>shipmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ShipmentStatus\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Unknown\u003C\u002Fcode>, \u003Ccode>Active\u003C\u002Fcode>, \u003Ccode>PendingCollection\u003C\u002Fcode>, \u003Ccode>CollectionUnassigned\u003C\u002Fcode>, \u003Ccode>CollectionAssigned\u003C\u002Fcode>, \u003Ccode>CollectionRejected\u003C\u002Fcode>, \u003Ccode>CollectionException\u003C\u002Fcode>, \u003Ccode>CollectionFailedAttempt\u003C\u002Fcode>, \u003Ccode>Collected\u003C\u002Fcode>, \u003Ccode>AtHub\u003C\u002Fcode>, \u003Ccode>ReturnedToHub\u003C\u002Fcode>, \u003Ccode>InTransit\u003C\u002Fcode>, \u003Ccode>AtDestinationHub\u003C\u002Fcode>, \u003Ccode>DeliveryUnassigned\u003C\u002Fcode>, \u003Ccode>DeliveryAssigned\u003C\u002Fcode>, \u003Ccode>DeliveryRejected\u003C\u002Fcode>, \u003Ccode>DeliveryException\u003C\u002Fcode>, \u003Ccode>OutForDelivery\u003C\u002Fcode>, \u003Ccode>DeliveryFailedAttempt\u003C\u002Fcode>, \u003Ccode>InLocker\u003C\u002Fcode>, \u003Ccode>Delivered\u003C\u002Fcode>, \u003Ccode>Cancelled\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>activityAction\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ShipmentActivityAction\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>None\u003C\u002Fcode>, \u003Ccode>StatusChange\u003C\u002Fcode>, \u003Ccode>AllocatedToDispatch\u003C\u002Fcode>, \u003Ccode>OnRoute\u003C\u002Fcode>, \u003Ccode>CloseToDestination\u003C\u002Fcode>, \u003Ccode>AtDestination\u003C\u002Fcode>, \u003Ccode>AtDepotCentre\u003C\u002Fcode>, \u003Ccode>Sorted\u003C\u002Fcode>, \u003Ccode>Scanned\u003C\u002Fcode>, \u003Ccode>SortingInProgress\u003C\u002Fcode>, \u003Ccode>OrderReceived\u003C\u002Fcode>, \u003Ccode>Delivered\u003C\u002Fcode>, \u003Ccode>Modified\u003C\u002Fcode>, \u003Ccode>Created\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>userId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>activityType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum ActivityType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>System\u003C\u002Fcode>, \u003Ccode>User\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-shipmentwaypointresponse\">\u003Csummary>\u003Ccode>ShipmentWaypointResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>segmentPosition\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>integer (int32)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCheckedIn\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCheckedOut\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateModified\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>address\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ca href=\"#model-addressresponse\" class=\"api-model-link\">\u003Ccode>AddressResponse\u003C\u002Fcode>\u003C\u002Fa>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-updateaddressrequest\">\u003Csummary>\u003Ccode>UpdateAddressRequest\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>placeId\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (string)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 100 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (string)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 50 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>website\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uri)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 100 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>fullAddress\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 500 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>street\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (string)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 80 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>suburb\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (string)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 80 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>city\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 80 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>country\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 80 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>postcode\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (postal-code)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 15 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>unit\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 10 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>number\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (postal-code)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 20 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>province\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (string)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: maximum 80 characters.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>latitude\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: minimum -90, maximum 90.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>longitude\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>number (double)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>Limits: minimum -180, maximum 180.\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003Cdetails class=\"api-model\" id=\"model-vehicleresponse\">\u003Csummary>\u003Ccode>VehicleResponse\u003C\u002Fcode>\u003C\u002Fsummary>\u003Cdiv class=\"api-table\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Field\u003C\u002Fth>\u003Cth>Type\u003C\u002Fth>\u003Cth>Description\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (uuid)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>licensePlate\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateOfLicenseExpiry\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>licenseDisc\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>vehicleIdentificationNumber\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>model\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>make\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>acquisitionDate\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>vehicleType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>enum VehicleType\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>One of: \u003Ccode>Motorcycle\u003C\u002Fcode>, \u003Ccode>LightMotorVehicle\u003C\u002Fcode>, \u003Ccode>HeavyMotorVehicleSub16\u003C\u002Fcode>, \u003Ccode>HeaveMotorVehicleOver16\u003C\u002Fcode>.\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateCreated\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003Ctr>\u003Ctd>\u003Ccode>dateModified\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>string (date-time)\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\u003C\u002Fdetails>\n\u003C\u002Fsection>",1790689646161]