[{"data":1,"prerenderedAt":431},["ShallowReactive",2],{"changelog:off-route":3,"\u002F":4,"docs-nav":380,"api-info":412},null,{"id":5,"title":6,"body":7,"cards":340,"description":361,"extension":362,"group":363,"hero":364,"icon":372,"meta":373,"navTitle":6,"navigation":74,"order":47,"path":374,"seo":375,"sitemap":376,"stem":378,"__hash__":379},"docs\u002Findex.md","Overview",{"type":8,"value":9,"toc":336},"minimark",[10,149,154,162,288,296,299,303,311,318,321,332],[11,12,15,30],"docs-quickstart",{"eyebrow":13,"title":14},"Quickstart","Your first request.",[16,17,18,19,23,24,29],"p",{},"One header, one ",[20,21,22],"code",{},"GET",". Lists are not wrapped in an envelope — the collection sits\nunder a name that says what it is, next to a cursor for paging. See\n",[25,26,28],"a",{"href":27},"\u002Fpagination","pagination"," for what to do with that cursor.",[31,32,34],"template",{"v-slot:code":33},"",[35,36,41],"pre",{"className":37,"code":38,"filename":39,"language":40,"meta":33,"style":33},"language-bash shiki shiki-themes github-dark github-dark","curl -H 'X-Cargoplot-Key: 1234|1a2b3c4d-5e6f-7890-abcd-ef1234567890' \\\n  'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment?limit=5'\n\n{\n  \"shipments\": [\n    { \"reference\": \"C3AT-XHM0\", \"status\": \"STATUS_ACTIVE\" }\n  ],\n  \"cursor\": { \"after\": \"eyJpZCI6NjUxfQ\" }\n}\n","GET \u002Fv1\u002Fshipment","bash",[20,42,43,63,69,76,83,95,118,124,143],{"__ignoreMap":33},[44,45,48,52,56,60],"span",{"class":46,"line":47},"line",1,[44,49,51],{"class":50},"sFR8T","curl",[44,53,55],{"class":54},"s8ozJ"," -H",[44,57,59],{"class":58},"s4wv1"," 'X-Cargoplot-Key: 1234|1a2b3c4d-5e6f-7890-abcd-ef1234567890'",[44,61,62],{"class":54}," \\\n",[44,64,66],{"class":46,"line":65},2,[44,67,68],{"class":58},"  'https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment?limit=5'\n",[44,70,72],{"class":46,"line":71},3,[44,73,75],{"emptyLinePlaceholder":74},true,"\n",[44,77,79],{"class":46,"line":78},4,[44,80,82],{"class":81},"suv1-","{\n",[44,84,86,89,92],{"class":46,"line":85},5,[44,87,88],{"class":50},"  \"shipments\"",[44,90,91],{"class":54},":",[44,93,94],{"class":81}," [\n",[44,96,98,101,104,106,109,112,115],{"class":46,"line":97},6,[44,99,100],{"class":81},"    { ",[44,102,103],{"class":50},"\"reference\"",[44,105,91],{"class":54},[44,107,108],{"class":58}," \"C3AT-XHM0\",",[44,110,111],{"class":58}," \"status\":",[44,113,114],{"class":58}," \"STATUS_ACTIVE\"",[44,116,117],{"class":58}," }\n",[44,119,121],{"class":46,"line":120},7,[44,122,123],{"class":81},"  ],\n",[44,125,127,130,132,135,138,141],{"class":46,"line":126},8,[44,128,129],{"class":50},"  \"cursor\"",[44,131,91],{"class":54},[44,133,134],{"class":58}," {",[44,136,137],{"class":58}," \"after\":",[44,139,140],{"class":58}," \"eyJpZCI6NjUxfQ\"",[44,142,117],{"class":58},[44,144,146],{"class":46,"line":145},9,[44,147,148],{"class":81},"}\n",[150,151,153],"h2",{"id":152},"what-it-covers","What it covers",[16,155,156,157,161],{},"Everything the API covers can be read. Inquiries can also be written: you can\nraise one, change it, cancel it and delete it, as in the app — see\n",[25,158,160],{"href":159},"\u002Finquiries","creating and updating inquiries",". Everything else is read-only.",[163,164,165,178],"table",{},[166,167,168],"thead",{},[169,170,171,175],"tr",{},[172,173,174],"th",{},"Resource",[172,176,177],{},"Endpoints",[179,180,181,196,206,233,252,265,278],"tbody",{},[169,182,183,187],{},[184,185,186],"td",{},"Shipments",[184,188,189,192,193],{},[20,190,191],{},"\u002Fv1\u002Fshipment",", ",[20,194,195],{},"\u002Fv1\u002Fshipment\u002F{shipment}",[169,197,198,201],{},[184,199,200],{},"Shipment tracking",[184,202,203],{},[20,204,205],{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Ftracking",[169,207,208,211],{},[184,209,210],{},"Inquiries",[184,212,213,192,216,219,220,192,223,226,227,192,230],{},[20,214,215],{},"\u002Fv1\u002Finquiry",[20,217,218],{},"\u002Fv1\u002Finquiry\u002F{inquiry}",", and to write: ",[20,221,222],{},"POST \u002Fv1\u002Finquiry",[20,224,225],{},"PATCH"," and ",[20,228,229],{},"DELETE \u002Fv1\u002Finquiry\u002F{inquiry}",[20,231,232],{},"POST \u002Fv1\u002Finquiry\u002F{inquiry}\u002Fcancel",[169,234,235,238],{},[184,236,237],{},"Invoices",[184,239,240,192,243,192,246,192,249],{},[20,241,242],{},"\u002Fv1\u002Finvoice",[20,244,245],{},"\u002Fv1\u002Finvoice\u002F{invoice}",[20,247,248],{},"\u002Fv1\u002Finvoice\u002F{invoice}\u002Fdownload",[20,250,251],{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Finvoice",[169,253,254,257],{},[184,255,256],{},"Documents",[184,258,259,192,262],{},[20,260,261],{},"\u002Fv1\u002Fshipment\u002F{shipment}\u002Fdocument",[20,263,264],{},"\u002Fv1\u002Fdocument\u002F{document}\u002Fdownload",[169,266,267,270],{},[184,268,269],{},"Your profile",[184,271,272,192,275],{},[20,273,274],{},"\u002Fv1\u002Fprofile\u002Fuser",[20,276,277],{},"\u002Fv1\u002Fprofile\u002Forganization",[169,279,280,283],{},[184,281,282],{},"Colleagues",[184,284,285],{},[20,286,287],{},"\u002Fv1\u002Fuser\u002F{user}",[16,289,290,291,295],{},"Responses are full of freight vocabulary: port codes, Incoterms, container\ntypes, milestone names. The ",[25,292,294],{"href":293},"\u002Fglossary","glossary"," explains all of it.",[16,297,298],{},"You see exactly what your account sees in the Cargoplot app — your own\norganisation's records, and nothing else. Invoices you have not been issued yet\nare not part of it, and a few document types are held back the same way the app\nholds them back.",[150,300,302],{"id":301},"base-url","Base URL",[35,304,309],{"className":305,"code":307,"language":308},[306],"language-text","https:\u002F\u002Fapi.cargoplot.com\n","text",[20,310,307],{"__ignoreMap":33},[16,312,313,314,317],{},"So a shipment list is ",[20,315,316],{},"https:\u002F\u002Fapi.cargoplot.com\u002Fv1\u002Fshipment",".",[16,319,320],{},"If you are pointing an agent or a generated client at this API, the one thing to\ngive it is the spec:",[16,322,323,331],{},[324,325,326],"strong",{},[25,327,329],{"href":328},"\u002Fopenapi.json",[20,330,328],{}," — the complete contract, generated from the\nAPI's own definitions on every deploy. Nothing here is hand-maintained, so it\ncannot describe a version we are no longer running.",[333,334,335],"style",{},"html pre.shiki code .sFR8T, html code.shiki .sFR8T{--shiki-default:#B392F0;--shiki-dark:#B392F0}html pre.shiki code .s8ozJ, html code.shiki .s8ozJ{--shiki-default:#79B8FF;--shiki-dark:#79B8FF}html pre.shiki code .s4wv1, html code.shiki .s4wv1{--shiki-default:#9ECBFF;--shiki-dark:#9ECBFF}html pre.shiki code .suv1-, html code.shiki .suv1-{--shiki-default:#E1E4E8;--shiki-dark:#E1E4E8}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":33,"searchDepth":65,"depth":65,"links":337},[338,339],{"id":152,"depth":65,"text":153},{"id":301,"depth":65,"text":302},[341,347,353],{"title":342,"text":343,"icon":344,"to":345,"cta":346},"API reference","Every endpoint, parameter and response, generated from the API's own definitions on each deploy.","mdi-code-braces","\u002Freference","Open the reference",{"title":348,"text":349,"icon":350,"to":351,"cta":352},"Authentication","Create a Personal Access Token in your profile and send it in one header. It works immediately.","mdi-key-variant","\u002Fauthentication","Get a token",{"title":354,"text":355,"icon":356,"to":357,"cta":358,"chipField":359,"chipSuffix":360},"Rate limits","What you may ask for, how to read your remaining allowance, and how to pace a job.","mdi-speedometer","\u002Frate-limits","See the limits","rate_limit.requests_per_minute","\u002Fmin","HTTP access to your shipments, tracking, inquiries, invoices and documents, and a way to raise inquiries from your own systems.","md","getting-started",{"eyebrow":365,"headline":366,"lede":367,"primary":368,"secondary":370},"Public API · v1","Your shipments, in your systems.","HTTP access to your shipments, tracking, inquiries, invoices and documents, and a way to raise inquiries from your own systems, with a token you create yourself. No integration project, no credentials to request from us.",{"label":369,"to":345},"Read the reference",{"label":371,"to":351},"Create a token","mdi-book-open-page-variant-outline",{},"\u002F",{"title":6,"description":361},{"loc":374,"lastmod":377},"2026-09-22","index","8-gU4a-OBZ1RgKaA1kSm09AsBn2ByR9H57l2MH63pIs",[381,382,383,388,392,395,396,399,403,406],{"path":374,"title":6,"navTitle":6,"icon":372,"group":363,"order":47},{"path":351,"title":348,"navTitle":3,"icon":350,"group":363,"order":65},{"path":384,"title":385,"navTitle":386,"icon":387,"group":363,"order":71},"\u002Fai-assistants","Connect an AI assistant","AI assistants","mdi-robot-outline",{"path":159,"title":389,"navTitle":210,"icon":390,"group":391,"order":78},"Creating and updating inquiries","mdi-file-document-edit-outline","working",{"path":393,"title":200,"navTitle":3,"icon":394,"group":391,"order":85},"\u002Ftracking","mdi-map-marker-path",{"path":357,"title":354,"navTitle":3,"icon":356,"group":391,"order":97},{"path":27,"title":397,"navTitle":3,"icon":398,"group":391,"order":120},"Pagination and filtering","mdi-filter-variant",{"path":400,"title":401,"navTitle":3,"icon":402,"group":391,"order":126},"\u002Ferrors","Errors","mdi-alert-outline",{"path":293,"title":404,"navTitle":3,"icon":405,"group":391,"order":145},"Glossary","mdi-book-alphabet",{"path":407,"title":408,"navTitle":3,"icon":409,"group":410,"order":411},"\u002Fversioning","Versioning","mdi-tag-outline","current",10,{"info":413,"live":430},{"base_url":414,"auth":415,"rate_limit":418,"write_rate_limit":423,"edge_rate_limit":424,"max_request_body_bytes":426,"request_timeout_seconds":420,"pagination":427},"https:\u002F\u002Fapi.cargoplot.com",{"header":416,"token_format":417},"X-Cargoplot-Key","\u003CuserID>|\u003Cuuid>",{"enabled":74,"requests_per_minute":419,"window_seconds":420,"scope":421,"enforced_per":422},500,60,"user","api_instance",{"enabled":74,"requests_per_minute":420,"window_seconds":420,"scope":421,"enforced_per":422},{"requests_per_minute_per_ip":419,"enforced_per":425},"gateway_instance",37748736,{"default_page_size":428,"max_page_size":429},50,100,false,1790859224270]