{"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":""},"chroma":{"liveDeploymentHistoryId":"6adb772425425974785d62cf","collectionId":"6add1e6e-611f-4786-bfc7-9326ccec1faf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb772425425974785d62cf"},"feedback":{"thumbs":true,"agentFeedback":true,"contextualFeedback":{"allowEmail":true}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adb772425425974785d62cf","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Documentation","count":122},{"language":"default","tag":"API Reference","count":97},{"language":"default","tag":"Guides","count":88},{"language":"default","tag":"Shippo API","count":74},{"language":"default","tag":"Carriers","count":23},{"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":14},{"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":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","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}],"isAtlas":false,"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,.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}b,strong{font-weight:600}.endpoint-table code,.endpoint-table td:nth-child(2){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":"api-reference/estimates/create-estimates","slug":"/api-reference/estimates/create-estimates","pageMetadata":{"title":"Create Estimates","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/estimateapi/openapi.yaml post /v2/estimates","href":"/api-reference/estimates/create-estimates","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Estimates","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/estimateapi/openapi.yaml post /v2/estimates","href":"/api-reference/estimates/create-estimates","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Estimates"],"summary":"Create Estimates","operationId":"create_estimates","requestBody":"8e24430b-ca6a-4747-926e-62184c3003e6","responses":{"200":"983a0420-2d39-4ce2-bb2e-28ee8bd40c85","422":"8dd16470-894b-477f-aea3-caf2fbb6b8b4"},"method":"post","type":"path","servers":["7f41744c-3e99-4a1e-8506-580d55ffdffb"],"security":["27bbb537-0800-4b56-bcd0-cb1ae86ddd56"],"path":"/v2/estimates","baseUrlOptions":["https://api.goshippo.com"],"title":"Create Estimates","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"origin":{"properties":{"zip":{"type":"string","title":"Zip","isRequired":true,"uniqueKey":"origin.zip","typeLabel":"string"}},"type":"object","required":["zip"],"title":"Origin","isRequired":true,"uniqueKey":"origin","typeLabel":"Origin · object"},"destination":{"properties":{"zip":{"type":"string","title":"Zip","isRequired":true,"uniqueKey":"destination.zip","typeLabel":"string"}},"type":"object","required":["zip"],"title":"Destination","isRequired":true,"uniqueKey":"destination","typeLabel":"Destination · object"},"parcel":{"properties":{"length":{"type":"number","exclusiveMinimum":0,"title":"Length","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.length","typeLabel":"number"},"width":{"type":"number","exclusiveMinimum":0,"title":"Width","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.width","typeLabel":"number"},"height":{"type":"number","exclusiveMinimum":0,"title":"Height","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.height","typeLabel":"number"},"distance_unit":{"type":"string","enum":["mm","cm","m","in","ft","yd"],"title":"DistanceUnit","description":"Enumeration for distance units used in parcel details.","isRequired":true,"uniqueKey":"parcel.distance_unit","typeLabel":"enum\u003cstring>"},"weight":{"type":"number","exclusiveMinimum":0,"title":"Weight","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.weight","typeLabel":"number"},"mass_unit":{"type":"string","enum":["g","kg","lb","oz"],"title":"MassUnit","description":"Enumeration for mass units used in package weight specifications.","isRequired":true,"uniqueKey":"parcel.mass_unit","typeLabel":"enum\u003cstring>"}},"type":"object","required":["length","width","height","distance_unit","weight","mass_unit"],"title":"Parcel","isRequired":true,"uniqueKey":"parcel","typeLabel":"Parcel · object"},"planned_ship_date":{"type":"string","format":"date-time","title":"Planned Ship Date","isRequired":true,"uniqueKey":"planned_ship_date","typeLabel":"string\u003cdate-time>"},"latest_delivery_date":{"oneOf":[{"type":"string","title":"Latest Delivery Date","format":"date","uniqueKey":"latest_delivery_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Latest Delivery Date","uniqueKey":"latest_delivery_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"latest_delivery_date","typeLabel":"string\u003cdate> | null"},"servicelevel_tokens":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"servicelevel_tokens.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Servicelevel Tokens","default":[],"uniqueKey":"servicelevel_tokens.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Servicelevel Tokens","default":[],"uniqueKey":"servicelevel_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"servicelevel_tokens","typeLabel":"string[] | null"},"confidence_level":{"type":"string","enum":["TYPICAL","DEFAULT","HIGH"],"title":"ConfidenceLevel","default":"DEFAULT","uniqueKey":"confidence_level","typeLabel":"enum\u003cstring>"}},"type":"object","required":["origin","destination","parcel","planned_ship_date"],"title":"EstimatesV2Request","uniqueKey":"","typeLabel":"EstimatesV2Request · object"},"examples":{"Example":{"title":"Example","value":{"origin":{"zip":"\u003cstring>"},"destination":{"zip":"\u003cstring>"},"parcel":{"length":123,"width":123,"height":123,"weight":123},"planned_ship_date":"2023-11-07T05:31:56Z","latest_delivery_date":"2023-12-25","servicelevel_tokens":[],"confidence_level":"DEFAULT"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"983a0420-2d39-4ce2-bb2e-28ee8bd40c85":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"object_id":{"type":"string","format":"uuid","title":"Object Id","isRequired":true,"uniqueKey":"object_id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"origin":{"properties":{"zip":{"type":"string","title":"Zip","isRequired":true,"uniqueKey":"origin.zip","typeLabel":"string"}},"type":"object","required":["zip"],"title":"Origin","isRequired":true,"uniqueKey":"origin","typeLabel":"Origin · object"},"destination":{"properties":{"zip":{"type":"string","title":"Zip","isRequired":true,"uniqueKey":"destination.zip","typeLabel":"string"}},"type":"object","required":["zip"],"title":"Destination","isRequired":true,"uniqueKey":"destination","typeLabel":"Destination · object"},"parcel":{"properties":{"length":{"type":"number","exclusiveMinimum":0,"title":"Length","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.length","typeLabel":"number"},"width":{"type":"number","exclusiveMinimum":0,"title":"Width","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.width","typeLabel":"number"},"height":{"type":"number","exclusiveMinimum":0,"title":"Height","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.height","typeLabel":"number"},"distance_unit":{"type":"string","enum":["mm","cm","m","in","ft","yd"],"title":"DistanceUnit","description":"Enumeration for distance units used in parcel details.","isRequired":true,"uniqueKey":"parcel.distance_unit","typeLabel":"enum\u003cstring>"},"weight":{"type":"number","exclusiveMinimum":0,"title":"Weight","description":"Positive number. Up to 6 digits before and 4 digits after the decimal point.","isRequired":true,"uniqueKey":"parcel.weight","typeLabel":"number"},"mass_unit":{"type":"string","enum":["g","kg","lb","oz"],"title":"MassUnit","description":"Enumeration for mass units used in package weight specifications.","isRequired":true,"uniqueKey":"parcel.mass_unit","typeLabel":"enum\u003cstring>"}},"type":"object","required":["length","width","height","distance_unit","weight","mass_unit"],"title":"Parcel","isRequired":true,"uniqueKey":"parcel","typeLabel":"Parcel · object"},"planned_ship_date":{"type":"string","format":"date-time","title":"Planned Ship Date","isRequired":true,"uniqueKey":"planned_ship_date","typeLabel":"string\u003cdate-time>"},"servicelevel_tokens":{"items":{"type":"string","uniqueKey":"servicelevel_tokens.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Servicelevel Tokens","isRequired":true,"uniqueKey":"servicelevel_tokens","typeLabel":"string[]"},"messages":{"items":{"properties":{"code":{"type":"string","enum":["prediction_unavailable","servicelevel_unsupported"],"title":"MessageCode","description":"Closed enum of machine-readable codes for response messages.","isRequired":true,"uniqueKey":"messages.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"servicelevel_token":{"oneOf":[{"type":"string","title":"Servicelevel Token","uniqueKey":"messages.items.[INDEX].servicelevel_token.oneOf.0","typeLabel":"string"},{"type":"null","title":"Servicelevel Token","uniqueKey":"messages.items.[INDEX].servicelevel_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].servicelevel_token","typeLabel":"string | null"},"text":{"type":"string","title":"Text","default":"","uniqueKey":"messages.items.[INDEX].text","typeLabel":"string"}},"type":"object","required":["code"],"title":"Message","description":"A structured message entry, either for an individual service level or for the request as a whole.","uniqueKey":"messages.items.[INDEX]","typeLabel":"Message · object"},"type":"array","title":"Messages","isRequired":true,"uniqueKey":"messages","typeLabel":"Message · object[]"},"confidence_level":{"type":"string","enum":["TYPICAL","DEFAULT","HIGH"],"title":"ConfidenceLevel","isRequired":true,"uniqueKey":"confidence_level","typeLabel":"enum\u003cstring>"},"predictions":{"items":{"properties":{"provider":{"type":"string","title":"Provider","isRequired":true,"uniqueKey":"predictions.items.[INDEX].provider","typeLabel":"string"},"servicelevel":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"predictions.items.[INDEX].servicelevel.name","typeLabel":"string"},"token":{"type":"string","title":"Token","isRequired":true,"uniqueKey":"predictions.items.[INDEX].servicelevel.token","typeLabel":"string"}},"type":"object","required":["name","token"],"title":"ServiceLevel","isRequired":true,"uniqueKey":"predictions.items.[INDEX].servicelevel","typeLabel":"ServiceLevel · object"},"estimated_delivery_date_utc":{"type":"string","format":"date-time","title":"Estimated Delivery Date Utc","isRequired":true,"uniqueKey":"predictions.items.[INDEX].estimated_delivery_date_utc","typeLabel":"string\u003cdate-time>"},"estimated_transit_days":{"type":"number","title":"Estimated Transit Days","isRequired":true,"uniqueKey":"predictions.items.[INDEX].estimated_transit_days","typeLabel":"number"}},"type":"object","required":["provider","servicelevel","estimated_delivery_date_utc","estimated_transit_days"],"title":"Prediction","uniqueKey":"predictions.items.[INDEX]","typeLabel":"Prediction · object"},"type":"array","title":"Predictions","isRequired":true,"uniqueKey":"predictions","typeLabel":"Prediction · object[]"},"latest_delivery_date":{"oneOf":[{"type":"string","title":"Latest Delivery Date","format":"date","uniqueKey":"latest_delivery_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Latest Delivery Date","uniqueKey":"latest_delivery_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"latest_delivery_date","typeLabel":"string\u003cdate> | null"},"test":{"oneOf":[{"type":"boolean","title":"Test","uniqueKey":"test.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Test","uniqueKey":"test.oneOf.1","typeLabel":"null"}],"uniqueKey":"test","typeLabel":"boolean | null"}},"type":"object","required":["object_id","created_at","origin","destination","parcel","planned_ship_date","servicelevel_tokens","messages","confidence_level","predictions"],"title":"EstimatesV2Response","uniqueKey":"","typeLabel":"EstimatesV2Response · object"},"examples":{"Example":{"title":"Example","value":{"object_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_at":"2023-11-07T05:31:56Z","origin":{"zip":"\u003cstring>"},"destination":{"zip":"\u003cstring>"},"parcel":{"length":123,"width":123,"height":123,"distance_unit":"mm","weight":123,"mass_unit":"g"},"planned_ship_date":"2023-11-07T05:31:56Z","servicelevel_tokens":["\u003cstring>"],"messages":[{"code":"prediction_unavailable","servicelevel_token":"\u003cstring>","text":""}],"confidence_level":"TYPICAL","predictions":[{"provider":"\u003cstring>","servicelevel":{"name":"\u003cstring>","token":"\u003cstring>"},"estimated_delivery_date_utc":"2023-11-07T05:31:56Z","estimated_transit_days":123}],"latest_delivery_date":"2023-12-25","test":true}}},"exampleType":"generated"}},"exampleType":"generated"},"8dd16470-894b-477f-aea3-caf2fbb6b8b4":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"27bbb537-0800-4b56-bcd0-cb1ae86ddd56":{"Shippo_Token":{"description":"Enter your shippo token with the ShippoToken prefix.\n\nExample: `ShippoToken shippo_live_xxxx`\n","in":"header","name":"Authorization","type":"apiKey","x-default":"ShippoToken shippo_test_d41a6f04796998570c521a50828eae8e3cccf0eb","scopes":[]}}},"servers":{"7f41744c-3e99-4a1e-8506-580d55ffdffb":{"url":"https://api.goshippo.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Enter your shippo token with the ShippoToken prefix.\n\nExample: `ShippoToken shippo_live_xxxx`\n","in":"header","name":"Authorization","type":"apiKey","x-default":"ShippoToken shippo_test_d41a6f04796998570c521a50828eae8e3cccf0eb","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Enter your shippo token with the ShippoToken prefix.\n\nExample: `ShippoToken shippo_live_xxxx`\n","isRequired":true,"default":"ShippoToken shippo_test_d41a6f04796998570c521a50828eae8e3cccf0eb","typeLabel":"string","deprecated":false},"schemeName":"Shippo_Token","name":"Authorization"}],"title":"Shippo_Token"}]},"originalFileLocation":"api-reference/estimateapi/openapi.yaml"},"subdomain":"shippo-f4b7b609","siteName":"Shippo API Documentation","title":"Create Estimates - Shippo API Documentation","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/estimates/create-estimates.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=\"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=\"Create Estimates - Shippo API Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Shippo API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.goshippo.com/api-reference/estimates/create-estimates\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shippo-f4b7b609.mintlify.app/_mintlify/api/og/v2?division=Estimates\u0026amp;title=Create+Estimates\u0026amp;theme=376b22903894b16c95b28a54\u0026amp;signature=490944f840c459321f7c9cfaab30cfea0e62203e0fcbb3eaf6be7650c1e67eb7\">\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=\"Create Estimates - Shippo API Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shippo-f4b7b609.mintlify.app/_mintlify/api/og/v2?division=Estimates\u0026amp;title=Create+Estimates\u0026amp;theme=376b22903894b16c95b28a54\u0026amp;signature=490944f840c459321f7c9cfaab30cfea0e62203e0fcbb3eaf6be7650c1e67eb7\">\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/api-reference/estimates/create-estimates\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/estimates/create-estimates.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/api-reference/estimates/create-estimates#webpage\",\"url\":\"https://docs.goshippo.com/api-reference/estimates/create-estimates\",\"name\":\"Create Estimates\",\"isPartOf\":{\"@id\":\"https://docs.goshippo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.goshippo.com/api-reference/estimates/create-estimates#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.goshippo.com/api-reference/estimates/create-estimates#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shippo API Documentation\",\"item\":\"https://docs.goshippo.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Estimates\",\"item\":\"https://docs.goshippo.com/api-reference/estimates/create-estimates\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.goshippo.com/api-reference/estimates/create-estimates#apireference\",\"headline\":\"Create Estimates\",\"name\":\"Create Estimates\",\"url\":\"https://docs.goshippo.com/api-reference/estimates/create-estimates\",\"mainEntityOfPage\":{\"@id\":\"https://docs.goshippo.com/api-reference/estimates/create-estimates#webpage\"},\"publisher\":{\"@id\":\"https://goshippo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.goshippo.com#website\"}}]}\u003c/script>","siteName":"Shippo API Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference Overview","href":"/api-reference/overview"}]},{"group":"Shippo API","pages":[{"group":"Addresses","pages":[{"title":"List all addresses","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /addresses","href":"/api-reference/addresses/list-all-addresses"},{"title":"Create a new address","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /addresses","href":"/api-reference/addresses/create-a-new-address"},{"title":"Retrieve an address","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /addresses/{AddressId}","href":"/api-reference/addresses/retrieve-an-address"},{"title":"Validate an address","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /addresses/{AddressId}/validate","href":"/api-reference/addresses/validate-an-address"}]},{"group":"Batches","pages":[{"title":"Create a batch","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /batches","href":"/api-reference/batches/create-a-batch"},{"title":"Retrieve a batch","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /batches/{BatchId}","href":"/api-reference/batches/retrieve-a-batch"},{"title":"Add shipments to a batch","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /batches/{BatchId}/add_shipments","href":"/api-reference/batches/add-shipments-to-a-batch"},{"title":"Purchase a batch","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /batches/{BatchId}/purchase","href":"/api-reference/batches/purchase-a-batch"},{"title":"Remove shipments from a batch","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /batches/{BatchId}/remove_shipments","href":"/api-reference/batches/remove-shipments-from-a-batch"}]},{"group":"Carrier Accounts","pages":[{"title":"List all carrier accounts","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /carrier_accounts","href":"/api-reference/carrier-accounts/list-all-carrier-accounts"},{"title":"Create a new carrier account","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /carrier_accounts","href":"/api-reference/carrier-accounts/create-a-new-carrier-account"},{"title":"Retrieve a carrier account","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /carrier_accounts/{CarrierAccountId}","href":"/api-reference/carrier-accounts/retrieve-a-carrier-account"},{"title":"Update a carrier account","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml put /carrier_accounts/{CarrierAccountId}","href":"/api-reference/carrier-accounts/update-a-carrier-account"},{"title":"Connect an existing carrier account using OAuth 2.0","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /carrier_accounts/{CarrierAccountObjectId}/signin/initiate","href":"/api-reference/carrier-accounts/connect-an-existing-carrier-account-using-oauth-20"},{"title":"Add a Shippo carrier account","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /carrier_accounts/register/new","href":"/api-reference/carrier-accounts/add-a-shippo-carrier-account"},{"title":"Get Carrier Registration status","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /carrier_accounts/reg-status","href":"/api-reference/carrier-accounts/get-carrier-registration-status"}]},{"group":"Customs Declarations","pages":[{"title":"List all customs declarations","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /customs/declarations","href":"/api-reference/customs-declarations/list-all-customs-declarations"},{"title":"Create a new customs declaration","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /customs/declarations","href":"/api-reference/customs-declarations/create-a-new-customs-declaration"},{"title":"Retrieve a customs declaration","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /customs/declarations/{CustomsDeclarationId}","href":"/api-reference/customs-declarations/retrieve-a-customs-declaration"}]},{"group":"Customs Items","pages":[{"title":"List all customs items","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /customs/items","href":"/api-reference/customs-items/list-all-customs-items"},{"title":"Create a new customs item","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /customs/items","href":"/api-reference/customs-items/create-a-new-customs-item"},{"title":"Retrieve a customs item","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /customs/items/{CustomsItemId}","href":"/api-reference/customs-items/retrieve-a-customs-item"}]},{"group":"Embedded Authorization","pages":[{"title":"Create a JWT","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /embedded/authz","href":"/api-reference/embedded-authorization/create-a-jwt"}]},{"group":"Rates at Checkout","pages":[{"title":"Generate a live rates request","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /live-rates","href":"/api-reference/rates-at-checkout/generate-a-live-rates-request"},{"title":"Show current default parcel template","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /live-rates/settings/parcel-template","href":"/api-reference/rates-at-checkout/show-current-default-parcel-template"},{"title":"Update default parcel template","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml put /live-rates/settings/parcel-template","href":"/api-reference/rates-at-checkout/update-default-parcel-template"},{"title":"Clear current default parcel template","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml delete /live-rates/settings/parcel-template","href":"/api-reference/rates-at-checkout/clear-current-default-parcel-template"}]},{"group":"Manifests","pages":[{"title":"List all manifests","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /manifests","href":"/api-reference/manifests/list-all-manifests"},{"title":"Create a new manifest","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /manifests","href":"/api-reference/manifests/create-a-new-manifest"},{"title":"Retrieve a manifest","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /manifests/{ManifestId}","href":"/api-reference/manifests/retrieve-a-manifest"}]},{"group":"Orders","pages":[{"title":"List all orders","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /orders","href":"/api-reference/orders/list-all-orders"},{"title":"Create a new order","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /orders","href":"/api-reference/orders/create-a-new-order"},{"title":"Retrieve an order","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /orders/{OrderId}","href":"/api-reference/orders/retrieve-an-order"}]},{"group":"Carrier Parcel Templates","pages":[{"title":"List all carrier parcel templates","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /parcel-templates","href":"/api-reference/carrier-parcel-templates/list-all-carrier-parcel-templates"},{"title":"Retrieve a carrier parcel templates","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /parcel-templates/{CarrierParcelTemplateToken}","href":"/api-reference/carrier-parcel-templates/retrieve-a-carrier-parcel-templates"}]},{"group":"Parcels","pages":[{"title":"List all parcels","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /parcels","href":"/api-reference/parcels/list-all-parcels"},{"title":"Create a new parcel","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /parcels","href":"/api-reference/parcels/create-a-new-parcel"},{"title":"Retrieve an existing parcel","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /parcels/{ParcelId}","href":"/api-reference/parcels/retrieve-an-existing-parcel"}]},{"group":"Pickups","pages":[{"title":"Create a pickup","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /pickups","href":"/api-reference/pickups/create-a-pickup"}]},{"group":"Rates","pages":[{"title":"Retrieve a rate","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /rates/{RateId}","href":"/api-reference/rates/retrieve-a-rate"},{"title":"Retrieve shipment rates","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /shipments/{ShipmentId}/rates","href":"/api-reference/rates/retrieve-shipment-rates"},{"title":"Retrieve shipment rates in currency","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /shipments/{ShipmentId}/rates/{CurrencyCode}","href":"/api-reference/rates/retrieve-shipment-rates-in-currency"}]},{"group":"Refunds","pages":[{"title":"Create a refund","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /refunds","href":"/api-reference/refunds/create-a-refund"},{"title":"List all refunds","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /refunds/","href":"/api-reference/refunds/list-all-refunds"},{"title":"Retrieve a refund","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /refunds/{RefundId}","href":"/api-reference/refunds/retrieve-a-refund"}]},{"group":"Service Groups","pages":[{"title":"List all service groups","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /service-groups","href":"/api-reference/service-groups/list-all-service-groups"},{"title":"Update an existing service group","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml put /service-groups","href":"/api-reference/service-groups/update-an-existing-service-group"},{"title":"Create a new service group","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /service-groups","href":"/api-reference/service-groups/create-a-new-service-group"},{"title":"Delete a service group","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml delete /service-groups/{ServiceGroupId}","href":"/api-reference/service-groups/delete-a-service-group"}]},{"group":"Shipments","pages":[{"title":"List all shipments","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /shipments","href":"/api-reference/shipments/list-all-shipments"},{"title":"Create a new shipment","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /shipments","href":"/api-reference/shipments/create-a-new-shipment"},{"title":"Retrieve a shipment","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /shipments/{ShipmentId}","href":"/api-reference/shipments/retrieve-a-shipment"}]},{"group":"Tracking Status","pages":[{"title":"Register a tracking webhook","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /tracks","href":"/api-reference/tracking-status/register-a-tracking-webhook"},{"title":"Get a tracking status","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /tracks/{Carrier}/{TrackingNumber}","href":"/api-reference/tracking-status/get-a-tracking-status"}]},{"group":"Transactions","pages":[{"title":"List all shipping labels","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /transactions","href":"/api-reference/transactions/list-all-shipping-labels"},{"title":"Create a shipping label","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /transactions","href":"/api-reference/transactions/create-a-shipping-label"},{"title":"Retrieve a shipping label","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /transactions/{TransactionId}","href":"/api-reference/transactions/retrieve-a-shipping-label"}]},{"group":"User Parcel Templates","pages":[{"title":"List all user parcel templates","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /user-parcel-templates","href":"/api-reference/user-parcel-templates/list-all-user-parcel-templates"},{"title":"Create a new user parcel template","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /user-parcel-templates","href":"/api-reference/user-parcel-templates/create-a-new-user-parcel-template"},{"title":"Retrieves a user parcel template","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /user-parcel-templates/{UserParcelTemplateObjectId}","href":"/api-reference/user-parcel-templates/retrieves-a-user-parcel-template"},{"title":"Update an existing user parcel template","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml put /user-parcel-templates/{UserParcelTemplateObjectId}","href":"/api-reference/user-parcel-templates/update-an-existing-user-parcel-template"},{"title":"Delete a user parcel template","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml delete /user-parcel-templates/{UserParcelTemplateObjectId}","href":"/api-reference/user-parcel-templates/delete-a-user-parcel-template"}]},{"group":"Shippo Accounts","pages":[{"title":"List all Shippo Accounts","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /shippo-accounts","href":"/api-reference/shippo-accounts/list-all-shippo-accounts"},{"title":"Create a Shippo Account","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /shippo-accounts","href":"/api-reference/shippo-accounts/create-a-shippo-account"},{"title":"Retrieve a Shippo Account","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /shippo-accounts/{ShippoAccountId}","href":"/api-reference/shippo-accounts/retrieve-a-shippo-account"},{"title":"Update a Shippo Account","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml put /shippo-accounts/{ShippoAccountId}","href":"/api-reference/shippo-accounts/update-a-shippo-account"}]},{"group":"Webhooks","pages":[{"title":"List all webhooks","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /webhooks","href":"/api-reference/webhooks/list-all-webhooks"},{"title":"Create a new webhook","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /webhooks","href":"/api-reference/webhooks/create-a-new-webhook"},{"title":"Retrieve a specific webhook","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml get /webhooks/{webhookId}","href":"/api-reference/webhooks/retrieve-a-specific-webhook"},{"title":"Update an existing webhook","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml put /webhooks/{webhookId}","href":"/api-reference/webhooks/update-an-existing-webhook"},{"title":"Delete a specific webhook","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-a-specific-webhook"}]},{"group":"API Reference","pages":[{"title":"Batch","version":null,"deprecated":null,"openapi":"/spec/shippoapi/public-api.yaml webhook batch","href":"/api-reference/batch"},{"title":"Track","version":null,"deprecated":null,"openapi":"/spec/shippoapi/public-api.yaml webhook track","href":"/api-reference/track"},{"title":"Transaction","version":null,"deprecated":null,"openapi":"/spec/shippoapi/public-api.yaml webhook transaction","href":"/api-reference/transaction"}]}]},{"group":"Enums","pages":[{"title":"Service Levels","href":"/api-reference/service-levels/index"},{"title":"Parcel Templates","href":"/api-reference/parcel-templates/index"}]},{"group":"Service Levels","hidden":true,"pages":[{"title":"Airterra Service Levels","href":"/api-reference/service-levels/airterra"},{"title":"APC Postal Service Levels","href":"/api-reference/service-levels/apc-postal"},{"title":"APG Service Levels","href":"/api-reference/service-levels/apg"},{"title":"Asendia US Service Levels","href":"/api-reference/service-levels/asendia-us"},{"title":"Australia Post Service Levels","href":"/api-reference/service-levels/australia-post"},{"title":"Jitsu Service Levels","href":"/api-reference/service-levels/axlehire"},{"title":"BetterTrucks Service Levels","href":"/api-reference/service-levels/better-trucks"},{"title":"Canada Post Service Levels","href":"/api-reference/service-levels/canada-post"},{"title":"Chronopost Service Levels","href":"/api-reference/service-levels/chronopost"},{"title":"Colissimo Service Levels","href":"/api-reference/service-levels/colissimo"},{"title":"Correos España Service Levels","href":"/api-reference/service-levels/correos-espana"},{"title":"Deutsche Post Service Levels","href":"/api-reference/service-levels/deutsche-post"},{"title":"DHL eCommerce Service Levels","href":"/api-reference/service-levels/dhl-ecommerce"},{"title":"DHL Express Service Levels","href":"/api-reference/service-levels/dhl-express"},{"title":"DHL Germany Service Levels","href":"/api-reference/service-levels/dhl-germany"},{"title":"DPD GERMANY Service Levels","href":"/api-reference/service-levels/dpd-de"},{"title":"DPD UK Service Levels","href":"/api-reference/service-levels/dpd-uk"},{"title":"Aramex Service Levels","href":"/api-reference/service-levels/fastway-australia"},{"title":"FedEx Service Levels","href":"/api-reference/service-levels/fedex"},{"title":"Globegistics Service Levels","href":"/api-reference/service-levels/globegistics"},{"title":"GLS US Service Levels","href":"/api-reference/service-levels/gls-us"},{"title":"Evri UK Service Levels","href":"/api-reference/service-levels/hermes-uk"},{"title":"LaserShip Service Levels","href":"/api-reference/service-levels/lasership"},{"title":"LSO Service Levels","href":"/api-reference/service-levels/lso"},{"title":"Mondial Relay Service Levels","href":"/api-reference/service-levels/mondial-relay"},{"title":"OnTrac Service Levels","href":"/api-reference/service-levels/ontrac"},{"title":"Parcelforce Service Levels","href":"/api-reference/service-levels/parcelforce"},{"title":"Poste Italiane Service Levels","href":"/api-reference/service-levels/poste-italiane"},{"title":"Purolator Service Levels","href":"/api-reference/service-levels/purolator"},{"title":"Royal Mail Service Levels","href":"/api-reference/service-levels/royal-mail"},{"title":"Royal Mail Storefeeder Service Levels","href":"/api-reference/service-levels/royal-mail-sf"},{"title":"ePost Global Service Levels","href":"/api-reference/service-levels/rr-donnelley"},{"title":"Swyft Service Levels","href":"/api-reference/service-levels/swyft"},{"title":"UDS Service Levels","href":"/api-reference/service-levels/uds"},{"title":"UPS Service Levels","href":"/api-reference/service-levels/ups"},{"title":"USPS Service Levels","href":"/api-reference/service-levels/usps"},{"title":"Veho Service Levels","href":"/api-reference/service-levels/veho"}]},{"group":"Addresses API v2","pages":[{"group":"Validation","pages":[{"title":"Validate address","deprecated":null,"version":null,"openapi":"/api-reference/addressesapi/address_v2.yaml get /v2/addresses/validate","href":"/api-reference/validation/validate-address"}]},{"group":"Parser","pages":[{"title":"Parse Address","deprecated":null,"version":null,"openapi":"/api-reference/addressesapi/address_v2.yaml get /v2/addresses/parse","href":"/api-reference/parser/parse-address"}]},{"group":"Address Book","pages":[{"title":"Retrieve a single address","deprecated":null,"version":null,"openapi":"/api-reference/addressesapi/address_v2.yaml get /v2/addresses/{address_id}","href":"/api-reference/address-book/retrieve-a-single-address"},{"title":"Update an address","deprecated":null,"version":null,"openapi":"/api-reference/addressesapi/address_v2.yaml put /v2/addresses/{address_id}","href":"/api-reference/address-book/update-an-address"},{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/api-reference/addressesapi/address_v2.yaml delete /v2/addresses/{address_id}","href":"/api-reference/address-book/delete-an-address"},{"title":"Retrieve addresses","deprecated":null,"version":null,"openapi":"/api-reference/addressesapi/address_v2.yaml get /v2/addresses","href":"/api-reference/address-book/retrieve-addresses"},{"title":"Create a new address","deprecated":null,"version":null,"openapi":"/api-reference/addressesapi/address_v2.yaml post /v2/addresses","href":"/api-reference/address-book/create-a-new-address"}]}]},{"group":"Surcharges API","hidden":true,"pages":[{"group":"Surcharges","pages":[{"title":"List surcharge files","deprecated":null,"version":null,"openapi":"/api-reference/surchargesapi/openapi.yaml get /v2/reports/surcharges","href":"/api-reference/surcharges/list-surcharge-files"},{"title":"Retrieve surcharge file","deprecated":null,"version":null,"openapi":"/api-reference/surchargesapi/openapi.yaml get /v2/reports/surcharges/{file_id}","href":"/api-reference/surcharges/retrieve-surcharge-file"}]}]},{"group":"Reports API","hidden":true,"pages":[{"group":"Reports","pages":[{"title":"Return list of reports","deprecated":null,"version":null,"openapi":"/api-reference/shipporeports/openapi.yaml get /v2/reports/{report_type_uuid}/runs","href":"/api-reference/reports/return-list-of-reports"},{"title":"Download report","deprecated":null,"version":null,"openapi":"/api-reference/shipporeports/openapi.yaml get /v2/reports/{report_type_uuid}/runs/{report_run_uuid}/download","href":"/api-reference/reports/download-report"}]}]},{"group":"Reporting API","hidden":false,"pages":[{"group":"Report Runs","pages":[{"title":"List Report Runs","deprecated":null,"version":null,"openapi":"/api-reference/reporting-api/openapi.yaml get /v2/reporting/runs","href":"/api-reference/report-runs/list-report-runs"},{"title":"Create Report Run","deprecated":null,"version":null,"openapi":"/api-reference/reporting-api/openapi.yaml post /v2/reporting/runs","href":"/api-reference/report-runs/create-report-run"},{"title":"Get Report Run","deprecated":null,"version":null,"openapi":"/api-reference/reporting-api/openapi.yaml get /v2/reporting/runs/{run_id}","href":"/api-reference/report-runs/get-report-run"}]},{"group":"Reports","pages":[{"title":"List Report Types","deprecated":null,"version":null,"openapi":"/api-reference/reporting-api/openapi.yaml get /v2/reporting/reports","href":"/api-reference/reports/list-report-types"},{"title":"Get Report Type","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/reporting-api/openapi.yaml get /v2/reporting/reports/{report_type}","href":"/api-reference/reports/get-report-type"}]}]},{"group":"Invoices API","hidden":true,"pages":[{"group":"Invoices","pages":[{"title":"List invoice files","description":"Returns a list of all invoice files. The returned list is arranged by date created, in descending order. Use `page` and `limit` to refine your list.","deprecated":null,"version":null,"openapi":"/api-reference/shipporeportinvoices/invoices-api.yaml get /v2/reports/invoices","href":"/api-reference/invoices/list-invoice-files"},{"title":"Retrieve invoice file","description":"Returns a redirect URL to download the invoice file content.\n\nA successful response returns a 302 status code. Your client should automatically follow the redirected link to download the file.\nSome clients, such as Swagger UI, can include the `authorization` header when following the redirected link. This will cause the request to fail with a 400 Bad Request response. To avoid this issue, ensure that the `authorization` header is removed when the client follows the redirected URL.","deprecated":null,"version":null,"openapi":"/api-reference/shipporeportinvoices/invoices-api.yaml get /v2/reports/invoices/{file_id}","href":"/api-reference/invoices/retrieve-invoice-file"}]}]},{"group":"Estimate API","pages":[{"group":"Estimates","pages":[{"title":"Create Estimates","deprecated":null,"version":null,"openapi":"/api-reference/estimateapi/openapi.yaml post /v2/estimates","href":"/api-reference/estimates/create-estimates"}]}]},{"group":"Automations API","hidden":false,"tag":"Beta","pages":[{"group":"Automations","pages":[{"title":"List label-purchase requests","description":"Lists your label-purchase requests, newest first. Read-only. Returns a page of summaries plus a `next` link (an opaque cursor); `next` is `null` on the last page.\n\nThe `shipment_id`, `tracking_number`, `status`, and `dry_run` filters are AND-combined, and are preserved across pages by the `next` link.","deprecated":null,"version":null,"openapi":"/api-reference/automationsapi/openapi.yaml get /automations/labels","href":"/api-reference/automations/list-label-purchase-requests"},{"title":"Buy a label using your automation rules","deprecated":null,"version":null,"openapi":"/api-reference/automationsapi/openapi.yaml post /automations/labels","href":"/api-reference/automations/buy-a-label-using-your-automation-rules"},{"title":"Get request status","deprecated":null,"version":null,"openapi":"/api-reference/automationsapi/openapi.yaml get /automations/labels/{request_id}","href":"/api-reference/automations/get-request-status"},{"title":"Get the decision behind a selected rate","deprecated":null,"version":null,"openapi":"/api-reference/automationsapi/openapi.yaml get /automations/labels/{request_id}/decision","href":"/api-reference/automations/get-the-decision-behind-a-selected-rate"}]}]},{"group":"Parcel Templates","hidden":true,"pages":[{"title":"Aramex Australia Parcel Templates","href":"/api-reference/parcel-templates/aramex-australia"},{"title":"DHL eCommerce Parcel Templates","href":"/api-reference/parcel-templates/dhl-ecommerce"},{"title":"DPD UK Parcel Templates","href":"/api-reference/parcel-templates/dpd-uk"},{"title":"FedEx Parcel Templates","href":"/api-reference/parcel-templates/fedex"},{"title":"UPS Parcel Templates","href":"/api-reference/parcel-templates/ups"},{"title":"USPS Parcel Templates","href":"/api-reference/parcel-templates/usps"}]}]},{"tab":"Shipping Elements","pages":[{"title":"Shipping Elements","href":"/shipping-elements"}]}]},"title":"Create Estimates - Shippo API Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}