{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/mcp/tools/shipments/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#shipments-stops--carrier-assignments\" aria-label=\"shipments stops  carrier assignments 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=\"shipments-stops--carrier-assignments\"></div>Shipments, Stops &#x26; Carrier Assignments</h1>\n<p>This page covers tools in the Shipments, Stops, and Carrier Assignments domains.</p>\n<h2 style=\"position:relative;\"><a href=\"#shipment-tools\" aria-label=\"shipment tools 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=\"shipment-tools\"></div>Shipment Tools</h2>\n<table>\n<thead>\n<tr>\n<th>Tool</th>\n<th>Description</th>\n<th>Use Case</th>\n<th>Access</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">list_shipments</code></td>\n<td>List shipments with filters</td>\n<td>\"Show me all FTL shipments picked up in Texas this week\"</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">get_shipment</code></td>\n<td>Get a single shipment by ID</td>\n<td>Look up the full details of a specific shipment before taking action</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">get_shipment_summary</code></td>\n<td>Full snapshot — shipment + stops + carrier + tracking in one call</td>\n<td>Get everything you need about a shipment without chaining multiple calls</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">create_shipment</code></td>\n<td>Create a new shipment</td>\n<td>Programmatically create a shipment from an order or external trigger</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">update_shipment</code></td>\n<td>Update shipment fields</td>\n<td>Correct a pickup date, reference number, or freight details on an existing shipment</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">search_shipment_dashboard</code></td>\n<td>Search the shipment dashboard</td>\n<td>\"Find any shipments with BOL number 12345\"</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">bulk_action_shipments</code></td>\n<td>Apply a bulk action to multiple shipments</td>\n<td>Archive or update status across a batch of shipments at once</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">download_shipments_csv</code></td>\n<td>Download shipment data as CSV</td>\n<td>\"Pull a CSV export of all delivered shipments from last month\"</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">get_shipment_state_info</code></td>\n<td>Get valid next actions for a shipment's current status</td>\n<td>Check what operations are allowed before the agent attempts a write</td>\n<td>Read</td>\n</tr>\n</tbody>\n</table>\n<h2 style=\"position:relative;\"><a href=\"#stop-tools\" aria-label=\"stop tools 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=\"stop-tools\"></div>Stop Tools</h2>\n<table>\n<thead>\n<tr>\n<th>Tool</th>\n<th>Description</th>\n<th>Use Case</th>\n<th>Access</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">list_stops</code></td>\n<td>List all stops for a shipment</td>\n<td>Review pickup and delivery locations on a multi-stop shipment</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">get_stop</code></td>\n<td>Get a single stop by ID</td>\n<td>Retrieve the scheduled arrival window and address for a specific stop</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">update_stop</code></td>\n<td>Update stop fields</td>\n<td>Adjust a delivery appointment time or correct an address on a stop</td>\n<td>Write</td>\n</tr>\n</tbody>\n</table>\n<h2 style=\"position:relative;\"><a href=\"#carrier-assignment-tools\" aria-label=\"carrier assignment tools 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=\"carrier-assignment-tools\"></div>Carrier Assignment Tools</h2>\n<table>\n<thead>\n<tr>\n<th>Tool</th>\n<th>Description</th>\n<th>Use Case</th>\n<th>Access</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">get_carrier_assignment</code></td>\n<td>Get the current carrier assignment for a shipment</td>\n<td>\"Who is the assigned carrier for shipment SHP-99999?\"</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">create_carrier_assignment</code></td>\n<td>Assign a carrier to a shipment</td>\n<td>Tender a shipment to a carrier after rate shopping</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">update_carrier_assignment</code></td>\n<td>Update an existing carrier assignment</td>\n<td>Change the carrier or update pro number after initial assignment</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">remove_carrier_assignment</code></td>\n<td>Remove the carrier assignment from a shipment</td>\n<td>Unassign a carrier to re-tender a shipment to a different provider</td>\n<td>Write</td>\n</tr>\n</tbody>\n</table>","headings":[{"value":"Shipments, Stops & Carrier Assignments","depth":1},{"value":"Shipment Tools","depth":2},{"value":"Stop Tools","depth":2},{"value":"Carrier Assignment Tools","depth":2}]},"contentItem":{"data":{"lastModified":"2026-05-14T19:02:55.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"265a6d51-8d00-561c-a770-4b96a071c15d__redocly content/docs/mcp/tools/shipments/","seo":{"title":"Shipments, Stops & Carrier Assignments","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/mcp/tools/shipments.md","pageBaseUrl":"/docs/mcp/tools/shipments","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Shipments, Stops & Carrier Assignments","id":"shipments-stops--carrier-assignments"},{"depth":2,"value":"Shipment Tools","id":"shipment-tools"},{"depth":2,"value":"Stop Tools","id":"stop-tools"},{"depth":2,"value":"Carrier Assignment Tools","id":"carrier-assignment-tools"}]},"data":{"title":""},"catalogInfo":null,"link":"/docs/mcp/tools/shipments/","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"]}