latestOpenAPI 3.0.32026-07-26170311887.2 KB

71d737a5fcbf

Shipments

Update a Shipment

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}

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