{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/shipping/add-insurance-to-shipment","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/shipping/add-insurance-to-shipment","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/shipping/add-insurance-to-shipment","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Add Insurance to Shipments","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":"add-insurance-to-shipments","__idx":0},"children":["Add Insurance to Shipments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can add insurance to a shipment when ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/rates/rates#example-with-shipment-details"},"children":["getting a rate"]},", ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/create-a-shipment"},"children":["creating a shipment"]},", or ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/labels/create-a-label"},"children":["purchasing a label"]},". You’ll set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_provider"]}," property at the shipment level and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insured_value"]}," property at the package level (for ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/multi-package"},"children":["multipackage shipments"]},", you’ll need to do this for every package in the shipment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported values for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_provider"]}," property:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This is the default value for this property and means the package will not be insured. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Does not affect reimbursement from carriers that provide default coverage."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["funding_source"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This option will assign the insurance provider available with ShipStation Carriers to the shipment (currently ParcelGuard, available for US-based accounts only). The response will auto-populate the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_provider"]}," field with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelguard"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parcelguard"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This option will assign ParcelGuard as the insurance provider for the shipment. Using this value is functionally the same as using the 'funding_source' value. Currently available for US-based accounts only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This option will add the carrier’s insurance to the package if the carrier supports it."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["third_party"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This option allows you to indicate the package is insured by a third-party insurance service. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Using this value does not ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["add"]}," insurance to a shipment. Use this option if you have your own parcel insurance account and wish to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["identify"]}," packages insured externally for reporting purposes."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipsurance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This option is available to US-based ShipStation API accounts that activated ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.shipsurance.com/"},"children":["Shipsurance"]}," prior to July 10, 2024 and wish to continue using the Shipsurance coverage option."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x_cover"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This option will assign XCover from Cover Genius as the insurance provider for the shipment. Currently available for UK-based accounts only."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_provider"]}," property is set to anything other than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]},", you will also need to set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insured_value"]}," of each package in the shipment. For example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"insurance_provider\": \"funding_source\",\n  \"packages\": [\n    {\n      \"insured_value\": {\n        \"currency\": \"usd\",\n        \"amount\": 200\n      }\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-request--response","__idx":1},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is an example of a purchase label request for a shipment insured with ParcelGuard."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST v1/labels"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/labels HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"shipment\": {\n    \"service_code\": \"usps_priority_mail\",\n    \"ship_to\": {\n      \"name\": \"Amanda Miller\",\n      \"phone\": \"555-555-5555\",\n      \"address_line1\": \"525 S Winchester Blvd\",\n      \"city_locality\": \"San Jose\",\n      \"state_province\": \"CA\",\n      \"postal_code\": \"95128\",\n      \"country_code\": \"US\",\n      \"address_residential_indicator\": \"yes\"\n    },\n    \"ship_from\": {\n      \"company_name\": \"Example Corp.\",\n      \"name\": \"John Doe\",\n      \"phone\": \"111-111-1111\",\n      \"address_line1\": \"4009 Marathon Blvd\",\n      \"address_line2\": \"Suite 300\",\n      \"city_locality\": \"Austin\",\n      \"state_province\": \"TX\",\n      \"postal_code\": \"78756\",\n      \"country_code\": \"US\",\n      \"address_residential_indicator\": \"no\"\n    },\n    \"confirmation\": \"none\",\n    \"insurance_provider\": \"funding_source\",\n    \"packages\": [\n      {\n        \"weight\": {\n          \"value\": 1,\n          \"unit\": \"ounce\"\n        },\n        \"insured_value\": {\n          \"currency\": \"usd\",\n          \"amount\": 200\n        }\n      }\n    ]\n  }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example Response"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response will include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_cost"]}," property that shows the insurance fee (add to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipment_cost"]}," amount for the total cost of the label including insurance) and the URL to use if you need to file an insurance claim."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"label_id\": \"se-test-41817394\",\n    \"status\": \"processing\",\n    \"shipment_id\": \"se-41817394\",\n    \"ship_date\": \"2024-04-03T00:00:00Z\",\n    \"created_at\": \"2024-04-03T17:30:19.9541821Z\",\n    \"shipment_cost\":\n      {\n       \"currency\": \"usd\",\n        \"amount\": 9.89\n      },\n    \"insurance_cost\":\n      {\n        \"currency\": \"usd\",\n        \"amount\": 2.18\n      },\n    \"tracking_number\": \"9999999999999\",\n    \"is_return_label\": false,\n    \"is_international\": false,\n    \"batch_id\": \"\",\n    \"carrier_id\": \"se-0\",\n    \"service_code\": \"usps_priority_mail\",\n    \"package_code\": \"package\",\n    \"voided\": false,\n    \"voided_at\": null,\n    \"label_format\": \"pdf\",\n    \"label_layout\": \"4x6\",\n    \"trackable\": true,\n    \"carrier_code\": \"stamps_com\",\n    \"tracking_status\": \"unknown\",\n    \"label_download\":\n      {\n        \"pdf\": \"https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.pdf\",\n        \"png\": \"https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.png\",\n        \"zpl\": \"https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.zpl\",\n        \"href\": \"https://api.shipengine.com/v1/downloads/1/s_Tqsu9euEKub6Acc_9UIg/testlabel-2128732.pdf\"\n      },\n    \"form_download\": null,\n    \"insurance_claim\":\n      {\n        \"href\": \"https://www.dsiins.com/extclaims/Default.asp?cid=shipengine&psid=0&shipmentid=0\"\n      }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"filing-a-claim","__idx":2},"children":["Filing a Claim"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How you file a claim will depend on the type of insurance you added to the shipment."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ParcelGuard"]},": Go to the link provided in the shipment response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_claim"]}," field and follow the on-screen instructions. By following the link from the response, most of the claim fields will be auto-filled with the required shipment details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["XCover"]},": Go to the link provided in the shipment response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insurance_claim"]}," field and follow the on-screen instructions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Carrier insurance"]},": Follow the carrier’s claims process."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"parcelguard-and-xcover-refunds-for-voided-labels","__idx":3},"children":["ParcelGuard and XCover Refunds for Voided Labels"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/labels/voiding"},"children":["void a label"]}," for a shipment that includes ParcelGuard or XCover, the insurance cost will be immediately refunded back to your account balance."]}]},"headings":[{"value":"Add Insurance to Shipments","id":"add-insurance-to-shipments","depth":1},{"value":"Example Request & Response","id":"example-request--response","depth":2},{"value":"Filing a Claim","id":"filing-a-claim","depth":2},{"value":"ParcelGuard and XCover Refunds for Voided Labels","id":"parcelguard-and-xcover-refunds-for-voided-labels","depth":2}],"frontmatter":{"seo":{"title":"Add Insurance to Shipments"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/shipping/add-insurance-to-shipment","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}