{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/direct-carrier-connections/documents/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#document-retrieval\" aria-label=\"document retrieval permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"document-retrieval\"></div>Document Retrieval</h1>\n<p>Document retrieval pulls carrier-held documents for a shipment directly from the carrier — such as the Bill of Lading, Proof of Delivery (POD), and invoices — without needing to log into the carrier's own portal.</p>\n<h2 style=\"position:relative;\"><a href=\"#how-it-works\" aria-label=\"how it works permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"how-it-works\"></div>How it works</h2>\n<p>Request documents for a dispatched shipment, optionally specifying which document types you want. Shipwell fetches the requested documents from the carrier and returns them once available.</p>\n<h2 style=\"position:relative;\"><a href=\"#endpoints\" aria-label=\"endpoints permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"endpoints\"></div>Endpoints</h2>\n<ul>\n<li>\nPOST \n<code class=\"language-text\">/document_query/</code>\n — request documents for a shipment.\n</li>\n<li>\nGET \n<code class=\"language-text\">/document_query/{task_id}</code>\n — check status and get the list of documents returned.\n</li>\n<li>\nGET \n<code class=\"language-text\">/document_query/{task_id}/documents/{document_id}</code>\n — download a specific returned document.\n</li>\n<li>\nPOST \n<code class=\"language-text\">/dispatches/{dispatch_id}/documents</code>\n — send a document to the carrier for a dispatch.\n</li>\n</ul>\n<p>Retrieved documents appear on the shipment's <strong>Documents</strong> panel, alongside any other documents on the shipment:</p>\n<p><img src=\"/139109a8ddc7bc7e6a324205cc3dc37e/documents-panel.png\" alt=\"A shipment&#x27;s Documents panel showing a shipping label, rate confirmation, and bill of lading retrieved for the shipment\"></p>\n<h2 style=\"position:relative;\"><a href=\"#automatic-retrieval-on-delivery\" aria-label=\"automatic retrieval on delivery permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"automatic-retrieval-on-delivery\"></div>Automatic retrieval on delivery</h2>\n<p>Some documents, like the Proof of Delivery, can also be pulled automatically once a shipment is marked delivered — without needing to submit a separate document request.</p>\n<h2 style=\"position:relative;\"><a href=\"#sending-documents-to-a-carrier\" aria-label=\"sending documents to a carrier permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"sending-documents-to-a-carrier\"></div>Sending documents to a carrier</h2>\n<p>Document retrieval pulls documents <em>from</em> the carrier. Separately, some carriers also accept documents pushed <em>to</em> them — for example, sending a Bill of Lading or commercial invoice needed before pickup — using the <code class=\"language-text\">/dispatches/{dispatch_id}/documents</code> endpoint above.</p>\n<h2 style=\"position:relative;\"><a href=\"#api-reference\" aria-label=\"api reference permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"api-reference\"></div>API reference</h2>\n<p>Coming soon.</p>\n<h2 style=\"position:relative;\"><a href=\"#next-steps\" aria-label=\"next steps permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"next-steps\"></div>Next steps</h2>\n<p>See <a href=\"/docs/direct-carrier-connections/supported-carriers/\">Supported Carriers</a> for which carriers support document retrieval and eBOL.</p>","headings":[{"value":"Document Retrieval","depth":1},{"value":"How it works","depth":2},{"value":"Endpoints","depth":2},{"value":"Automatic retrieval on delivery","depth":2},{"value":"Sending documents to a carrier","depth":2},{"value":"API reference","depth":2},{"value":"Next steps","depth":2}]},"contentItem":{"data":{"lastModified":"2026-08-26T14:38:06.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"f1af727a-f92d-5797-a8e4-260c670a6f16__redocly content/docs/direct-carrier-connections/documents/","seo":{"title":"Documents","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/direct-carrier-connections/documents.md","pageBaseUrl":"/docs/direct-carrier-connections/documents","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Document Retrieval","id":"document-retrieval"},{"depth":2,"value":"How it works","id":"how-it-works"},{"depth":2,"value":"Endpoints","id":"endpoints"},{"depth":2,"value":"Automatic retrieval on delivery","id":"automatic-retrieval-on-delivery"},{"depth":2,"value":"Sending documents to a carrier","id":"sending-documents-to-a-carrier"},{"depth":2,"value":"API reference","id":"api-reference"},{"depth":2,"value":"Next steps","id":"next-steps"}]},"data":{"title":"Documents"},"catalogInfo":null,"link":"/docs/direct-carrier-connections/documents/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}