[{"data":1,"prerenderedAt":179},["ShallowReactive",2],{"duxt-navigation-docs_demo_api_main-docs_demo_api_main":3,"i-lucide:book-open-text":114,"i-lucide:plug":118,"i-lucide:tag":120,"i-lucide:chevron-right":122,"docs-fr-FR-\u002Fdemo\u002Fmain\u002Fapi\u002Fevents":124,"i-lucide:languages":153,"i-lucide:copy":155,"i-lucide:pencil":157,"i-lucide:menu":159,"i-lucide:chevron-down":161,"i-lucide:search":163,"i-simple-icons:github":165,"i-lucide:moon":167,"i-lucide:arrow-left":169,"i-lucide:arrow-right":171,"i-lucide:flask-conical":173,"i-flag:fr-4x3":175},[4],{"title":5,"path":6,"stem":7,"children":8,"page":113},"Demo","\u002Fdemo","demo",[9],{"title":10,"path":11,"stem":12,"children":13,"page":113},"Main","\u002Fdemo\u002Fmain","demo\u002Fmain",[14],{"title":15,"path":16,"stem":17,"children":18,"icon":20,"description":21},"Harbour","\u002Fdemo\u002Fmain\u002Fapi","demo\u002Fmain\u002Fapi\u002Findex",[19,22,54,66,78,90,101],{"title":15,"path":16,"stem":17,"icon":20,"description":21},null,"The next Harbour API, still being written.",{"title":23,"path":24,"stem":25,"children":26,"icon":20,"description":28},"Consignments","\u002Fdemo\u002Fmain\u002Fapi\u002Fconsignments","demo\u002Fmain\u002Fapi\u002F1.consignments\u002Findex",[27,29,34,39,44,49],{"title":23,"path":24,"stem":25,"icon":20,"description":28},"Everything that is a consignment — a load of freight, with a reference on it and a berth to end up at.",{"title":30,"path":31,"stem":32,"icon":20,"description":33},"List consignments","\u002Fdemo\u002Fmain\u002Fapi\u002Fconsignments\u002Flistconsignments","demo\u002Fmain\u002Fapi\u002F1.consignments\u002F1.listconsignments","Returns a page of consignments, newest first.",{"title":35,"path":36,"stem":37,"icon":20,"description":38},"Book a consignment","\u002Fdemo\u002Fmain\u002Fapi\u002Fconsignments\u002Fcreateconsignment","demo\u002Fmain\u002Fapi\u002F1.consignments\u002F2.createconsignment","Books one consignment and tells you where it ended up.",{"title":40,"path":41,"stem":42,"icon":20,"description":43},"Read a consignment","\u002Fdemo\u002Fmain\u002Fapi\u002Fconsignments\u002Fgetconsignment","demo\u002Fmain\u002Fapi\u002F1.consignments\u002F3.getconsignment","GET \u002Fconsignments\u002F{consignmentId}",{"title":45,"path":46,"stem":47,"icon":20,"description":48},"Update a consignment","\u002Fdemo\u002Fmain\u002Fapi\u002Fconsignments\u002Fupdateconsignment","demo\u002Fmain\u002Fapi\u002F1.consignments\u002F4.updateconsignment","The one FLAT body in this document, and deliberately so: every other request body here carries an array or a map, which the try-it client cannot draw as a form. Without this endpoint the form view — and the toggle between it and the JSON editor — would never render on this site, and a view nothing renders is a view whose failures nobody sees. Four properties, one of each kind of box: text, enum, boolean, number.",{"title":50,"path":51,"stem":52,"icon":20,"description":53},"Cancel a consignment","\u002Fdemo\u002Fmain\u002Fapi\u002Fconsignments\u002Fcancelconsignment","demo\u002Fmain\u002Fapi\u002F1.consignments\u002F5.cancelconsignment","Deprecated. Use the batch endpoint, which takes the same identifiers and reports what it could not do.",{"title":55,"path":56,"stem":57,"children":58,"icon":20,"description":60},"Vessels","\u002Fdemo\u002Fmain\u002Fapi\u002Fvessels","demo\u002Fmain\u002Fapi\u002F2.vessels\u002Findex",[59,61],{"title":55,"path":56,"stem":57,"icon":20,"description":60},"The ships consignments travel on, and what they are carrying.",{"title":62,"path":63,"stem":64,"icon":20,"description":65},"Replace a vessel's manifest","\u002Fdemo\u002Fmain\u002Fapi\u002Fvessels\u002Freplacemanifest","demo\u002Fmain\u002Fapi\u002F2.vessels\u002F1.replacemanifest","The whole manifest at once — a PUT, because half a manifest is not a smaller manifest, it is a wrong one.",{"title":67,"path":68,"stem":69,"children":70,"icon":20,"description":72},"Batches","\u002Fdemo\u002Fmain\u002Fapi\u002Fbatches","demo\u002Fmain\u002Fapi\u002F3.batches\u002Findex",[71,73],{"title":67,"path":68,"stem":69,"icon":20,"description":72},"Operations that act on many consignments at once.",{"title":74,"path":75,"stem":76,"icon":20,"description":77},"Run a batch","\u002Fdemo\u002Fmain\u002Fapi\u002Fbatches\u002Frunbatch","demo\u002Fmain\u002Fapi\u002F3.batches\u002F1.runbatch","Takes a list of instructions and applies them in order. This endpoint needs no authentication, which is why it takes nothing destructive.",{"title":79,"path":80,"stem":81,"children":82,"icon":20,"description":84},"Events","\u002Fdemo\u002Fmain\u002Fapi\u002Fevents","demo\u002Fmain\u002Fapi\u002F4.events\u002Findex",[83,85],{"title":79,"path":80,"stem":81,"icon":20,"description":84},"New in this line. A consignment's own history, as it happens, rather than a page of it fetched again and again.",{"title":86,"path":87,"stem":88,"icon":20,"description":89},"Follow a consignment","\u002Fdemo\u002Fmain\u002Fapi\u002Fevents\u002Fstreamconsignmentevents","demo\u002Fmain\u002Fapi\u002F4.events\u002F1.streamconsignmentevents","Holds the connection open and writes one event per line as the consignment moves, in the text\u002Fevent-stream format.",{"title":5,"path":91,"stem":92,"children":93,"icon":20,"description":95},"\u002Fdemo\u002Fmain\u002Fapi\u002Fdemo","demo\u002Fmain\u002Fapi\u002F5.demo\u002Findex",[94,96],{"title":5,"path":91,"stem":92,"icon":20,"description":95},"The one part of this document that is real: an endpoint this very site answers, so the try-it client on the landing page sends a request and gets something back rather than failing against a host that does not exist.",{"title":97,"path":98,"stem":99,"icon":20,"description":100},"Book a demo consignment","\u002Fdemo\u002Fmain\u002Fapi\u002Fdemo\u002Fechoconsignment","demo\u002Fmain\u002Fapi\u002F5.demo\u002F1.echoconsignment","Takes a consignment and hands it back with an id and a timestamp, exactly as POST \u002Fconsignments would — except that this one is answered, by this site.",{"title":102,"path":103,"stem":104,"children":105,"icon":20,"description":107},"Webhooks","\u002Fdemo\u002Fmain\u002Fapi\u002Fwebhooks","demo\u002Fmain\u002Fapi\u002F6.webhooks\u002Findex",[106,108],{"title":102,"path":103,"stem":104,"icon":20,"description":107},"",{"title":109,"path":110,"stem":111,"icon":20,"description":112},"A consignment changed","\u002Fdemo\u002Fmain\u002Fapi\u002Fwebhooks\u002Fpost-consignmentchanged","demo\u002Fmain\u002Fapi\u002F6.webhooks\u002F1.post-consignmentchanged","Sent to the address registered for your account whenever a consignment you can see changes. Answer with any 2xx.",false,{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":117},0,24,"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 5v16m4-8h2m-2-4h2m2.001 10A2 2 0 0 0 22 17V5a2 2 0 0 0-1.999-2L16 3.002A5 5 0 0 0 12 5a5 5 0 0 0-4-2H4a2 2 0 0 0-2 2v12a2 2 0 0 0 1.999 2H8a5 5 0 0 1 4 2a5 5 0 0 1 4-2zM6 13h2M6 9h2\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":119},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M12 22v-5m3-9V2m2 6a1 1 0 0 1 1 1v4a4 4 0 0 1-4 4h-4a4 4 0 0 1-4-4V9a1 1 0 0 1 1-1zM9 8V2\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":121},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12.586 2.586A2 2 0 0 0 11.172 2H4a2 2 0 0 0-2 2v7.172a2 2 0 0 0 .586 1.414l8.704 8.704a2.426 2.426 0 0 0 3.42 0l6.58-6.58a2.426 2.426 0 0 0 0-3.42z\"\u002F>\u003Ccircle cx=\"7.5\" cy=\"7.5\" r=\".5\" fill=\"currentColor\"\u002F>\u003C\u002Fg>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":123},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m9 18l6-6l-6-6\"\u002F>",{"page":125,"from":151,"asked":152},{"id":126,"title":79,"body":127,"compare":20,"contributors":20,"date":20,"description":84,"extension":145,"icon":20,"lastUpdated":20,"layout":20,"meta":146,"navigation":113,"path":80,"rawbody":147,"redirectFrom":20,"seo":148,"sitemap":149,"stem":81,"__hash__":150},"docs_demo_api_main\u002Fdemo\u002Fmain\u002Fapi\u002F4.events\u002Findex.md",{"type":128,"value":129,"toc":142},"minimark",[130],[131,132,134],"open-api-operations",{":operations":133},"[{\"method\":\"get\",\"path\":\"\u002Fconsignments\u002F{consignmentId}\u002Fevents\",\"kind\":\"operation\",\"summary\":\"Follow a consignment\",\"deprecated\":false,\"to\":\"\u002Fdemo\u002Fmain\u002Fapi\u002Fevents\u002Fstreamconsignmentevents\"}]",[135,136,137,141],"p",{},[138,139,140],"strong",{},"New in this line."," A consignment's own history, as it happens, rather\nthan a page of it fetched again and again.",{"title":107,"searchDepth":143,"depth":143,"links":144},2,[],"md",{},"---\ntitle: \"Events\"\ndescription: \"New in this line. A consignment's own history, as it happens, rather than a page of it fetched again and again.\"\n---\n\n:::open-api-operations\n---\noperations:\n  - method: get\n    path: \u002Fconsignments\u002F{consignmentId}\u002Fevents\n    kind: operation\n    summary: Follow a consignment\n    deprecated: false\n    to: \u002Fdemo\u002Fmain\u002Fapi\u002Fevents\u002Fstreamconsignmentevents\n---\n**New in this line.** A consignment's own history, as it happens, rather\nthan a page of it fetched again and again.\n:::\n",{"title":79,"description":84},{"loc":80},"MDiI3xt2KycBnXtLLw-pIhY4fvJQB2gswmu2XfCObAs","en-GB","fr-FR",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":154},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m5 8l6 6m-7 0l6-6l2-3M2 5h12M7 2h1m14 20l-5-10l-5 10m2-4h6\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":156},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"14\" height=\"14\" x=\"8\" y=\"8\" rx=\"2\" ry=\"2\"\u002F>\u003Cpath d=\"M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2\"\u002F>\u003C\u002Fg>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":158},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M21.174 6.812a1 1 0 0 0-3.986-3.987L3.842 16.174a2 2 0 0 0-.5.83l-1.321 4.352a.5.5 0 0 0 .623.622l4.353-1.32a2 2 0 0 0 .83-.497zM15 5l4 4\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":160},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M4 5h16M4 12h16M4 19h16\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":162},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m6 9l6 6l6-6\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":164},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"m21 21l-4.34-4.34\"\u002F>\u003Ccircle cx=\"11\" cy=\"11\" r=\"8\"\u002F>\u003C\u002Fg>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":166},"\u003Cpath fill=\"currentColor\" d=\"M12 .297c-6.63 0-12 5.373-12 12c0 5.303 3.438 9.8 8.205 11.385c.6.113.82-.258.82-.577c0-.285-.01-1.04-.015-2.04c-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729c1.205.084 1.838 1.236 1.838 1.236c1.07 1.835 2.809 1.305 3.495.998c.108-.776.417-1.305.76-1.605c-2.665-.3-5.466-1.332-5.466-5.93c0-1.31.465-2.38 1.235-3.22c-.135-.303-.54-1.523.105-3.176c0 0 1.005-.322 3.3 1.23c.96-.267 1.98-.399 3-.405c1.02.006 2.04.138 3 .405c2.28-1.552 3.285-1.23 3.285-1.23c.645 1.653.24 2.873.12 3.176c.765.84 1.23 1.91 1.23 3.22c0 4.61-2.805 5.625-5.475 5.92c.42.36.81 1.096.81 2.22c0 1.606-.015 2.896-.015 3.286c0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":168},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":170},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m12 19l-7-7l7-7m7 7H5\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":172},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M5 12h14m-7-7l7 7l-7 7\"\u002F>",{"left":115,"top":115,"width":116,"height":116,"rotate":115,"vFlip":113,"hFlip":113,"body":174},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M14 2v6a2 2 0 0 0 .245.96l5.51 10.08A2 2 0 0 1 18 22H6a2 2 0 0 1-1.755-2.96l5.51-10.08A2 2 0 0 0 10 8V2M6.453 15h11.094M8.5 2h7\"\u002F>",{"left":115,"top":115,"width":176,"height":177,"rotate":115,"vFlip":113,"hFlip":113,"body":178},640,480,"\u003Cpath fill=\"#000091\" d=\"M0 0h213.3v480H0z\"\u002F>\u003Cpath fill=\"#fff\" d=\"M213.3 0h213.4v480H213.3z\"\u002F>\u003Cpath fill=\"#e1000f\" d=\"M426.7 0H640v480H426.7z\"\u002F>",1789036111600]