Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.
API key authentication using the ShippoToken scheme.
Format: Authorization: ShippoToken <API_TOKEN>
Example: Authorization: ShippoToken shippo_live_abc123
Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts guide.
The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.
The sender address, which includes your name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.
{"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":"6aee7a5a7351615a30f535ad","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Documentation","count":123},{"language":"default","tag":"API Reference","count":97},{"language":"default","tag":"Guides","count":89},{"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":false,"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":"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":"llms-txt-v2","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":"comment-mode","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":"api-reference/rates-at-checkout/generate-a-live-rates-request","slug":"/api-reference/rates-at-checkout/generate-a-live-rates-request","pageMetadata":{"title":"Generate a live rates request","description":"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /live-rates","href":"/api-reference/rates-at-checkout/generate-a-live-rates-request","autogeneratedByOpenApi":true},"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: \"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.\"\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}=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":"Generate a live rates request","description":"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.","deprecated":null,"version":null,"openapi":"/spec/shippoapi/public-api.yaml post /live-rates","href":"/api-reference/rates-at-checkout/generate-a-live-rates-request","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.","operationId":"CreateLiveRate","parameters":["be77d2be-dd4d-4ad7-912e-ff847240e1e8","58fa2afb-ab62-43c0-a80a-8c27130f6b5f"],"requestBody":"df0938e4-166f-403d-9c97-f64dfe1732b5","responses":{"200":"f754b836-966b-40ce-ada6-2cbcf72f3e09","400":"4b848aa2-2913-468c-8069-961c867180f3"},"summary":"Generate a live rates request","tags":["Rates at Checkout"],"x-codeSamples":[{"label":"cURL","lang":"cURL","source":"curl https://api.goshippo.com/live-rates \\\n -H \"Authorization: ShippoToken \u003cAPI_TOKEN>\" \\\n -H \"Content-Type: application/json\"\n--data-raw '{\n \"address_from\": {\n \"name\": \"S. Hippo\",\n \"company\": \"Shippo\",\n \"street1\": \"731 Market St #200\",\n \"street_no\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\"\n },\n \"address_to\": {\n \"name\": \"Bob Bloat\",\n \"company\": \"SF Zoo\",\n \"street1\": \"Sloat Blvd. \u0026 Upper Great Hwy.\",\n \"street_no\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94132\",\n \"country\": \"US\"\n },\n \"line_items\": [\n {\n \"quantity\": 1,\n \"total_price\": \"12.00\",\n \"currency\": \"USD\",\n \"weight\": \"1.0\",\n \"weight_unit\": \"lb\",\n \"title\": \"Hippo Snax\",\n \"manufacture_country\": \"US\",\n \"sku\": \"HM-123\"\n }\n ],\n \"parcel\": {\n \"length\": \"10\",\n \"width\": \"15\",\n \"height\": \"10\",\n \"distance_unit\": \"in\",\n \"weight\": \"1\",\n \"mass_unit\": \"lb\"\n }\n}'"},{"lang":"python","label":"Python","source":"import dateutil.parser\nimport shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken \u003cAPI_TOKEN>',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates_at_checkout.create(request=components.LiveRateCreateRequest(\n address_from='\u003cvalue>',\n address_to=components.AddressCompleteCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n line_items=[\n components.LineItem(\n currency='USD',\n manufacture_country='US',\n max_delivery_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n max_ship_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n quantity=20,\n sku='HM-123',\n title='Hippo Magazines',\n total_price='12.1',\n variant_title='June Edition',\n weight='0.4',\n weight_unit=components.WeightUnitEnum.LB,\n object_id='abf7d5675d744b6ea9fdb6f796b28f28',\n ),\n ],\n parcel='5df144dca289442cv7a06',\n))\n\nif res is not None:\n # handle response\n pass"},{"lang":"typescript","label":"Typescript","source":"import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \u003cAPI_TOKEN>\",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.ratesAtCheckout.create({\n addressFrom: \"\u003cvalue>\",\n addressTo: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n lineItems: [\n {\n currency: \"USD\",\n manufactureCountry: \"US\",\n maxDeliveryTime: new Date(\"2016-07-23T00:00:00Z\"),\n maxShipTime: new Date(\"2016-07-23T00:00:00Z\"),\n quantity: 20,\n sku: \"HM-123\",\n title: \"Hippo Magazines\",\n totalPrice: \"12.1\",\n variantTitle: \"June Edition\",\n weight: \"0.4\",\n weightUnit: \"lb\",\n objectId: \"abf7d5675d744b6ea9fdb6f796b28f28\",\n },\n ],\n parcel: \"5df144dca289442cv7a06\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"csharp","label":"C#","source":"using Shippo;\nusing Shippo.Models.Components;\nusing System;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \u003cAPI_TOKEN>\",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.RatesAtCheckout.CreateAsync(\n liveRateCreateRequest: new LiveRateCreateRequest() {\n AddressFrom = LiveRateCreateRequestAddressFrom.CreateStr(\n \"\u003cvalue>\"\n ),\n AddressTo = LiveRateCreateRequestAddressTo.CreateAddressCompleteCreateRequest(\n new AddressCompleteCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n LineItems = new List\u003cLineItem>() {\n new LineItem() {\n Currency = \"USD\",\n ManufactureCountry = \"US\",\n MaxDeliveryTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n MaxShipTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n Quantity = 20,\n Sku = \"HM-123\",\n Title = \"Hippo Magazines\",\n TotalPrice = \"12.1\",\n VariantTitle = \"June Edition\",\n Weight = \"0.4\",\n WeightUnit = WeightUnitEnum.Lb,\n ObjectId = \"abf7d5675d744b6ea9fdb6f796b28f28\",\n },\n },\n Parcel = LiveRateCreateRequestParcel.CreateStr(\n \"5df144dca289442cv7a06\"\n ),\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response"},{"lang":"php","label":"PHP","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\nuse Shippo\\API\\Utils;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken \u003cAPI_TOKEN>'\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$liveRateCreateRequest = new Components\\LiveRateCreateRequest(\n addressFrom: '\u003cvalue>',\n addressTo: new Components\\AddressCompleteCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n lineItems: [\n new Components\\LineItem(\n currency: 'USD',\n manufactureCountry: 'US',\n maxDeliveryTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n maxShipTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n quantity: 20,\n sku: 'HM-123',\n title: 'Hippo Magazines',\n totalPrice: '12.1',\n variantTitle: 'June Edition',\n weight: '0.4',\n weightUnit: Components\\WeightUnitEnum::Lb,\n objectId: 'abf7d5675d744b6ea9fdb6f796b28f28',\n ),\n ],\n parcel: '5df144dca289442cv7a06',\n);\n\n$response = $sdk->ratesAtCheckout->create(\n liveRateCreateRequest: $liveRateCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->liveRatePaginatedList !== null) {\n // handle response\n}"},{"lang":"java","label":"Java","source":"package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCompleteCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.LineItem;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestAddressFrom;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestAddressTo;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestParcel;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateLiveRateResponse;\nimport java.lang.Exception;\nimport java.time.OffsetDateTime;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \u003cAPI_TOKEN>\")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateLiveRateResponse res = sdk.ratesAtCheckout().create()\n .shippoApiVersion(\"2018-02-08\")\n .liveRateCreateRequest(LiveRateCreateRequest.builder()\n .addressTo(LiveRateCreateRequestAddressTo.of(AddressCompleteCreateRequest.builder()\n .name(\"Shwan Ippotle\")\n .street1(\"215 Clayton St.\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .country(\"US\")\n .company(\"Shippo\")\n .street3(\"\")\n .streetNo(\"\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .lineItems(List.of(\n LineItem.builder()\n .currency(\"USD\")\n .manufactureCountry(\"US\")\n .maxDeliveryTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .maxShipTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .quantity(20L)\n .sku(\"HM-123\")\n .title(\"Hippo Magazines\")\n .totalPrice(\"12.1\")\n .variantTitle(\"June Edition\")\n .weight(\"0.4\")\n .weightUnit(WeightUnitEnum.LB)\n .objectId(\"abf7d5675d744b6ea9fdb6f796b28f28\")\n .build()))\n .addressFrom(LiveRateCreateRequestAddressFrom.of(\"\u003cvalue>\"))\n .parcel(LiveRateCreateRequestParcel.of(\"5df144dca289442cv7a06\"))\n .build())\n .call();\n\n if (res.liveRatePaginatedList().isPresent()) {\n // handle response\n }\n }\n}"}],"method":"post","type":"path","servers":["cacc1504-0b40-4ec1-aa22-16cc7c1beba9"],"security":["dbe54bd5-03b5-44fc-a1e0-5dbfdcce4630"],"path":"/live-rates","baseUrlOptions":["https://api.goshippo.com"],"title":"Generate a live rates request","codeSamples":[{"label":"cURL","lang":"cURL","source":"curl https://api.goshippo.com/live-rates \\\n -H \"Authorization: ShippoToken \u003cAPI_TOKEN>\" \\\n -H \"Content-Type: application/json\"\n--data-raw '{\n \"address_from\": {\n \"name\": \"S. Hippo\",\n \"company\": \"Shippo\",\n \"street1\": \"731 Market St #200\",\n \"street_no\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\"\n },\n \"address_to\": {\n \"name\": \"Bob Bloat\",\n \"company\": \"SF Zoo\",\n \"street1\": \"Sloat Blvd. \u0026 Upper Great Hwy.\",\n \"street_no\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94132\",\n \"country\": \"US\"\n },\n \"line_items\": [\n {\n \"quantity\": 1,\n \"total_price\": \"12.00\",\n \"currency\": \"USD\",\n \"weight\": \"1.0\",\n \"weight_unit\": \"lb\",\n \"title\": \"Hippo Snax\",\n \"manufacture_country\": \"US\",\n \"sku\": \"HM-123\"\n }\n ],\n \"parcel\": {\n \"length\": \"10\",\n \"width\": \"15\",\n \"height\": \"10\",\n \"distance_unit\": \"in\",\n \"weight\": \"1\",\n \"mass_unit\": \"lb\"\n }\n}'"},{"label":"Python","lang":"python","source":"import dateutil.parser\nimport shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken \u003cAPI_TOKEN>',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates_at_checkout.create(request=components.LiveRateCreateRequest(\n address_from='\u003cvalue>',\n address_to=components.AddressCompleteCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n line_items=[\n components.LineItem(\n currency='USD',\n manufacture_country='US',\n max_delivery_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n max_ship_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n quantity=20,\n sku='HM-123',\n title='Hippo Magazines',\n total_price='12.1',\n variant_title='June Edition',\n weight='0.4',\n weight_unit=components.WeightUnitEnum.LB,\n object_id='abf7d5675d744b6ea9fdb6f796b28f28',\n ),\n ],\n parcel='5df144dca289442cv7a06',\n))\n\nif res is not None:\n # handle response\n pass"},{"label":"Typescript","lang":"typescript","source":"import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \u003cAPI_TOKEN>\",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.ratesAtCheckout.create({\n addressFrom: \"\u003cvalue>\",\n addressTo: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n lineItems: [\n {\n currency: \"USD\",\n manufactureCountry: \"US\",\n maxDeliveryTime: new Date(\"2016-07-23T00:00:00Z\"),\n maxShipTime: new Date(\"2016-07-23T00:00:00Z\"),\n quantity: 20,\n sku: \"HM-123\",\n title: \"Hippo Magazines\",\n totalPrice: \"12.1\",\n variantTitle: \"June Edition\",\n weight: \"0.4\",\n weightUnit: \"lb\",\n objectId: \"abf7d5675d744b6ea9fdb6f796b28f28\",\n },\n ],\n parcel: \"5df144dca289442cv7a06\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"label":"C#","lang":"csharp","source":"using Shippo;\nusing Shippo.Models.Components;\nusing System;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \u003cAPI_TOKEN>\",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.RatesAtCheckout.CreateAsync(\n liveRateCreateRequest: new LiveRateCreateRequest() {\n AddressFrom = LiveRateCreateRequestAddressFrom.CreateStr(\n \"\u003cvalue>\"\n ),\n AddressTo = LiveRateCreateRequestAddressTo.CreateAddressCompleteCreateRequest(\n new AddressCompleteCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n LineItems = new List\u003cLineItem>() {\n new LineItem() {\n Currency = \"USD\",\n ManufactureCountry = \"US\",\n MaxDeliveryTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n MaxShipTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n Quantity = 20,\n Sku = \"HM-123\",\n Title = \"Hippo Magazines\",\n TotalPrice = \"12.1\",\n VariantTitle = \"June Edition\",\n Weight = \"0.4\",\n WeightUnit = WeightUnitEnum.Lb,\n ObjectId = \"abf7d5675d744b6ea9fdb6f796b28f28\",\n },\n },\n Parcel = LiveRateCreateRequestParcel.CreateStr(\n \"5df144dca289442cv7a06\"\n ),\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response"},{"label":"PHP","lang":"php","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\nuse Shippo\\API\\Utils;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken \u003cAPI_TOKEN>'\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$liveRateCreateRequest = new Components\\LiveRateCreateRequest(\n addressFrom: '\u003cvalue>',\n addressTo: new Components\\AddressCompleteCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n lineItems: [\n new Components\\LineItem(\n currency: 'USD',\n manufactureCountry: 'US',\n maxDeliveryTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n maxShipTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n quantity: 20,\n sku: 'HM-123',\n title: 'Hippo Magazines',\n totalPrice: '12.1',\n variantTitle: 'June Edition',\n weight: '0.4',\n weightUnit: Components\\WeightUnitEnum::Lb,\n objectId: 'abf7d5675d744b6ea9fdb6f796b28f28',\n ),\n ],\n parcel: '5df144dca289442cv7a06',\n);\n\n$response = $sdk->ratesAtCheckout->create(\n liveRateCreateRequest: $liveRateCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->liveRatePaginatedList !== null) {\n // handle response\n}"},{"label":"Java","lang":"java","source":"package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCompleteCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.LineItem;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestAddressFrom;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestAddressTo;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestParcel;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateLiveRateResponse;\nimport java.lang.Exception;\nimport java.time.OffsetDateTime;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \u003cAPI_TOKEN>\")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateLiveRateResponse res = sdk.ratesAtCheckout().create()\n .shippoApiVersion(\"2018-02-08\")\n .liveRateCreateRequest(LiveRateCreateRequest.builder()\n .addressTo(LiveRateCreateRequestAddressTo.of(AddressCompleteCreateRequest.builder()\n .name(\"Shwan Ippotle\")\n .street1(\"215 Clayton St.\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .country(\"US\")\n .company(\"Shippo\")\n .street3(\"\")\n .streetNo(\"\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .lineItems(List.of(\n LineItem.builder()\n .currency(\"USD\")\n .manufactureCountry(\"US\")\n .maxDeliveryTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .maxShipTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .quantity(20L)\n .sku(\"HM-123\")\n .title(\"Hippo Magazines\")\n .totalPrice(\"12.1\")\n .variantTitle(\"June Edition\")\n .weight(\"0.4\")\n .weightUnit(WeightUnitEnum.LB)\n .objectId(\"abf7d5675d744b6ea9fdb6f796b28f28\")\n .build()))\n .addressFrom(LiveRateCreateRequestAddressFrom.of(\"\u003cvalue>\"))\n .parcel(LiveRateCreateRequestParcel.of(\"5df144dca289442cv7a06\"))\n .build())\n .call();\n\n if (res.liveRatePaginatedList().isPresent()) {\n // handle response\n }\n }\n}"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"be77d2be-dd4d-4ad7-912e-ff847240e1e8":{"description":"Optional string used to pick a non-default API version to use. See our [API version](https://docs.goshippo.com/docs/api_concepts/apiversioning/) guide.","in":"header","name":"SHIPPO-API-VERSION","schema":{"type":"string","example":"2018-02-08","default":"2018-02-08","x-default":"2018-02-08","description":"Optional string used to pick a non-default API version to use. See our [API version](https://docs.goshippo.com/docs/api_concepts/apiversioning/) guide.","uniqueKey":"","typeLabel":"string"},"x-speakeasy-globals-hidden":true},"58fa2afb-ab62-43c0-a80a-8c27130f6b5f":{"description":"Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the [Platform accounts guide](https://docs.goshippo.com/platform-accounts/platform-using-accounts).","in":"header","name":"SHIPPO-ACCOUNT-ID","required":false,"schema":{"type":"string","isRequired":false,"description":"Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the [Platform accounts guide](https://docs.goshippo.com/platform-accounts/platform-using-accounts).","uniqueKey":"","typeLabel":"string"},"x-speakeasy-globals-hidden":true}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"address_to":{"oneOf":[{"type":"string","description":"The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.","isRequired":true,"uniqueKey":"address_to.oneOf.0","typeLabel":"string"},{"type":"object","description":"The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.","required":["name","street1","city","state","zip","country"],"properties":{"name":{"description":"**required for purchase**\n\nFirst and Last Name of the addressee\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Either company or name required; No length validation (first 35 chars printed on label) |","example":"Shwan Ippotle","type":"string","maxLength":100,"isRequired":true,"uniqueKey":"address_to.oneOf.1.name","typeLabel":"string"},"street1":{"description":"**required for purchase**\n\nFirst street line. Usually street number and street name (except for DHL Germany, see street_no).\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |","example":"215 Clayton St.","type":"string","maxLength":121,"isRequired":true,"uniqueKey":"address_to.oneOf.1.street1","typeLabel":"string"},"city":{"description":"**required for purchase**\n\nName of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates.\nPlease bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state\nor a ZIP code (see below), if known, it will yield more accurate results.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required; Max 35 characters |","example":"San Francisco","type":"string","maxLength":100,"isRequired":true,"uniqueKey":"address_to.oneOf.1.city","typeLabel":"string"},"state":{"description":"**required for purchase for some countries**\n\nState/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some\ncountries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers\nonly accept two or three character state abbreviations.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required if country requires state; Max 2 characters for US, CA, PR |","example":"CA","type":"string","maxLength":100,"isRequired":true,"uniqueKey":"address_to.oneOf.1.state","typeLabel":"string"},"zip":{"description":"**required for purchase**\n\nPostal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more\naccurate Rates.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 10 characters |","example":"94117","type":"string","maxLength":20,"isRequired":true,"uniqueKey":"address_to.oneOf.1.zip","typeLabel":"string"},"country":{"example":"US","type":"string","description":"ISO 3166-1 alpha-2 country codes and country names can be used. For most consistent results, we recommend using country codes like `US` or `DE`.\nIf using country names, please ensure they are spelled correctly and in English. Country names are converted to country codes.\nRefer to this [guide](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) for a list of country codes.\nSending a country is always required.","isRequired":true,"uniqueKey":"address_to.oneOf.1.country","typeLabel":"string"},"company":{"example":"Shippo","type":"string","maxLength":100,"description":"Company Name\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 35 characters; Either company or name required |","uniqueKey":"address_to.oneOf.1.company","typeLabel":"string"},"street2":{"type":"string","maxLength":100,"description":"Second street line.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |","uniqueKey":"address_to.oneOf.1.street2","typeLabel":"string"},"street3":{"type":"string","maxLength":100,"example":"","description":"Third street line.\nOnly accepted for USPS international shipments, UPS domestic and UPS international shipments.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |","uniqueKey":"address_to.oneOf.1.street3","typeLabel":"string"},"street_no":{"type":"string","example":"","description":"Street number of the addressed building.\nThis field can be included in street1 for all carriers except for DHL Germany.","uniqueKey":"address_to.oneOf.1.street_no","typeLabel":"string"},"phone":{"example":"+1 555 341 9393","type":"string","maxLength":50,"description":"Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This\nincreases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required; Min 1, max 15 characters |\n| USPS | Sender phone required for shipments during label purchase; Min 8, max 15 digits |","uniqueKey":"address_to.oneOf.1.phone","typeLabel":"string"},"email":{"example":"shippotle@shippo.com","type":"string","maxLength":254,"description":"E-mail address of the contact person, RFC3696/5321-compliant.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 80 characters |\n| USPS | Sender email required for shipments during label purchase |","uniqueKey":"address_to.oneOf.1.email","typeLabel":"string"},"is_residential":{"example":true,"type":"boolean","uniqueKey":"address_to.oneOf.1.is_residential","typeLabel":"boolean"},"metadata":{"example":"Customer ID 123456","type":"string","maxLength":100,"description":"A string of up to 100 characters that can be filled with any additional information you want to attach to the object.","uniqueKey":"address_to.oneOf.1.metadata","typeLabel":"string"},"validate":{"example":true,"type":"boolean","uniqueKey":"address_to.oneOf.1.validate","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"address_to.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"address_to","typeLabel":"string | object"},"line_items":{"description":"Array of Line Item objects","items":{"type":"object","title":"Line Item","description":"Line Items, and their corresponding abstract Products and Variants, might be exposed as a separate resource in the future. Currently it's a nested object within the order resource.\n\nA line item is an individual object in an order. For example, if your order contains a t-shirt, shorts, and a jacket, each item is represented by a line item.","x-tags":["Orders"],"properties":{"currency":{"description":"Currency of the `total_price` amount.","example":"USD","type":"string","uniqueKey":"line_items.items.[INDEX].currency","typeLabel":"string"},"manufacture_country":{"description":"Country the item was manufactured in. In the Shippo dashboard, this value will be used ot pre-fill the customs declaration when creating a label for this order.","example":"US","type":"string","uniqueKey":"line_items.items.[INDEX].manufacture_country","typeLabel":"string"},"max_delivery_time":{"description":"The date and time this item needs to be delivered by, i.e. by when the carrier delivers it to the buyer.\nThis value is used by some platforms such as eBay to measure a seller's shipping time and performance.\nIt will be displayed in the Shippo dashboard.","example":"2016-07-23T00:00:00Z","format":"date-time","type":"string","uniqueKey":"line_items.items.[INDEX].max_delivery_time","typeLabel":"string\u003cdate-time>"},"max_ship_time":{"description":"The date and time this item needs to be fulfilled by, i.e. by when the shipping label needs to be created and handed over to the carrier. This value is used by some platforms such as eBay to measure a seller's handling time and performance. It will be displayed in the Shippo dashboard.","example":"2016-07-23T00:00:00Z","format":"date-time","type":"string","uniqueKey":"line_items.items.[INDEX].max_ship_time","typeLabel":"string\u003cdate-time>"},"quantity":{"description":"The quantity of this item in this order.","example":20,"format":"int64","type":"integer","uniqueKey":"line_items.items.[INDEX].quantity","typeLabel":"integer\u003cint64>"},"sku":{"description":"The stock keeping unit value of this item.","example":"HM-123","type":"string","uniqueKey":"line_items.items.[INDEX].sku","typeLabel":"string"},"title":{"description":"Title of the line item.","example":"Hippo Magazines","type":"string","uniqueKey":"line_items.items.[INDEX].title","typeLabel":"string"},"total_price":{"description":"Total price paid by the buyer for this item (or these items, if quantity > 1).","example":"12.1","type":"string","uniqueKey":"line_items.items.[INDEX].total_price","typeLabel":"string"},"variant_title":{"description":"A variant is a specific variation of an item (e.g. `size M` or `color blue`).\nVariants might be exposed as a separate resource in the future too.\nCurrently the variant title is a free text field describing the variant.","example":"June Edition","type":"string","uniqueKey":"line_items.items.[INDEX].variant_title","typeLabel":"string"},"weight":{"description":"Total weight of this/these item(s). Instead of specifying the weight of all items, you can also set the `total_weight` value of the order object.","example":"0.4","type":"string","uniqueKey":"line_items.items.[INDEX].weight","typeLabel":"string"},"weight_unit":{"description":"The unit used for weight.","enum":["g","kg","lb","oz"],"example":"lb","type":"string","uniqueKey":"line_items.items.[INDEX].weight_unit","typeLabel":"enum\u003cstring>"},"object_id":{"type":"string","example":"abf7d5675d744b6ea9fdb6f796b28f28","description":"Unique identifier of the line item object.","uniqueKey":"line_items.items.[INDEX].object_id","typeLabel":"string"}},"uniqueKey":"line_items.items.[INDEX]","typeLabel":"Line Item · object"},"type":"array","isRequired":true,"uniqueKey":"line_items","typeLabel":"Line Item · object[]"},"address_from":{"oneOf":[{"type":"string","description":"The sender address, which includes your name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.","uniqueKey":"address_from.oneOf.0","typeLabel":"string"},{"type":"object","description":"The sender address, which includes your name, company name, street address, city, state, zip code, country, phone number, and email address (strings). Special characters should not be included in any address element, especially name, company, and email.","required":["name","street1","city","state","zip","country"],"properties":{"name":{"description":"**required for purchase**\n\nFirst and Last Name of the addressee\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Either company or name required; No length validation (first 35 chars printed on label) |","example":"Shwan Ippotle","type":"string","maxLength":100,"isRequired":true,"uniqueKey":"address_from.oneOf.1.name","typeLabel":"string"},"street1":{"description":"**required for purchase**\n\nFirst street line. Usually street number and street name (except for DHL Germany, see street_no).\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |","example":"215 Clayton St.","type":"string","maxLength":121,"isRequired":true,"uniqueKey":"address_from.oneOf.1.street1","typeLabel":"string"},"city":{"description":"**required for purchase**\n\nName of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates.\nPlease bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state\nor a ZIP code (see below), if known, it will yield more accurate results.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required; Max 35 characters |","example":"San Francisco","type":"string","maxLength":100,"isRequired":true,"uniqueKey":"address_from.oneOf.1.city","typeLabel":"string"},"state":{"description":"**required for purchase for some countries**\n\nState/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some\ncountries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers\nonly accept two or three character state abbreviations.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required if country requires state; Max 2 characters for US, CA, PR |","example":"CA","type":"string","maxLength":100,"isRequired":true,"uniqueKey":"address_from.oneOf.1.state","typeLabel":"string"},"zip":{"description":"**required for purchase**\n\nPostal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more\naccurate Rates.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 10 characters |","example":"94117","type":"string","maxLength":20,"isRequired":true,"uniqueKey":"address_from.oneOf.1.zip","typeLabel":"string"},"country":{"example":"US","type":"string","description":"ISO 3166-1 alpha-2 country codes and country names can be used. For most consistent results, we recommend using country codes like `US` or `DE`.\nIf using country names, please ensure they are spelled correctly and in English. Country names are converted to country codes.\nRefer to this [guide](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) for a list of country codes.\nSending a country is always required.","isRequired":true,"uniqueKey":"address_from.oneOf.1.country","typeLabel":"string"},"company":{"example":"Shippo","type":"string","maxLength":100,"description":"Company Name\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 35 characters; Either company or name required |","uniqueKey":"address_from.oneOf.1.company","typeLabel":"string"},"street2":{"type":"string","maxLength":100,"description":"Second street line.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |","uniqueKey":"address_from.oneOf.1.street2","typeLabel":"string"},"street3":{"type":"string","maxLength":100,"example":"","description":"Third street line.\nOnly accepted for USPS international shipments, UPS domestic and UPS international shipments.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |","uniqueKey":"address_from.oneOf.1.street3","typeLabel":"string"},"street_no":{"type":"string","example":"","description":"Street number of the addressed building.\nThis field can be included in street1 for all carriers except for DHL Germany.","uniqueKey":"address_from.oneOf.1.street_no","typeLabel":"string"},"phone":{"example":"+1 555 341 9393","type":"string","maxLength":50,"description":"Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This\nincreases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required; Min 1, max 15 characters |\n| USPS | Sender phone required for shipments during label purchase; Min 8, max 15 digits |","uniqueKey":"address_from.oneOf.1.phone","typeLabel":"string"},"email":{"example":"shippotle@shippo.com","type":"string","maxLength":254,"description":"E-mail address of the contact person, RFC3696/5321-compliant.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 80 characters |\n| USPS | Sender email required for shipments during label purchase |","uniqueKey":"address_from.oneOf.1.email","typeLabel":"string"},"is_residential":{"example":true,"type":"boolean","uniqueKey":"address_from.oneOf.1.is_residential","typeLabel":"boolean"},"metadata":{"example":"Customer ID 123456","type":"string","maxLength":100,"description":"A string of up to 100 characters that can be filled with any additional information you want to attach to the object.","uniqueKey":"address_from.oneOf.1.metadata","typeLabel":"string"},"validate":{"example":true,"type":"boolean","uniqueKey":"address_from.oneOf.1.validate","typeLabel":"boolean"}},"uniqueKey":"address_from.oneOf.1","typeLabel":"object"}],"uniqueKey":"address_from","typeLabel":"string | object"},"parcel":{"oneOf":[{"type":"string","description":"Object ID for an existing User Parcel Template OR a fully formed Parcel object.","example":"5df144dca289442cv7a06","uniqueKey":"parcel.oneOf.0","typeLabel":"string"},{"type":"object","description":"Object ID for an existing User Parcel Template OR a fully formed Parcel object.","required":["length","width","height","distance_unit","weight","mass_unit"],"x-tags":["Parcels"],"example":"5df144dca289442cv7a06","properties":{"mass_unit":{"description":"The unit used for weight.","enum":["g","kg","lb","oz"],"example":"lb","type":"string","isRequired":true,"uniqueKey":"parcel.oneOf.1.mass_unit","typeLabel":"enum\u003cstring>"},"weight":{"description":"Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.","example":"1","type":"string","isRequired":true,"uniqueKey":"parcel.oneOf.1.weight","typeLabel":"string"},"distance_unit":{"enum":["cm","in","ft","m","mm","yd"],"example":"in","type":"string","description":"The measure unit used for length, width and height.","isRequired":true,"uniqueKey":"parcel.oneOf.1.distance_unit","typeLabel":"enum\u003cstring>"},"height":{"description":"Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.","example":"1","type":"string","isRequired":true,"uniqueKey":"parcel.oneOf.1.height","typeLabel":"string"},"length":{"description":"Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted.","example":"1","type":"string","isRequired":true,"uniqueKey":"parcel.oneOf.1.length","typeLabel":"string"},"width":{"description":"Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted.","example":"1","type":"string","isRequired":true,"uniqueKey":"parcel.oneOf.1.width","typeLabel":"string"},"extra":{"title":"Parcel Extra","x-tags":["Parcels"],"description":"An object holding optional extra services to be requested for each parcel in a multi-piece shipment.\nThe following values are supported for the `extra` field of the parcel object.","properties":{"COD":{"description":"Specify collection on delivery details (UPS only).","properties":{"amount":{"description":"Amount to be collected.","example":"5.5","type":"string","uniqueKey":"parcel.oneOf.1.extra.COD.amount","typeLabel":"string"},"currency":{"description":"Currency for the amount to be collected. Currently only USD is supported for UPS.","example":"USD","type":"string","uniqueKey":"parcel.oneOf.1.extra.COD.currency","typeLabel":"string"},"payment_method":{"description":"Secured funds include money orders, certified cheques and others (see [UPS](https://www.ups.com/content/us/en/shipping/time/service/value_added/cod.html) for details).\nIf no payment_method inputted the value defaults to \"ANY\".)","enum":["SECURED_FUNDS","CASH","ANY"],"example":"CASH","type":"string","uniqueKey":"parcel.oneOf.1.extra.COD.payment_method","typeLabel":"enum\u003cstring>"}},"title":"COD Specify collection on delivery details (UPS only).","type":"object","uniqueKey":"parcel.oneOf.1.extra.COD","typeLabel":"COD Specify collection on delivery details (UPS only). · object"},"insurance":{"description":"To add insurance to your parcel, specify `amount`, `content` and `currency`. If you do not want to add insurance to your parcel, do not set these parameters.","properties":{"amount":{"description":"Declared value of the goods you want to insure.","example":"5.5","type":"string","uniqueKey":"parcel.oneOf.1.extra.insurance.amount","typeLabel":"string"},"content":{"description":"Description of parcel content.","example":"Laptop","type":"string","uniqueKey":"parcel.oneOf.1.extra.insurance.content","typeLabel":"string"},"currency":{"description":"Currency for the amount value. Currently only USD is supported for FedEx and UPS.","example":"USD","type":"string","uniqueKey":"parcel.oneOf.1.extra.insurance.currency","typeLabel":"string"},"provider":{"description":"To have insurance cover provided by a carrier directly instead of Shippo's provider (XCover), set provider to `FEDEX`, `UPS`, or `ONTRAC`.","example":"UPS","type":"string","enum":["FEDEX","UPS","ONTRAC"],"uniqueKey":"parcel.oneOf.1.extra.insurance.provider","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"parcel.oneOf.1.extra.insurance","typeLabel":"object"},"reference_1":{"type":"string","maxLength":50,"description":"Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 40 characters (Express services); Max 30 characters (Ground services) |","uniqueKey":"parcel.oneOf.1.extra.reference_1","typeLabel":"string"},"reference_2":{"type":"string","maxLength":50,"description":"Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 30 characters |","uniqueKey":"parcel.oneOf.1.extra.reference_2","typeLabel":"string"}},"type":"object","uniqueKey":"parcel.oneOf.1.extra","typeLabel":"Parcel Extra · object"},"metadata":{"type":"string","example":"Customer ID 123456","uniqueKey":"parcel.oneOf.1.metadata","typeLabel":"string"},"object_created":{"description":"Date and time of Parcel creation.","example":"2014-07-09T02:19:13.174Z","format":"date-time","type":"string","uniqueKey":"parcel.oneOf.1.object_created","typeLabel":"string\u003cdate-time>"},"object_id":{"description":"Unique identifier of the given Parcel object. This ID is required to create a Shipment object.","example":"adcfdddf8ec64b84ad22772bce3ea37a","type":"string","uniqueKey":"parcel.oneOf.1.object_id","typeLabel":"string"},"object_owner":{"description":"Username of the user who created the Parcel object.","example":"shippotle@shippo.com","type":"string","uniqueKey":"parcel.oneOf.1.object_owner","typeLabel":"string"},"object_state":{"description":"A Parcel will only be valid when all required values have been sent and validated successfully.","example":"VALID","enum":["VALID"],"type":"string","uniqueKey":"parcel.oneOf.1.object_state","typeLabel":"enum\u003cstring>"},"object_updated":{"description":"Date and time of last Parcel update. Since you cannot update Parcels after they were created, this time stamp reflects the time when the Parcel was changed by Shippo's systems for the last time, e.g., during sorting the dimensions given.","example":"2014-07-09T02:19:13.174Z","format":"date-time","type":"string","uniqueKey":"parcel.oneOf.1.object_updated","typeLabel":"string\u003cdate-time>"},"template":{"oneOf":[{"type":"string","title":"FedEx Parcel Template","description":"If template is passed, `length`, `width`, `height`, and `distance_unit` are not required","enum":["FedEx_Box_10kg","FedEx_Box_25kg","FedEx_Box_Extra_Large_1","FedEx_Box_Extra_Large_2","FedEx_Box_Large_1","FedEx_Box_Large_2","FedEx_Box_Medium_1","FedEx_Box_Medium_2","FedEx_Box_Small_1","FedEx_Box_Small_2","FedEx_Envelope","FedEx_Padded_Pak","FedEx_Pak_1","FedEx_Pak_2","FedEx_Tube","FedEx_XL_Pak"],"x-speakeasy-include":true,"uniqueKey":"parcel.oneOf.1.template.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","title":"UPS Parcel Template","description":"If template is passed, `length`, `width`, `height`, and `distance_unit` are not required","enum":["UPS_Box_10kg","UPS_Box_25kg","UPS_Express_Box","UPS_Express_Box_Large","UPS_Express_Box_Medium","UPS_Express_Box_Small","UPS_Express_Envelope","UPS_Express_Hard_Pak","UPS_Express_Legal_Envelope","UPS_Express_Pak","UPS_Express_Tube","UPS_Laboratory_Pak","UPS_MI_BPM","UPS_MI_BPM_Flat","UPS_MI_BPM_Parcel","UPS_MI_First_Class","UPS_MI_Flat","UPS_MI_Irregular","UPS_MI_Machinable","UPS_MI_MEDIA_MAIL","UPS_MI_Parcel_Post","UPS_MI_Priority","UPS_MI_Standard_Flat","UPS_Pad_Pak","UPS_Pallet"],"x-speakeasy-include":true,"uniqueKey":"parcel.oneOf.1.template.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","title":"USPS Parcel Template","description":"If template is passed, `length`, `width`, `height`, and `distance_unit` are not required","enum":["USPS_FlatRateCardboardEnvelope","USPS_FlatRateEnvelope","USPS_FlatRateGiftCardEnvelope","USPS_FlatRateLegalEnvelope","USPS_FlatRatePaddedEnvelope","USPS_FlatRateWindowEnvelope","USPS_IrregularParcel","USPS_LargeFlatRateBoardGameBox","USPS_LargeFlatRateBox","USPS_APOFlatRateBox","USPS_LargeVideoFlatRateBox","USPS_MediumFlatRateBox1","USPS_MediumFlatRateBox2","USPS_RegionalRateBoxA1","USPS_RegionalRateBoxA2","USPS_RegionalRateBoxB1","USPS_RegionalRateBoxB2","USPS_SmallFlatRateBox","USPS_SmallFlatRateEnvelope","USPS_SoftPack"],"x-speakeasy-include":true,"uniqueKey":"parcel.oneOf.1.template.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","title":"DHL eCommerce Parcel Template","description":"If template is passed, `length`, `width`, `height`, and `distance_unit` are not required","enum":["DHLeC_Irregular","DHLeC_SM_Flats"],"x-speakeasy-include":true,"uniqueKey":"parcel.oneOf.1.template.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","title":"DPD UK Parcel Template","description":"If template is passed, `length`, `width`, `height`, and `distance_unit` are not required","enum":["DPD_UK_Express_Pak"],"x-speakeasy-include":true,"uniqueKey":"parcel.oneOf.1.template.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"string","title":"Aramex Australia Parcel Template","description":"If template is passed, `length`, `width`, `height`, and `distance_unit` are not required","enum":["Fastway_Australia_Satchel_A2","Fastway_Australia_Satchel_A3","Fastway_Australia_Satchel_A4","Fastway_Australia_Satchel_A5"],"x-speakeasy-include":true,"uniqueKey":"parcel.oneOf.1.template.oneOf.5","typeLabel":"enum\u003cstring>"}],"uniqueKey":"parcel.oneOf.1.template","typeLabel":"enum\u003cstring>"},"test":{"type":"boolean","description":"Indicates whether the object has been created in test mode.","uniqueKey":"parcel.oneOf.1.test","typeLabel":"boolean"}},"uniqueKey":"parcel.oneOf.1","typeLabel":"object"}],"uniqueKey":"parcel","typeLabel":"string | object"}},"required":["address_to","line_items"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"address_to":"\u003cstring>","line_items":[{"currency":"USD","manufacture_country":"US","max_delivery_time":"2016-07-23T00:00:00Z","max_ship_time":"2016-07-23T00:00:00Z","quantity":20,"sku":"HM-123","title":"Hippo Magazines","total_price":"12.1","variant_title":"June Edition","weight":"0.4","weight_unit":"lb","object_id":"abf7d5675d744b6ea9fdb6f796b28f28"}],"address_from":"\u003cstring>","parcel":"5df144dca289442cv7a06"}}},"exampleType":"generated"}},"description":"Generate rates at checkout","exampleType":"generated"},"responses":{"f754b836-966b-40ce-ada6-2cbcf72f3e09":{"description":"Paginated list of live rates","content":{"application/json":{"schema":{"type":"object","properties":{"next":{"example":"baseurl?page=3\u0026results=10","type":"string","uniqueKey":"next","typeLabel":"string"},"previous":{"example":"baseurl?page=1\u0026results=10","type":"string","uniqueKey":"previous","typeLabel":"string"},"count":{"example":123,"format":"int64","type":"integer","uniqueKey":"count","typeLabel":"integer\u003cint64>"},"results":{"items":{"type":"object","title":"Live Rate","x-tags":["Rates at Checkout"],"properties":{"amount":{"example":"5.5","type":"string","description":"Final Rate price, expressed in the currency used in the sender's country.","uniqueKey":"results.items.[INDEX].amount","typeLabel":"string"},"amount_local":{"example":"5.5","type":"string","description":"Final Rate price, expressed in the currency used in the recipient's country.","uniqueKey":"results.items.[INDEX].amount_local","typeLabel":"string"},"currency":{"example":"USD","type":"string","description":"Currency used in the sender's country, refers to `amount`.\nThe [official ISO 4217](http://www.xe.com/iso4217.php) currency codes are used, e.g. `USD` or `EUR`.","uniqueKey":"results.items.[INDEX].currency","typeLabel":"string"},"currency_local":{"example":"USD","type":"string","description":"Currency used in the recipient's country, refers to `amount_local`.\nThe [official ISO 4217](http://www.xe.com/iso4217.php) currency codes are used, e.g. `USD` or \"EUR\".","uniqueKey":"results.items.[INDEX].currency_local","typeLabel":"string"},"estimated_days":{"description":"The estimated days in transit of the rate that powers the shipping option, if available.","example":2,"format":"int64","type":"integer","uniqueKey":"results.items.[INDEX].estimated_days","typeLabel":"integer\u003cint64>"},"title":{"description":"The name of the service group being returned","example":"Shipping Option 1","type":"string","uniqueKey":"results.items.[INDEX].title","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"Live Rate · object"},"type":"array","uniqueKey":"results","typeLabel":"Live Rate · object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"next":"baseurl?page=3\u0026results=10","previous":"baseurl?page=1\u0026results=10","count":123,"results":[{"amount":"5.5","amount_local":"5.5","currency":"USD","currency_local":"USD","estimated_days":2,"title":"Shipping Option 1"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"4b848aa2-2913-468c-8069-961c867180f3":{"description":"Bad request","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"dbe54bd5-03b5-44fc-a1e0-5dbfdcce4630":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"Authorization","x-token-prefix":"ShippoToken","x-token-format":"ShippoToken {token}","x-default":"ShippoToken ","description":"API key authentication using the ShippoToken scheme.\nFormat: Authorization: ShippoToken \u003cAPI_TOKEN>\nExample: Authorization: ShippoToken shippo_live_abc123\n","scopes":[],"schemeName":"APIKeyHeader"}}},"servers":{"cacc1504-0b40-4ec1-aa22-16cc7c1beba9":{"url":"https://api.goshippo.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","x-token-prefix":"ShippoToken","x-token-format":"ShippoToken {token}","x-default":"ShippoToken ","description":"API key authentication using the ShippoToken scheme.\nFormat: Authorization: ShippoToken \u003cAPI_TOKEN>\nExample: Authorization: ShippoToken shippo_live_abc123\n","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"Authorization","type":"string","description":"API key authentication using the ShippoToken scheme.\nFormat: Authorization: ShippoToken \u003cAPI_TOKEN>\nExample: Authorization: ShippoToken shippo_live_abc123\n","isRequired":true,"default":"ShippoToken ","typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"Authorization"}],"title":"APIKeyHeader"}]},"originalFileLocation":"spec/shippoapi/public-api.yaml"},"subdomain":"shippo-f4b7b609","siteName":"Shippo API Documentation","title":"Generate a live rates request - Shippo API Documentation","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/rates-at-checkout/generate-a-live-rates-request.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=\"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.\">\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=\"Generate a live rates request - Shippo API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.\">\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/rates-at-checkout/generate-a-live-rates-request\">\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=Rates+at+Checkout\u0026amp;title=Generate+a+live+rates+request\u0026amp;description=Initiates+a+live+rates+request.+Include+either+the+object+ID+for+an+existing+address+record+or+a+fully+formed+address+object+when+entering+an+address+value.+You\u0026amp;theme=376b22903894b16c95b28a54\u0026amp;signature=fe4b96d51e1fb01a20c2c132b71dffb8f45ac75f85b45f870e95f15c63eb2d2d\">\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=\"Generate a live rates request - Shippo API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shippo-f4b7b609.mintlify.site/_mintlify/api/og/v2?division=Rates+at+Checkout\u0026amp;title=Generate+a+live+rates+request\u0026amp;description=Initiates+a+live+rates+request.+Include+either+the+object+ID+for+an+existing+address+record+or+a+fully+formed+address+object+when+entering+an+address+value.+You\u0026amp;theme=376b22903894b16c95b28a54\u0026amp;signature=fe4b96d51e1fb01a20c2c132b71dffb8f45ac75f85b45f870e95f15c63eb2d2d\">\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/rates-at-checkout/generate-a-live-rates-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/rates-at-checkout/generate-a-live-rates-request.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/rates-at-checkout/generate-a-live-rates-request#webpage\",\"url\":\"https://docs.goshippo.com/api-reference/rates-at-checkout/generate-a-live-rates-request\",\"name\":\"Generate a live rates request\",\"description\":\"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.\",\"isPartOf\":{\"@id\":\"https://docs.goshippo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.goshippo.com/api-reference/rates-at-checkout/generate-a-live-rates-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.goshippo.com/api-reference/rates-at-checkout/generate-a-live-rates-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shippo API\",\"item\":\"https://docs.goshippo.com/api-reference/addresses/list-all-addresses\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Generate a live rates request\",\"item\":\"https://docs.goshippo.com/api-reference/rates-at-checkout/generate-a-live-rates-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.goshippo.com/api-reference/rates-at-checkout/generate-a-live-rates-request#apireference\",\"headline\":\"Generate a live rates request\",\"name\":\"Generate a live rates request\",\"description\":\"Initiates a live rates request. Include either the object ID for an existing address record or a fully formed address object when entering an address value. You can also enter the object ID of an existing user parcel template or a fully formed user parcel template object as the parcel value.\",\"url\":\"https://docs.goshippo.com/api-reference/rates-at-checkout/generate-a-live-rates-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.goshippo.com/api-reference/rates-at-checkout/generate-a-live-rates-request#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","description":"Creates a short-lived JSON Web Token (JWT) that client-side applications can use to authenticate against the Shippo API without exposing a long-lived API token.\n\nAuthenticate this request with either a Shippo API token (`Authorization: ShippoToken \u003cAPI_TOKEN>`) or an OAuth bearer token (`Authorization: Bearer \u003cOAUTH_BEARER_TOKEN>`). Platform accounts can mint a token on behalf of a Managed Shippo Account by setting the `SHIPPO-ACCOUNT-ID` header.\n\nThe returned token is valid for 12 hours. Send it on subsequent requests as `Authorization: JWT \u003cJWT_TOKEN>`.","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","description":"Retrieve and display the currently configured default parcel template for live rates.","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","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","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","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","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"}]}]},"basePath":"","title":"Generate a live rates request - Shippo API Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-Dr40SSJq.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}