{"templateId":"markdown","versions":[{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/shipping/collect-on-delivery","default":false,"active":false,"folderId":"58c9a61d"},{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/docs/shipping/collect-on-delivery","default":true,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/shipping/collect-on-delivery","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Collect on Delivery","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":"collect-on-delivery","__idx":0},"children":["Collect on Delivery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Collect on Delivery (C.O.D.) is an advanced option you can add to a shipment with certain supported carriers. This option allows the shipper to not pay the shipping cost, deferring it to the recipient who will pay the shipping cost upon receipt."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"FedEx Ground Collect"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["FedEx Ground Collect is distinct from Collect on Delivery. Review our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/docs/carriers/fedex#fedex-ground-collect"},"children":["FedEx guide"]}," for details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":1},"children":["Requirements"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["First check that the carrier that you're using supports the Collect on Delivery option. You can list carrier options via the API reference to see if your carrier supports this feature."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When you create a shipment, label, or rate, use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["advanced_options.collect_on_delivery"]}," property to specify the Collect On Delivery options."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cod-object-properties","__idx":2},"children":["C.O.D. Object Properties"]},{"$$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":"Properties"},"children":["Properties"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$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":["payment_type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["enumerated string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["any"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cash"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cash_equivalent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Contains the C.O.D. amount and currency"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_amount.amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["decimal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," The C.O.D. collection amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_amount.currency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["enumerated string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usd"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cad"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["aud"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gbp"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eur"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nzd"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cash_equivalent"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_type"]}," specified in the request can cover a wide range of payment methods depending on the carrier. For example, the recipient can pay with a cashier's check or a money order. Please check with your selected carrier if this will be relevant to you or your customer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here is an example of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["advanced_options"]}," object with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["collect_on_delivery"]}," property and related values."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"advanced_options\": {\n    \"collect_on_delivery\": {\n      \"payment_type\": \"cash\",\n      \"payment_amount\": {\n        \"amount\": 10.7,\n        \"currency\": \"usd\"\n      }\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"select-collect-on-delivery","__idx":3},"children":["Select Collect On Delivery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can designate collect on delivery with the following methods and endpoints:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/shipments"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v2/shipments/{shipment_id}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/labels"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/rates"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-shipment-request--response","__idx":4},"children":["Example Shipment Request & Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v2/shipments HTTP/1.1\nHost: api.shipstation.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"shipments\": [\n    {\n      \"advanced_options\": {\n        \"collect_on_delivery\": {\n          \"payment_type\": \"cash\",\n          \"payment_amount\": {\n            \"amount\": 10.7,\n            \"currency\": \"usd\"\n          }\n        }\n      },\n      \"service_code\": \"ups_ground\",\n      \"validate_address\": \"no_validation\",\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\": \"none\",\n      \"tags\": [],\n      \"packages\": [\n        {\n          \"weight\": {\n            \"value\": 1,\n            \"unit\": \"ounce\"\n          }\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  \"shipments\": [\n    {\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        \"freight_class\": null,\n        \"custom_field1\": null,\n        \"custom_field2\": null,\n        \"custom_field3\": null,\n        \"collect_on_delivery\": {\n          \"payment_type\": \"cash\",\n          \"payment_amount\": {\n            \"currency\": \"usd\",\n            \"amount\": 10.7\n          }\n        }\n      },\n      \"errors\": [],\n      \"address_validation\": null,\n      \"shipment_id\": \"se-1020109\",\n      \"carrier_id\": \"se-95\",\n      \"service_code\": \"ups_ground\",\n      \"external_shipment_id\": null,\n      \"ship_date\": \"2019-09-25T00:00:00Z\",\n      \"created_at\": \"2019-09-25T19:03:49.0116799Z\",\n      \"modified_at\": \"2019-09-25T19:03:49.0126795Z\",\n      \"shipment_status\": \"pending\",\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      \"warehouse_id\": null,\n      \"return_to\": {\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      \"customs\": null,\n      \"external_order_id\": null,\n      \"order_source_code\": null,\n\n      \"insurance_provider\": \"none\",\n      \"tags\": [],\n      \"packages\": [\n        {\n          \"package_code\": \"package\",\n          \"weight\": {\n            \"value\": 1.0,\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.0\n          },\n          \"label_messages\": {\n            \"reference1\": null,\n            \"reference2\": null,\n            \"reference3\": null\n          },\n          \"external_package_id\": null\n        }\n      ],\n      \"total_weight\": {\n        \"value\": 1.0,\n        \"unit\": \"ounce\"\n      },\n      \"items\": []\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-label-request--response","__idx":5},"children":["Example Label Request & Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v2/labels HTTP/1.1\nHost: api.shipstation.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"shipment\": {\n    \"advanced_options\": {\n      \"collect_on_delivery\": {\n        \"payment_type\": \"any\",\n        \"payment_amount\": {\n          \"amount\": 10.7,\n          \"currency\": \"usd\"\n        }\n      }\n    },\n    \"service_code\": \"ups_ground\",\n    \"external_shipment_id\": \"__YOUR_EXTERNAL_ID_HERE__\",\n    \"ship_to\": {\n      \"name\": \"John Stuckey\",\n      \"phone\": \"6625905259\",\n      \"company_name\": \"John Stuckey\",\n      \"address_line1\": \"3412 Pemberton Square Blvd\",\n      \"address_line2\": \"Ste 2-241\",\n      \"city_locality\": \"VICKSBURG\",\n      \"postal_code\": \"39180-5541\",\n      \"country_code\": \"US\",\n      \"state_province\": \"MS\",\n      \"address_residential_indicator\": \"unknown\"\n    },\n    \"ship_from\": {\n      \"name\": \"Fulfillment Center\",\n      \"phone\": \"877-743-2269\",\n      \"company_name\": \"BBQGuys\",\n      \"address_line1\": \"8151 Airline Hwy\",\n      \"city_locality\": \"Baton Rouge\",\n      \"postal_code\": \"70815\",\n      \"country_code\": \"US\",\n      \"state_province\": \"LA\"\n    },\n    \"confirmation\": \"none\",\n    \"packages\": [\n      {\n        \"weight\": {\n          \"value\": 2,\n          \"unit\": \"pound\"\n        },\n        \"dimensions\": {\n          \"unit\": \"inch\",\n          \"length\": 2,\n          \"width\": 14,\n          \"height\": 17\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":"p","attributes":{},"children":["The collect on delivery payment option is not shown in the create label response."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"label_id\": \"se-6615\",\n  \"status\": \"completed\",\n  \"shipment_id\": \"se-1020115\",\n  \"ship_date\": \"2019-09-26T00:00:00Z\",\n  \"created_at\": \"2019-09-26T17:48:59.2732285Z\",\n  \"shipment_cost\": {\n    \"currency\": \"usd\",\n    \"amount\": 27.27\n  },\n  \"insurance_cost\": {\n    \"currency\": \"usd\",\n    \"amount\": 0.0\n  },\n  \"tracking_number\": \"1Z14Y0487211178222\",\n  \"is_return_label\": false,\n  \"rma_number\": null,\n  \"is_international\": false,\n  \"batch_id\": \"\",\n  \"carrier_id\": \"se-95\",\n  \"service_code\": \"ups_ground\",\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\": \"ups\",\n  \"tracking_status\": \"in_transit\",\n  \"label_download\": {\n    \"pdf\": \"https://api.shipstation.com/v2/downloads/1/7OC4emEGkEmtutHwzbhvwg/label-6615.pdf\",\n    \"png\": \"https://api.shipstation.com/v2/downloads/1/7OC4emEGkEmtutHwzbhvwg/label-6615.png\",\n    \"zpl\": \"https://api.shipstation.com/v2/downloads/1/7OC4emEGkEmtutHwzbhvwg/label-6615.zpl\",\n    \"href\": \"https://api.shipstation.com/v2/downloads/1/7OC4emEGkEmtutHwzbhvwg/label-6615.pdf\"\n  },\n  \"form_download\": null,\n  \"insurance_claim\": null,\n  \"packages\": [\n    {\n      \"package_code\": \"package\",\n      \"weight\": {\n        \"value\": 2.00,\n        \"unit\": \"pound\"\n      },\n      \"dimensions\": {\n        \"unit\": \"inch\",\n        \"length\": 2.00,\n        \"width\": 14.00,\n        \"height\": 17.00\n      },\n      \"insured_value\": {\n        \"currency\": \"usd\",\n        \"amount\": 0.00\n      },\n      \"tracking_number\": \"1Z14Y0487211178222\",\n      \"label_messages\": {\n        \"reference1\": null,\n        \"reference2\": null,\n        \"reference3\": null\n      },\n      \"external_package_id\": null\n    }\n  ]\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cancel-the-cod-option","__idx":6},"children":["Cancel the C.O.D. Option"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To cancel the collect on delivery option in a shipment, you must update the shipment via the API. In the update request, set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment type"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}," and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},"."]}]},"headings":[{"value":"Collect on Delivery","id":"collect-on-delivery","depth":1},{"value":"Requirements","id":"requirements","depth":2},{"value":"C.O.D. Object Properties","id":"cod-object-properties","depth":2},{"value":"Select Collect On Delivery","id":"select-collect-on-delivery","depth":2},{"value":"Example Shipment Request & Response","id":"example-shipment-request--response","depth":3},{"value":"Example Label Request & Response","id":"example-label-request--response","depth":3},{"value":"Cancel the C.O.D. Option","id":"cancel-the-cod-option","depth":2}],"frontmatter":{"slug":"/collect-on-delivery","seo":{"title":"Collect on Delivery"}},"lastModified":"2026-09-03T15:25:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/collect-on-delivery","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}