{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/rates/advanced-features","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/rates/advanced-features","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/rates/advanced-features","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Advanced Rating Features","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"advanced-rating-features","__idx":0},"children":["Advanced Rating Features"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ShipStation API's Rate Shopping feature has many facets and can provide additonal utility beyond getting the quoted cost for a shipment. This article covers the Retail Rates and Quick Rates features."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retail-rates","__idx":1},"children":["Retail Rates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default, ShipStation API will return the same rate that you'd see if you signed into your carrier account on their website and tried to ship a package. However, there are plenty of use cases where it can be valuable to see the rate available if you were to go to the carrier's retail location and purchase postage. The Retail Rates feature allows those rates to be visible from ShipStation API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some things to note:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If ShipStation API does not support retail rates for the carrier you are querying, we will return a 0 amount."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The response object ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requested_comparison_amount"]}," is a sum of the carrier costs for the shipment. It should be compared against the sum of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipping_amount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confirmation_amount"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["other_amount"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_amount"]}," will only be a factor if you choose carrier insurance)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This feature is only available at the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/rates"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/labels"]}," endpoints when creating rates or labels with a shipment."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["INFO:"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"supported-carriers","__idx":2},"children":["Supported Carriers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Currently, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/rates"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/labels"]}," endpoints support Retail Rates for services from Stamps.com and UPS via ShipStation Carriers, and for services from your own Stamps.com account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Additionally, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/rates"]}," endpoint supports Retail Rates for services from your own connected UPS account."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request--response","__idx":3},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/rates/ HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n    \"shipment\": {\n        \"comparison_rate_type\": \"retail\",\n        \"ship_to\": {\n            \"name\": \"The President\",\n            \"phone\": \"222-333-4444\",\n            \"company_name\": \"\",\n            \"address_line1\": \"1600 Pennsylvania Avenue NW\",\n            \"city_locality\": \"Washington\",\n            \"state_province\": \"DC\",\n            \"postal_code\": \"20500\",\n            \"country_code\": \"US\",\n            \"address_residential_indicator\": \"no\"\n        },\n        \"ship_from\": {\n            \"name\": \"ShipStation API Team\",\n            \"phone\": \"222-333-4444\",\n            \"company_name\": \"ShipStation API\",\n            \"address_line1\": \"4301 Bull Creek Road\",\n            \"city_locality\": \"Austin\",\n            \"state_province\": \"TX\",\n            \"postal_code\": \"78731\",\n            \"country_code\": \"US\",\n            \"address_residential_indicator\": \"no\"\n        },\n        \"packages\": [\n            {\n                \"package_code\": \"package\",\n                \"weight\": {\n                    \"value\": 6,\n                    \"unit\": \"ounce\"\n                }\n            }\n        ]\n    },\n    \"rate_options\": {\n        \"carrier_ids\": [\n            \"se-12345\"\n        ]\n    }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also pass the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["comparison_rate_type"]}," in the shipment when creating a label!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"rate_response\": {\n        \"rates\": [\n            {\n                \"rate_id\": \"se-6384266\",\n                \"rate_type\": \"shipment\",\n                \"carrier_id\": \"se-204152\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 6.7300\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0.0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0.0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0.0\n                },\n                \"requested_comparison_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 9.3500\n                },\n                \"rate_details\": [],\n                \"zone\": 1,\n                \"package_type\": \"package\",\n                \"delivery_days\": 1,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2023-11-02T00:00:00Z\",\n                \"carrier_delivery_days\": \"1\",\n                \"ship_date\": \"2023-11-01T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"usps\",\n                \"carrier_nickname\": \"My Stamps account\",\n                \"carrier_friendly_name\": \"USPS\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            }\n        ],\n        \"invalid_rates\": [],\n        \"rate_request_id\": \"se-12345\",\n        \"shipment_id\": \"se-12345\",\n        \"created_at\": \"2023-11-01T15:53:03.8069761Z\",\n        \"status\": \"completed\",\n        \"errors\": []\n    },\n    \"shipment_id\": \"se-12345\",\n    \"carrier_id\": null,\n    \"service_code\": null,\n    \"external_shipment_id\": null,\n    \"shipment_number\": null,\n    \"ship_date\": \"2023-11-01T00:00:00Z\",\n    \"created_at\": \"2023-11-01T15:52:52.833Z\",\n    \"modified_at\": \"2023-11-01T15:52:52.773Z\",\n    \"shipment_status\": \"pending\",\n    \"ship_to\": {\n        \"instructions\": null,\n        \"name\": \"Bruce Wayne\",\n        \"phone\": \"222-333-4444\",\n        \"email\": null,\n        \"company_name\": \"Wayne Enterprises\",\n        \"address_line1\": \"1990 E. Grand Ave\",\n        \"address_line2\": null,\n        \"address_line3\": null,\n        \"city_locality\": \"El Segundo\",\n        \"state_province\": \"CA\",\n        \"postal_code\": \"90245\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"no\"\n    },\n    \"ship_from\": {\n        \"instructions\": null,\n        \"name\": \"Bruce Wayne\",\n        \"phone\": \"222-333-4444\",\n        \"email\": null,\n        \"company_name\": \"Wayne Enterprises\",\n        \"address_line1\": \"1990 E. Grand Ave\",\n        \"address_line2\": null,\n        \"address_line3\": null,\n        \"city_locality\": \"El Segundo\",\n        \"state_province\": \"CA\",\n        \"postal_code\": \"90245\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"no\"\n    },\n    \"warehouse_id\": null,\n    \"return_to\": {\n        \"instructions\": null,\n        \"name\": \"Bruce Wayne\",\n        \"phone\": \"222-333-4444\",\n        \"email\": null,\n        \"company_name\": \"Wayne Enterprises\",\n        \"address_line1\": \"1990 E. Grand Ave\",\n        \"address_line2\": null,\n        \"address_line3\": null,\n        \"city_locality\": \"El Segundo\",\n        \"state_province\": \"CA\",\n        \"postal_code\": \"90245\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"no\"\n    },\n    \"is_return\": false,\n    \"confirmation\": \"none\",\n    \"customs\": {\n        \"contents\": \"merchandise\",\n        \"contents_explanation\": null,\n        \"customs_items\": [],\n        \"non_delivery\": \"return_to_sender\",\n        \"buyer_shipping_amount_paid\": null,\n        \"duties_paid\": null,\n        \"terms_of_trade_code\": null,\n        \"declaration\": null,\n        \"invoice_additional_details\": {\n            \"freight_charge\": null,\n            \"insurance_charge\": null,\n            \"other_charge\": null,\n            \"other_charge_description\": null,\n            \"discount\": null\n        },\n        \"importer_of_record\": null\n    },\n    \"external_order_id\": null,\n    \"order_source_code\": null,\n    \"advanced_options\": {\n        \"bill_to_account\": null,\n        \"bill_to_country_code\": null,\n        \"bill_to_party\": null,\n        \"bill_to_postal_code\": null,\n        \"contains_alcohol\": false,\n        \"delivered_duty_paid\": false,\n        \"non_machinable\": false,\n        \"saturday_delivery\": false,\n        \"dry_ice\": false,\n        \"dry_ice_weight\": null,\n        \"fedex_freight\": null,\n        \"third_party_consignee\": false,\n        \"ancillary_endorsements_option\": null,\n        \"freight_class\": null,\n        \"custom_field1\": null,\n        \"custom_field2\": null,\n        \"custom_field3\": null,\n        \"collect_on_delivery\": null,\n        \"return_pickup_attempts\": null,\n        \"additional_handling\": false,\n        \"own_document_upload\": false,\n        \"limited_quantity\": false\n    },\n    \"comparison_rate_type\": null,\n    \"insurance_provider\": \"none\",\n    \"tags\": [],\n    \"packages\": [\n        {\n            \"shipment_package_id\": \"se-12345\",\n            \"package_id\": \"se-3\",\n            \"package_code\": \"package\",\n            \"package_name\": \"Package\",\n            \"weight\": {\n                \"value\": 6.00,\n                \"unit\": \"ounce\"\n            },\n            \"dimensions\": {\n                \"unit\": \"inch\",\n                \"length\": 0.0,\n                \"width\": 0.0,\n                \"height\": 0.0\n            },\n            \"insured_value\": {\n                \"currency\": \"usd\",\n                \"amount\": 0.00\n            },\n            \"label_messages\": {\n                \"reference1\": null,\n                \"reference2\": null,\n                \"reference3\": null\n            },\n            \"external_package_id\": null,\n            \"content_description\": null,\n            \"products\": []\n        }\n    ],\n    \"total_weight\": {\n        \"value\": 6.00,\n        \"unit\": \"ounce\"\n    },\n    \"items\": []}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-rates","__idx":4},"children":["Quick Rates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We've found that when getting rates just in time to purchase a label, milliseconds matter. That's why we've developed a way to combine the speed of the Rate Estimate endpoint and the detail of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/rates"]}," endpoint to offer you a fast and fully-featured way to retrieve rates."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Quick Rates saves time by minimizing the information ShipStation API saves about your request. That means you won't be able to use operations like ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/labels/create-from-rate"},"children":["Create Label from Rate"]}," or ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/rates/get-shipment-rates"},"children":["Retrieve Shipment Rates"]},". You will, however, be able to rate international and multi-package shipments with advanced options. You can even use Quick Rates with Retail Rates!"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request--response-1","__idx":5},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/rates/ HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n    \"rate_options\": {\n        \"rate_type\": \"quick\",\n        \"carrier_ids\": [\n            \"se-12345\"\n        ]\n    },\n    \"shipment\": {\n        \"ship_to\": {\n            \"name\": \"The President\",\n            \"phone\": \"222-333-4444\",\n            \"company_name\": \"\",\n            \"address_line1\": \"1600 Pennsylvania Avenue NW\",\n            \"city_locality\": \"Washington\",\n            \"state_province\": \"DC\",\n            \"postal_code\": \"20500\",\n            \"country_code\": \"US\",\n            \"address_residential_indicator\": \"no\"\n        },\n        \"ship_from\": {\n            \"name\": \"ShipStation API Team\",\n            \"phone\": \"222-333-4444\",\n            \"company_name\": \"ShipStation API\",\n            \"address_line1\": \"4301 Bull Creek Road\",\n            \"city_locality\": \"Austin\",\n            \"state_province\": \"TX\",\n            \"postal_code\": \"78731\",\n            \"country_code\": \"US\",\n            \"address_residential_indicator\": \"no\"\n        },\n        \"packages\": [\n            {\n                \"package_code\": \"package\",\n                \"weight\": {\n                    \"value\": 6,\n                    \"unit\": \"ounce\"\n                }\n            }\n        ]\n    }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"rate_response\": {\n        \"rates\": [\n            {\n                \"rate_id\": null,\n                \"rate_type\": \"quick\",\n                \"carrier_id\": \"se-204152\",\n                \"shipping_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 8.4100\n                },\n                \"insurance_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0.0\n                },\n                \"confirmation_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0.0\n                },\n                \"other_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0.0\n                },\n                \"requested_comparison_amount\": {\n                    \"currency\": \"usd\",\n                    \"amount\": 0.0\n                },\n                \"rate_details\": [],\n                \"zone\": 6,\n                \"package_type\": \"package\",\n                \"delivery_days\": 2,\n                \"guaranteed_service\": false,\n                \"estimated_delivery_date\": \"2023-11-03T00:00:00Z\",\n                \"carrier_delivery_days\": \"2\",\n                \"ship_date\": \"2023-11-01T00:00:00Z\",\n                \"negotiated_rate\": false,\n                \"service_type\": \"USPS Priority Mail\",\n                \"service_code\": \"usps_priority_mail\",\n                \"trackable\": true,\n                \"carrier_code\": \"usps\",\n                \"carrier_nickname\": \"My Stamps account\",\n                \"carrier_friendly_name\": \"USPS\",\n                \"validation_status\": \"valid\",\n                \"warning_messages\": [],\n                \"error_messages\": []\n            }\n        ],\n        \"invalid_rates\": [],\n        \"created_at\": \"2023-11-01T10:38:32.4333382Z\",\n        \"status\": \"completed\",\n        \"errors\": []\n    }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Advanced Rating Features","id":"advanced-rating-features","depth":1},{"value":"Retail Rates","id":"retail-rates","depth":2},{"value":"Supported Carriers","id":"supported-carriers","depth":3},{"value":"Example Request & Response","id":"example-request--response","depth":3},{"value":"Quick Rates","id":"quick-rates","depth":2},{"value":"Example Request & Response","id":"example-request--response-1","depth":3}],"frontmatter":{"seo":{"title":"Advanced Rating Features"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/rates/advanced-features","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}