Shipments

Update a Shipment

Changed on Nov 3, 2026

Update shipment details.

Required authorization scope: public.shipment:write and public.label:write if a label is requested during the request.

patch/2024-09/shipments/{easyship_shipment_id}

Request

Base URL
https://public-api.easyship.com
URL
https://public-api.easyship.com/2024-09/shipments/{easyship_shipment_id}
Auth
HTTP bearer

Path parameters

easyship_shipment_idstring required

Easyship Shipment ID provided when creating the shipment

Request body

origin_addressOriginAddress (unresolved $ref)

origin_address_idOriginAddressId (unresolved $ref)

sender_addressSenderAddress (unresolved $ref)

sender_address_idSenderAddressId (unresolved $ref)

return_addressReturnAddress (unresolved $ref)

return_address_idReturnAddressId (unresolved $ref)

destination_addressDestinationAddress (unresolved $ref)

metadataMetadata (unresolved $ref)

set_as_residentialSetAsResidential (unresolved $ref)

consignee_tax_idConsigneeTaxId (unresolved $ref)

eei_referenceEeiReference (unresolved $ref)

regulatory_identifiersRegulatoryIdentifiers (unresolved $ref)

incotermsIncoterms (unresolved $ref)

insuranceInsurance (unresolved $ref)

order_dataOrderData (unresolved $ref)

courier_settingsCourierSettings (unresolved $ref)

shipping_settingsShippingSettings (unresolved $ref)

Response

shipment successfully updated

Changes

Nov 3, 2026b47b54b748a7 Revision changes
- breaking
  the request property ///// became not nullable
- breaking
  the request property ///// became not nullable
- breaking
  the request property ///// became not nullable
- breaking
  the request property ///// became not nullable
- breaking
  the request property ///// became not nullable
- breaking
  the request property ///// became not nullable
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /
- info
  the request property ///// became nullable
- info
  the request property ///// became nullable
- info
  the request property ///// became nullable
- info
  the request property ///// became nullable
- info
  the request property ///// became nullable
- info
  the request property ///// became nullable
- info
  added the optional property // to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status

Operation history