{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/reference/update-shipment","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/reference/update-shipment","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/reference/update-shipment","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Update a Shipment","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":"update-a-shipment","__idx":0},"children":["Update a Shipment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Occasionally you may need to update a shipment's details after you've created the shipment but before shipping it. For instance, the package's size and weight have changed since you created the original shipment, or you may realize you didn't add necessary customs declarations."]},{"$$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":["The request URL must include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipment_id"]}," (available from the create a shipment response)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You'll need the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ship_to"]}," and either the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ship_from"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouse_id"]}," properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You'll need any of the other properties you wish to update."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://shipengine.github.io/shipengine-openapi/#operation/update_shipment"},"children":["Update Shipment By ID"]}," in our API reference for the full body schema."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-shipment-update-request--response","__idx":2},"children":["Example Shipment Update Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this example, we'll update the size and weight of a shipment. You can add the same parameters used in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/size-and-weight"},"children":["Size & Weight"]}," to update the shipment."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PUT /v1/shipments/:shipment_id"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"PUT /v1/shipments/se-202902255 HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"validate_address\": \"no_validation\",\n  \"carrier_id\": \"se-123890\",\n  \"service_code\": \"usps_priority_mail\",\n  \"external_shipment_id\": \"1daa0c22-0519-46d0-8653-9f3dc62e7d2c\",\n  \"ship_date\": \"2019-07-25T05:00:00.000Z\",\n  \"created_at\": \"2019-07-25T15:24:46.657Z\",\n  \"modified_at\": \"2019-07-25T15:24:46.657Z\",\n  \"shipment_status\": \"pending\",\n  \"ship_to\": {\n    \"name\": \"Amanda Miller\",\n    \"phone\": \"555-555-5555\",\n    \"email\": \"recipient@example.com\",\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    \"email\": \"sender@example.com\",\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  \"return_to\": {\n    \"phone\": \"222-222-2222\",\n    \"company_name\": \"Example Corp. Returns\",\n    \"address_line1\": \"345 Chambers Street\",\n    \"address_line2\": \"Suite 100\",\n    \"city_locality\": \"New York City\",\n    \"state_province\": \"NY\",\n    \"postal_code\": \"10282\",\n    \"country_code\": \"US\",\n    \"address_residential_indicator\": \"no\"\n  },\n  \"confirmation\": \"none\",\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    \"custom_field1\": null,\n    \"custom_field2\": null,\n    \"custom_field3\": null,\n    \"non_machinable\": false,\n    \"saturday_delivery\": false\n  },\n  \"insurance_provider\": \"none\",\n  \"tags\": [],\n  \"packages\": [\n    {\n      \"weight\": {\n        \"value\": 9.6,\n        \"unit\": \"ounce\"\n      },\n      \"dimensions\": {\n        \"unit\": \"inch\",\n        \"length\": 12.0,\n        \"width\": 7.1,\n        \"height\": 6.0\n      },\n      \"insured_value\": {\n        \"currency\": \"usd\",\n        \"amount\": 0.0\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":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"errors\": [],\n  \"address_validation\": null,\n  \"shipment_id\": \"se-5332095\",\n  \"carrier_id\": null,\n  \"service_code\": null,\n  \"external_shipment_id\": null,\n  \"ship_date\": \"2019-07-25T05:00:00.000Z\",\n  \"created_at\": \"2019-07-25T15:24:46.657Z\",\n  \"modified_at\": \"2019-07-25T15:24:46.657Z\",\n  \"shipment_status\": \"pending\",\n  \"ship_to\": {\n    \"name\": \"Amanda Miller\",\n    \"phone\": \"555-555-5555\",\n    \"email\": \"recipient@example.com\",\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    \"email\": \"sender@example.com\",\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\": \"se-7429\",\n  \"return_to\": {\n    \"phone\": \"222-222-2222\",\n    \"company_name\": \"Example Corp. Returns\",\n    \"address_line1\": \"345 Chambers Street\",\n    \"address_line2\": \"Suite 100\",\n    \"city_locality\": \"New York City\",\n    \"state_province\": \"NY\",\n    \"postal_code\": \"10282\",\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  \"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\": null\n  },\n  \"insurance_provider\": \"none\",\n  \"tags\": [],\n  \"packages\": [\n    {\n      \"package_code\": \"package\",\n      \"weight\": {\n        \"value\": 0.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\": 0.0,\n    \"unit\": \"ounce\"\n  },\n  \"items\": []\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Update a Shipment","id":"update-a-shipment","depth":1},{"value":"Requirements","id":"requirements","depth":2},{"value":"Example Shipment Update Request & Response","id":"example-shipment-update-request--response","depth":2}],"frontmatter":{"seo":{"title":"Update a Shipment"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/reference/update-shipment","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}