Update a Shipment

Info

Requirements

To Update a Shipment, you must first know how to Create a Shipment. You will need to use the shipment_id provided there, or you can Get a Shipment by Key to find your shipment_id.

After you create a shipment, you might need to update it once you've packed a box, and know more information. You will need to use the shipment_id that was provided before in the request URL.

Now that we know more about our shipment, we're going to add in the same parameters we used in Size & Weight to update our shipment.

Example

PUT /v1/shipments/:shipment_id

For a put request, you can include as much or as little as you want, we will update the object according to what you give us.

Full Shipment Update Request

curl -iX PUT https://api.shipengine.com/v1/shipments/se-202902255 \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-d '
{
  "validate_address": "no_validation",
  "shipment_id": "se-202902255",
  "carrier_id": "se-123890",
  "service_code": "usps_priority_mail",
  "external_shipment_id": "1daa0c22-0519-46d0-8653-9f3dc62e7d2c",
  "ship_date": "2019-07-25T05:00:00.000Z",
  "created_at": "2019-07-25T15:24:46.657Z",
  "modified_at": "2019-07-25T15:24:46.657Z",
  "shipment_status": "pending",
  "ship_to": {
    "name": "Mickey and Minnie Mouse",
    "phone": "714-781-4565",
    "company_name": "The Walt Disney Company",
    "address_line1": "500 S BUENA VISTA ST",
    "address_line2": "",
    "city_locality": "BURBANK",
    "state_province": "CA",
    "postal_code": "91521-0001",
    "country_code": "US"
  },
  "ship_from": {
    "name": "Dade Murphy",
    "phone": "512-485-4282",
    "company_name": "Zero Cool",
    "address_line1": "345 Chambers Street",
    "address_line2": "Suite 100",
    "city_locality": "New York City",
    "state_province": "NY",
    "postal_code": "10282",
    "country_code": "US",
  },
  "return_to": {
    "phone": "512-485-4282",
    "company_name": "Zero Cool Returns",
    "address_line1": "345 Chambers Street",
    "address_line2": "Suite 100",
    "city_locality": "New York City",
    "state_province": "NY",
    "postal_code": "10282",
    "country_code": "US",
    "address_residential_indicator": "no"
  },
  "confirmation": "none",
  "advanced_options": {
    "bill_to_account": null,
    "bill_to_country_code": null,
    "bill_to_party": null,
    "bill_to_postal_code": null,
    "contains_alcohol": false,
    "custom_field1": null,
    "custom_field2": null,
    "custom_field3": null,
    "non_machinable": false,
    "saturday_delivery": false
  },
  "insurance_provider": "none",
  "tags": [],
  "packages": [
    {
      "weight": {
        "value": 9.6,
        "unit": "ounce"
      },
      "dimensions": {
        "unit": "inch",
        "length": 12.0,
        "width": 7.1,
        "height": 6.0
      },
      "insured_value": {
        "currency": "usd",
        "amount": 0.0
      }
    }
  ]
}'

Partial Shipment Update

curl -iX PUT https://api.shipengine.com/v1/shipments/se-202902255 \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-d '
{
  "packages": [
    {
      "weight": {
        "value": 9.6,
        "unit": "ounce"
      },
      "dimensions": {
        "unit": "inch",
        "length": 12.0,
        "width": 7.1,
        "height": 6.0
      },
      "insured_value": {
        "currency": "usd",
        "amount": 0.0
      }
    }
  ]
}'

Partial Shipment Update Response

{
  "errors": null,
  "address_validation": null,
  "shipment_id": "se-202902255",
  "carrier_id": "se-123890",
  "service_code": "usps_priority_mail",
  "external_shipment_id": "0bcb569d-1727-4ff9-ab49-b2fec0cee5ae",
  "ship_date": "2018-02-12T00:00:00Z",
  "created_at": "2018-02-13T01:15:53.4331403Z",
  "modified_at": "2018-02-13T01:15:53.4331403Z",
  "shipment_status": "pending",
  "ship_to": {
    "name": "Mickey and Minnie Mouse",
    "phone": "714-781-4565",
    "company_name": "The Walt Disney Company",
    "address_line1": "500 S BUENA VISTA ST",
    "address_line2": "",
    "address_line3": null,
    "city_locality": "BURBANK",
    "state_province": "CA",
    "postal_code": "91521-0001",
    "country_code": "US",
    "address_residential_indicator": "unknown"
  },
  "ship_from": {
    "name": "Dade Murphy",
    "phone": "512-485-4282",
    "company_name": "Zero Cool",
    "address_line1": "345 Chambers Street",
    "address_line2": "Suite 100",
    "address_line3": null,
    "city_locality": "New York City",
    "state_province": "NY",
    "postal_code": "10282",
    "country_code": "US",
    "address_residential_indicator": "unknown"
  },
  "warehouse_id": null,
  "return_to": {
    "name": null,
    "phone": "512-485-4282",
    "company_name": "Zero Cool Returns",
    "address_line1": "345 Chambers Street",
    "address_line2": "Suite 100",
    "address_line3": null,
    "city_locality": "New York City",
    "state_province": "NY",
    "postal_code": "10282",
    "country_code": "US",
    "address_residential_indicator": "unknown"
  },
  "confirmation": "none",
  "customs": null,
  "advanced_options": {
    "bill_to_account": null,
    "bill_to_country_code": null,
    "bill_to_party": null,
    "bill_to_postal_code": null,
    "contains_alcohol": false,
    "delivered_duty_paid": false,
    "non_machinable": false,
    "saturday_delivery": false,
    "freight_class": null,
    "custom_field1": null,
    "custom_field2": null,
    "custom_field3": null
  },
  "insurance_provider": "none",
  "tags": [],
  "packages": [
    {
      "package_code": "package",
      "weight": {
        "value": 9.6,
        "unit": "ounce"
      },
      "dimensions": {
        "unit": "inch",
        "length": 12.0,
        "width": 7.1,
        "height": 6.0
      },
      "insured_value": {
        "currency": "usd",
        "amount": 0.0
      },
      "label_messages": {
        "reference1": null,
        "reference2": null,
        "reference3": null
      }
    }
  ],
  "total_weight": {
    "value": 9.6,
    "unit": "ounce"
  }
}