Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.
Quickstart Guide
API Keys
Postman Collection
Client Libraries (SDK)
MCP Server
API Status
API Portal
Release Notes
Support
How it works
Shippo’s API standardizes carrier processes and streamlines the complexities of shipping, so you can offer a best-in-class solution without the upkeep. Get set up quick and easy with a customized, single integration to 40+ carriers, with little maintenance required.This diagram illustrates how you can use the Shippo API to add shipping into your own application.Logistics Providers, E-commerce platforms, Marketplaces, and Retailers use Shippo to power their shipping capability.
Last modified on July 16, 2026
Was this page helpful?
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Shippo API Documentation","description":"Shippo is a multi-carrier shipping API for rates, labels, tracking, address validation, and customs across 40+ carriers, available over REST, official SDKs, or natural language through the hosted Shippo MCP server at mcp.shippo.com (OAuth) for AI assistants and agents.","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/shippo-f4b7b609/CzPpJjP8aG1OLSSj/logo/light.svg?fit=max\u0026auto=format\u0026n=CzPpJjP8aG1OLSSj\u0026q=85\u0026s=2fe6acfa46f91132348a2f3bf5f1b18a","dark":"https://mintcdn.com/shippo-f4b7b609/CzPpJjP8aG1OLSSj/logo/dark.svg?fit=max\u0026auto=format\u0026n=CzPpJjP8aG1OLSSj\u0026q=85\u0026s=3d04ad869d96fc212c40d790ac14a6ef"},"favicon":"https://mintcdn.com/shippo-f4b7b609/MNzp7C4JbkmwernT/favicon.svg?fit=max\u0026auto=format\u0026n=MNzp7C4JbkmwernT\u0026q=85\u0026s=5b633a85ae6f5c45472dcb5720a3caa6","navbar":{"primary":{"type":"button","label":"Get Started","href":"https://apps.goshippo.com/join"}},"seo":{"metatags":{"canonical":"https://docs.goshippo.com"},"organization":{"id":"https://goshippo.com/#organization","name":"Shippo","legalName":"Shippo, Inc.","url":"https://goshippo.com","logo":"https://docs.goshippo.com/logo/light.svg","sameAs":["https://www.linkedin.com/company/shippo","https://x.com/goshippo","https://github.com/goshippo"]},"indexing":"navigable"},"fonts":{"heading":{"family":"Rethink Sans","weight":700},"body":{"family":"Neue Haas Unica","weight":400,"source":"fonts/NeueHaasUnica-Regular.woff2","format":"woff2"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity",{"title":"Connect Shippo MCP","description":"Set up the hosted Shippo MCP server (mcp.shippo.com): rates, labels, and tracking from your AI client","icon":"sparkles","href":"https://docs.goshippo.com/guides/mcp-server"},"download-spec"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"instructions":"Shippo is a multi-carrier shipping API. For agent integrations that execute shipping operations (rates, labels, tracking, address validation, customs), connect the hosted Shippo MCP server at https://mcp.shippo.com (per-user OAuth; setup at /guides/mcp-server). To search and read this documentation from an agent, a docs search MCP is available at https://docs.goshippo.com/mcp. Shipping workflow knowledge (agent skills and a knowledge pack) is published at https://github.com/goshippo/ai. For REST integrations start at /guides/api-quickstart; test mode uses shippo_test_ API keys."},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shippo-f4b7b609","hasAudioNarration":false,"actualSubdomain":"shippo-f4b7b609","customDomains":["docs.goshippo.com"],"gitSource":{"type":"github","owner":"goshippo","repo":"api-metadata-specs","deployBranch":"master","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af5e5b6b51d0e31167bce53","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"Documentation","count":125},{"language":"default","tag":"API Reference","count":97},{"language":"default","tag":"Guides","count":91},{"language":"default","tag":"Shippo API","count":74},{"language":"default","tag":"Carriers","count":24},{"language":"default","tag":"Shipping Elements","count":20},{"language":"default","tag":"Shipments","count":16},{"language":"default","tag":"Concepts","count":15},{"language":"default","tag":"Reporting API","count":15},{"language":"default","tag":"Integration guides","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@shippo.com","showHelpButton":true}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"69b9aa85e87230effc9b2684","deploymentId":"69b97e1329ae8a96c1f2f28f","questionText":"Can you walk me through how to add a customs declaration?","status":"active","generatedBy":"manual","createdAt":"2026-03-17T19:24:53.544Z","updatedAt":"2026-03-17T19:24:53.544Z","__v":0},{"_id":"69b9aa56e87230effc9b25c8","deploymentId":"69b97e1329ae8a96c1f2f28f","questionText":"How can I check which carriers are enabled on my account?","status":"active","generatedBy":"manual","createdAt":"2026-03-17T19:24:06.090Z","updatedAt":"2026-03-18T00:30:13.282Z","__v":0},{"_id":"69b9aa4ee87230effc9b25a3","deploymentId":"69b97e1329ae8a96c1f2f28f","questionText":"How do I get started with purchasing a label?","status":"active","generatedBy":"manual","createdAt":"2026-03-17T19:23:58.178Z","updatedAt":"2026-03-17T19:23:58.178Z","__v":0}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"#navbar img{height:32px!important;width:auto!important}.dark .mdx-content img:not([class]),.dark .mdx-content img[class=\"\"],.dark article img:not([class]),.dark article img[class=\"\"]{background:rgba(255, 255, 255, 0.9);border-radius:8px;padding:12px}@font-face{font-family:\"Neue Haas Unica\";src:url(\"/fonts/NeueHaasUnica-SemiBold.woff2\") format(\"woff2\");font-weight:600 700;font-display:swap}strong,b{font-weight:600}.endpoint-table td:nth-child(2),.endpoint-table code{white-space:nowrap}.endpoint-table td:first-child{min-width:0}.workflow-table code{white-space:nowrap}.workflow-table td:nth-child(2){min-width:0}"}],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Welcome to the Shippo API","description":"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.","mode":"wide","href":"/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,OptimizedImage}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsxs(CardGroup,{cols:3,children:[_jsx(Card,{title:`Quickstart Guide`,icon:`rocket`,href:`/guides/api-quickstart`}),_jsx(Card,{title:`API Keys`,icon:`key`,href:`https://portal.goshippo.com/api-config/api`}),_jsx(Card,{title:`Postman Collection`,icon:`paper-plane`,href:`https://god.gw.postman.com/run-collection/22332580-e3f0581d-41f8-4c5c-894e-d9e22a87f6a5?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D22332580-e3f0581d-41f8-4c5c-894e-d9e22a87f6a5%26entityType%3Dcollection%26workspaceId%3Da131fa9b-fc39-440e-93bb-2586e9e1eb93`}),_jsx(Card,{title:`Client Libraries (SDK)`,icon:`code`,href:`/guides/client-libraries`}),_jsx(Card,{title:`MCP Server`,icon:`sparkles`,href:`/guides/mcp-server`}),_jsx(Card,{title:`API Status`,icon:`signal`,href:`https://status.goshippo.com/`}),_jsx(Card,{title:`API Portal`,icon:`browser`,href:`https://portal.goshippo.com/`}),_jsx(Card,{title:`Release Notes`,icon:`scroll`,href:`/api-concepts/api-change-log`}),_jsx(Card,{title:`Support`,icon:`headset`,href:`https://support.goshippo.com/hc/en-us`})]}),`\n`,_jsx(Heading,{level:`2`,id:`how-it-works`,children:`How it works`}),`\n`,_jsx(_components.p,{children:`Shippo’s API standardizes carrier processes and streamlines the complexities of shipping, so you can offer a best-in-class solution without the upkeep. Get set up quick and easy with a customized, single integration to 40+ carriers, with little maintenance required.`}),`\n`,_jsx(_components.p,{children:`This diagram illustrates how you can use the Shippo API to add shipping into your own application.`}),`\n`,_jsx(OptimizedImage,{src:`https://mintcdn.com/shippo-f4b7b609/o3pSHzWv8pMmorWX/images/ShippoAPIArch.svg?fit=max\u0026auto=format\u0026n=o3pSHzWv8pMmorWX\u0026q=85\u0026s=c903874c6aa456524741635416c2cdc9`,className:`mint-block dark:mint-hidden`,alt:`Shippo basic architecture`,\"data-og-width\":`1410`,width:`1410`,\"data-og-height\":`983`,height:`983`,\"data-path\":`images/ShippoAPIArch.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/shippo-f4b7b609/o3pSHzWv8pMmorWX/images/ShippoAPIArch.svg?w=280\u0026fit=max\u0026auto=format\u0026n=o3pSHzWv8pMmorWX\u0026q=85\u0026s=65346b5e909519247daebb9b842c127f 280w, https://mintcdn.com/shippo-f4b7b609/o3pSHzWv8pMmorWX/images/ShippoAPIArch.svg?w=560\u0026fit=max\u0026auto=format\u0026n=o3pSHzWv8pMmorWX\u0026q=85\u0026s=599aa0f0d84743a3420b2f8c4cfff5b3 560w, https://mintcdn.com/shippo-f4b7b609/o3pSHzWv8pMmorWX/images/ShippoAPIArch.svg?w=840\u0026fit=max\u0026auto=format\u0026n=o3pSHzWv8pMmorWX\u0026q=85\u0026s=d2780c561906c4201507823c84eaf629 840w, https://mintcdn.com/shippo-f4b7b609/o3pSHzWv8pMmorWX/images/ShippoAPIArch.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=o3pSHzWv8pMmorWX\u0026q=85\u0026s=53ce54a6874ab6df564acaa75120f9d6 1100w, https://mintcdn.com/shippo-f4b7b609/o3pSHzWv8pMmorWX/images/ShippoAPIArch.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=o3pSHzWv8pMmorWX\u0026q=85\u0026s=47c2be88966ee6a785b7575ad23c6689 1650w, https://mintcdn.com/shippo-f4b7b609/o3pSHzWv8pMmorWX/images/ShippoAPIArch.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=o3pSHzWv8pMmorWX\u0026q=85\u0026s=350a47f0acd73a1ff0f5d1f9740966ca 2500w`}),`\n`,_jsx(OptimizedImage,{src:`https://mintcdn.com/shippo-f4b7b609/QZyOMgc1Ea-sGHxH/images/ShippoAPIArch_dark.svg?fit=max\u0026auto=format\u0026n=QZyOMgc1Ea-sGHxH\u0026q=85\u0026s=d637d76a0e946335fc76e88be36ff73f`,className:`mint-hidden dark:mint-block`,alt:`Shippo basic architecture`,\"data-og-width\":`1410`,width:`1410`,\"data-og-height\":`983`,height:`983`,\"data-path\":`images/ShippoAPIArch_dark.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/shippo-f4b7b609/QZyOMgc1Ea-sGHxH/images/ShippoAPIArch_dark.svg?w=280\u0026fit=max\u0026auto=format\u0026n=QZyOMgc1Ea-sGHxH\u0026q=85\u0026s=49c014fbfe7acd1f3493bf2beec01c80 280w, https://mintcdn.com/shippo-f4b7b609/QZyOMgc1Ea-sGHxH/images/ShippoAPIArch_dark.svg?w=560\u0026fit=max\u0026auto=format\u0026n=QZyOMgc1Ea-sGHxH\u0026q=85\u0026s=220e6f24ec96b777bbe9daeb78d0c20d 560w, https://mintcdn.com/shippo-f4b7b609/QZyOMgc1Ea-sGHxH/images/ShippoAPIArch_dark.svg?w=840\u0026fit=max\u0026auto=format\u0026n=QZyOMgc1Ea-sGHxH\u0026q=85\u0026s=af33260ebc9439597cef3f371cb80195 840w, https://mintcdn.com/shippo-f4b7b609/QZyOMgc1Ea-sGHxH/images/ShippoAPIArch_dark.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=QZyOMgc1Ea-sGHxH\u0026q=85\u0026s=4c55a354878500f1ac4e239b32110f45 1100w, https://mintcdn.com/shippo-f4b7b609/QZyOMgc1Ea-sGHxH/images/ShippoAPIArch_dark.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=QZyOMgc1Ea-sGHxH\u0026q=85\u0026s=fb8acf436aeee7855de4c93eaa046def 1650w, https://mintcdn.com/shippo-f4b7b609/QZyOMgc1Ea-sGHxH/images/ShippoAPIArch_dark.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=QZyOMgc1Ea-sGHxH\u0026q=85\u0026s=f2f8a944c20a57e86f896d750d3f7d7a 2500w`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://goshippo.com/case-studies/shipbob/`,children:`Logistics Providers`}),`, `,_jsx(_components.a,{href:`https://goshippo.com/case-studies/weebly/`,children:`E-commerce platforms`}),`, `,_jsx(_components.a,{href:`https://goshippo.com/case-studies/mercari/`,children:`Marketplaces`}),`, and `,_jsx(_components.a,{href:`https://goshippo.com/case-studies/vnyl/`,children:`Retailers`}),` use Shippo to power their shipping capability.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Welcome to the Shippo API","description":"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.","mode":"wide","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"How it works","slug":"how-it-works","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-block {\n display: block\n}\n.mint-hidden {\n display: none\n}\n.dark\\:mint-block:is(.dark *) {\n display: block\n}\n.dark\\:mint-hidden:is(.dark *) {\n display: none\n}","subdomain":"shippo-f4b7b609","siteName":"Shippo API Documentation","title":"Welcome to the Shippo API - Shippo API Documentation","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-16T17:22:31.286Z","gitLastModified":"2026-07-16T17:21:31.000Z","originalFileLocation":"index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Shippo API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Welcome to the Shippo API - Shippo API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Shippo API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.goshippo.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shippo-f4b7b609.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Welcome+to+the+Shippo+API\u0026amp;description=Shippo+is+a+multi-carrier+shipping+API+for+40%2B+carriers%3A+rates%2C+labels%2C+tracking%2C+and+address+validation+over+REST%2C+SDKs%2C+or+the+hosted+MCP+server+for+AI+agents\u0026amp;theme=c2d74747aec556fcb7efd3ec\u0026amp;signature=7b08f1ae1028d6ce717817307b90ed8c51214dec3e5cf2329b1cb1dace9c5965\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Welcome to the Shippo API - Shippo API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shippo-f4b7b609.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=Welcome+to+the+Shippo+API\u0026amp;description=Shippo+is+a+multi-carrier+shipping+API+for+40%2B+carriers%3A+rates%2C+labels%2C+tracking%2C+and+address+validation+over+REST%2C+SDKs%2C+or+the+hosted+MCP+server+for+AI+agents\u0026amp;theme=c2d74747aec556fcb7efd3ec\u0026amp;signature=7b08f1ae1028d6ce717817307b90ed8c51214dec3e5cf2329b1cb1dace9c5965\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/shippo-f4b7b609/gcyqE9-1OT8BeY1o/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Shippo API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.goshippo.com\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://goshippo.com/#organization\",\"name\":\"Shippo\",\"legalName\":\"Shippo, Inc.\",\"url\":\"https://goshippo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.goshippo.com/logo/light.svg\"},\"sameAs\":[\"https://www.linkedin.com/company/shippo\",\"https://x.com/goshippo\",\"https://github.com/goshippo\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.goshippo.com#website\",\"name\":\"Shippo API Documentation\",\"url\":\"https://docs.goshippo.com\",\"publisher\":{\"@id\":\"https://goshippo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.goshippo.com/#webpage\",\"url\":\"https://docs.goshippo.com/\",\"name\":\"Welcome to the Shippo API\",\"description\":\"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.\",\"dateModified\":\"2026-07-16T17:21:31.000Z\",\"isPartOf\":{\"@id\":\"https://docs.goshippo.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.goshippo.com/#article\",\"headline\":\"Welcome to the Shippo API\",\"name\":\"Welcome to the Shippo API\",\"description\":\"Shippo is a multi-carrier shipping API for 40+ carriers: rates, labels, tracking, and address validation over REST, SDKs, or the hosted MCP server for AI agents.\",\"url\":\"https://docs.goshippo.com/\",\"mainEntityOfPage\":{\"@id\":\"https://docs.goshippo.com/#webpage\"},\"dateModified\":\"2026-07-16T17:21:31.000Z\",\"publisher\":{\"@id\":\"https://goshippo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.goshippo.com#website\"}}]}\u003c/script>","agentPointerHref":"/index.md","siteName":"Shippo API Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Overview","pages":[{"title":"Welcome to the Shippo API","mode":"wide","href":""},{"title":"API quickstart","description":"Make your first Shippo API call by creating an address, setting up your token, and testing a request.","href":"/guides/api-quickstart"},{"title":"Choose your API workflow","href":"/guides/choose-your-api-workflow"},{"title":"Endpoint quick reference","mode":"wide","href":"/guides/endpoint-quick-reference"},{"title":"Choosing your integration path","href":"/guides/integration-paths"}]},{"group":"Get started","pages":[{"group":"First label","pages":[{"title":"Generate your first label","href":"/guides/generate-shipping-label"},{"title":"Generate your first label using Postman","href":"/guides/generate-shipping-label-postman"},{"title":"Instalabel - single call label creation","href":"/guides/single-call"},{"title":"Testing the Shippo API","href":"/guides/testing"}]},{"group":"Authentication","pages":[{"title":"Authentication","href":"/guides/authentication"},{"title":"Authentication using JWT","href":"/guides/authentication-using-jwt"}]},{"group":"Client libraries","pages":[{"title":"SDKs","href":"/guides/client-libraries"}]},{"group":"Use cases","pages":[{"title":"Get a shipping label","href":"/stories/single-rating-guide"},{"title":"Split a shipment into multiple packages","href":"/stories/multi-piece-guide"},{"title":"Ship to international customers","href":"/stories/intl-rating-guide"}]}]},{"group":"AI \u0026 agents","pages":[{"title":"MCP Server","href":"/guides/mcp-server"},{"title":"Features","href":"/guides/mcp-server-features"},{"title":"Get connected","href":"/guides/mcp-server-setup"},{"title":"Additional resources","href":"/guides/mcp-server-resources"}]},{"group":"Guides","pages":[{"group":"Platform Accounts","expanded":false,"pages":[{"title":"Platform Accounts","href":"/platform-accounts/platform-accounts"},{"title":"Upgrade to a Platform Account","href":"/platform-accounts/platform-upgrade-account"},{"title":"Using your Platform Account","href":"/platform-accounts/platform-using-accounts"},{"title":"Migrating from Platform API to Shippo API","href":"/platform-accounts/platform-api-migrate"}]},{"group":"Addresses","expanded":false,"pages":[{"title":"Address validation","href":"/addresses/address-validation"}]},{"group":"Addresses (v2)","expanded":false,"pages":[{"title":"Addresses API introduction","href":"/address-api/address-intro"},{"title":"Address book","href":"/address-api/address-book"},{"title":"Address parser","href":"/address-api/address-parser"},{"title":"Address validation","href":"/address-api/address-validate"}]},{"group":"Shipments","expanded":false,"pages":[{"title":"Create a shipment","href":"/shipments/shipments"},{"title":"Shipping label sizes","href":"/shipments/shipping-label-sizes"},{"title":"QR codes","href":"/shipments/qr-code"},{"title":"Returns","href":"/shipments/returns"},{"title":"Drop off and Pickup","href":"/shipments/dropoff-pickup"},{"title":"Alcohol shipments","href":"/shipments/alcohol-shipments"},{"title":"Batch label creation","href":"/shipments/batch-label-creation"},{"title":"Dry ice shipments","href":"/shipments/dry-ice-shipment"},{"title":"Multi-piece shipment","href":"/shipments/multi-piece-shipment"},{"title":"Shipping insurance","href":"/shipments/shipping-insurance"},{"title":"Hazardous or dangerous materials shipping","href":"/shipments/hazmat"},{"title":"Rate shopping with carriers","href":"/shipments/rate-shopping-with-carriers"},{"title":"Saturday delivery","href":"/shipments/saturday-delivery"}]},{"group":"Track packages","expanded":false,"pages":[{"title":"Tracking","href":"/tracking/tracking"},{"title":"Tracking Carriers","href":"/tracking/tracking-carriers"},{"title":"Tracking carriers using webhooks","href":"/tracking/tracking-carrier"},{"title":"Tracking email notifications","href":"/tracking/tracking-email-notifications"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Webhooks","href":"/tracking/webhooks"},{"title":"Webhook metadata","href":"/tracking/webhook-metadata"},{"title":"Webhook debugging","href":"/tracking/webhook-debugging"},{"title":"Accessing webhook subscriptions","href":"/tracking/creating-webhooks"},{"title":"Webhook security","href":"/tracking/webhook-security"}]},{"group":"International shipping","expanded":false,"pages":[{"title":"International shipping","href":"/international-shipping/international-shipping"}]},{"group":"Carriers","expanded":false,"pages":[{"title":"Carrier accounts","href":"/carriers/carrier-accounts"},{"title":"Carrier capabilities","href":"/carriers/carrier-capabilities"},{"title":"Carrier reference fields","href":"/carriers/carrier-reference-fields"},{"group":"APG","expanded":false,"pages":[{"title":"Get your Carrier Account Details","href":"/carriers/integration-guides/apg/create-an-account"},{"title":"Create shipment","href":"/carriers/integration-guides/apg/create-shipment"},{"title":"Purchase label","href":"/carriers/integration-guides/apg/purchase-label"},{"title":"Multi-parcel support","href":"/carriers/integration-guides/apg/multiparcel-support"},{"title":"Weights and dimensions rules","href":"/carriers/integration-guides/apg/weights-and-dimensions-rules"}]},{"group":"Better Trucks","expanded":false,"pages":[{"title":"Get your Carrier Account Details","href":"/carriers/integration-guides/better-trucks/create-an-account"},{"title":"Create shipment","href":"/carriers/integration-guides/better-trucks/create-shipment"},{"title":"Purchase label","href":"/carriers/integration-guides/better-trucks/purchase-label"},{"title":"Track","href":"/carriers/integration-guides/better-trucks/track"}]},{"group":"Colissimo","expanded":false,"pages":[{"title":"Get your Carrier Account Details","href":"/carriers/integration-guides/colissimo/create-an-account"},{"title":"Create shipment","href":"/carriers/integration-guides/colissimo/create-shipment"},{"title":"Purchase label","href":"/carriers/integration-guides/colissimo/purchase-label"}]},{"group":"Royal Mail Tracked","expanded":false,"pages":[{"title":"Terms Acceptance","href":"/carriers/integration-guides/royal-mail-tracked/terms-and-conditions-acceptance"},{"title":"Create shipment","href":"/carriers/integration-guides/royal-mail-tracked/create-shipment"},{"title":"Purchase label","href":"/carriers/integration-guides/royal-mail-tracked/purchase-label"},{"title":"Tracking","href":"/carriers/integration-guides/royal-mail-tracked/track"}]},{"title":"ePost Global","href":"/carriers/e-post-global"},{"title":"DHL eCommerce","href":"/carriers/dh-le-commerce"},{"title":"UPS Mail Innovations","href":"/carriers/ups-mail-innovations"},{"title":"Carrier authorization using OAuth","href":"/carriers/carrier-o-auth"},{"title":"Migrating to the new OnTrac API","href":"/carriers/ontrac-lasership-v3-migration-guide"}]},{"group":"Manifests and pickups","expanded":false,"pages":[{"title":"Manifests and SCAN forms","href":"/manifests-and-pickups/manifest-and-scan-forms"},{"title":"Pickups","href":"/manifests-and-pickups/pickups"}]},{"group":"Orders","expanded":false,"pages":[{"title":"Orders","href":"/orders/orders"}]},{"group":"Billing","expanded":false,"pages":[{"title":"Refunding labels","href":"/billing-and-invoices/refunding-labels"}]},{"group":"Estimate","pages":[{"title":"Estimate","href":"/estimate/estimate"},{"title":"Supported service levels","href":"/estimate/supported-service-levels"},{"title":"Rate shop with delivery dates","sidebarTitle":"Rate shop with delivery dates","href":"/estimate/rate-shop-with-delivery-dates"},{"title":"Display a delivery date","sidebarTitle":"Display a delivery date","href":"/estimate/display-a-delivery-date"},{"title":"Filter by required delivery date","sidebarTitle":"Filter by required delivery date","href":"/estimate/filter-by-delivery-date"},{"title":"Schedule warehouse ship-out dates","sidebarTitle":"Schedule warehouse ship-out dates","href":"/estimate/schedule-warehouse-ship-dates"},{"title":"Use high-confidence estimates","sidebarTitle":"Use high-confidence estimates","href":"/estimate/use-high-confidence-estimates"}]},{"group":"Automations","tag":"Beta","pages":[{"title":"Automations","sidebarTitle":"Automations","href":"/automations/automations"}]},{"group":"Reporting API","hidden":false,"expanded":false,"pages":[{"title":"Reporting API overview","href":"/reporting-api/overview"},{"title":"Reporting API Quickstart","href":"/reporting-api/quickstart"},{"title":"Core Concepts","href":"/reporting-api/concepts"},{"title":"Discover available reports","href":"/reporting-api/discover-reports"},{"title":"Create and poll a report run","href":"/reporting-api/create-and-poll"},{"title":"Date intervals","href":"/reporting-api/intervals"},{"title":"Download report files","href":"/reporting-api/download-artifacts"},{"title":"Reporting API Errors and Troubleshooting","href":"/reporting-api/errors"},{"title":"Tracking report","href":"/reporting-api/tracking-report"},{"title":"Migrate from the Invoice API","href":"/reporting-api/migrate-from-invoice-api"}]},{"group":"Integration guides","expanded":false,"pages":[{"title":"Shippo API Integration Guide","href":"/partner-integration/intro"},{"title":"Prerequisites","href":"/partner-integration/prereqs"},{"title":"Where to Get Information","href":"/partner-integration/get-info"},{"title":"Integration Foundation Decisions","href":"/partner-integration/int-decisions"},{"title":"Business Cases for the Shippo API","href":"/partner-integration/business-cases"},{"title":"Designing Your Shipping Solution","href":"/partner-integration/design-solution"},{"title":"Choosing Business Cases/User Stories","href":"/partner-integration/choosing-business-cases"},{"title":"Data flow sequence","href":"/partner-integration/flow"},{"title":"OAuth","href":"/o-auth-integrations/o-auth"},{"title":"Test an OAuth integration with a JWT","href":"/o-auth-integrations/testing-with-jwt"},{"title":"Appendix","href":"/partner-integration/appendix"},{"title":"Sandbox testing","href":"/partner-integration/sandbox-testing"},{"title":"Test plan","href":"/partner-integration/test-plan"}]}]},{"group":"Concepts","pages":[{"title":"Shippo API release notes","href":"/api-concepts/api-change-log"},{"title":"Glossary","href":"/api-concepts/glossary"},{"title":"API versions","href":"/api-concepts/api-versioning"},{"title":"HTTP response status codes","href":"/api-concepts/apihttp-status-codes"},{"title":"Filtering","href":"/api-concepts/filtering"},{"title":"Expand response","href":"/api-concepts/api-expand"},{"title":"Rate limits","href":"/api-concepts/rate-limits"},{"title":"API objects","href":"/api-concepts/api-objects"},{"title":"Asynchronous API response handling","href":"/api-concepts/asynchronus-api-call"},{"title":"IP addresses and domains","href":"/api-concepts/ip-addresses-and-domains"},{"group":"Upgrading your API","pages":[{"title":"Shippo API upgrade guide","href":"/api-concepts/api-upgrade-guides/upgrade-guide"},{"title":"Upgrading from v20140211 to v20180208","href":"/api-concepts/api-upgrade-guides/v20140211-to-2018"},{"title":"Upgrading from v20161025 to v20180208","href":"/api-concepts/api-upgrade-guides/v20161025-to-2018"},{"title":"Upgrading from v20170329 to v20180208","href":"/api-concepts/api-upgrade-guides/v20170329-to-2018"},{"title":"Upgrading from v20170801 to v20180208","href":"/api-concepts/api-upgrade-guides/v20170801-to-2018"}]}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"tab":"Shipping Elements","pages":[{"title":"Shipping Elements","href":"/shipping-elements"}]}]},"basePath":"","title":"Welcome to the Shippo API - Shippo API Documentation","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-B3yYlvdS.js","lightbox-handle-r17bVUz3.js"]}