Update Shipment

Modify the shipping method or update the shipping address until the order has moved to status "shipped".

PUT /{updateShipmentURL}

This endpoint can accept either the Order ID or the Order Reference ID.

Request Format

{
  "shipmentMethodUid": "fed_ex_2_day",
  "shippingAddress": {
    "country": "GB",
    "firstName": "Alexis",
    "lastName": "Apollo",
    "addressLine1": "Longusta str. 4",
    "addressLine2": "app. 144",
    "city": "myCity",
    "postCode": "111111",
    "state": "myState",
    "email": "[email protected]",
    "phone": "+34 111444111",
    "companyName": "Company_example",
    "isBusiness": false,
    "federalTaxId": "",
    "stateTaxId": "",
    "registrationState": ""
  }
}

You can update either the shipping method, the shipping address, or both. At least one of these fields must be included in the request.

Request Parameters

Parameter	Type	Required	Description
shipmentMethodUid	string	Optional*	New shipping method (*At least one of shipmentMethodUid or shippingAddress must be provided)
shippingAddress	object	Optional*	New shipping address details (*At least one of shipmentMethodUid or shippingAddress must be provided)

Response Format

{
  "shippingAddress": {
    "id": "2f85d65b-4814-4b5f-90a2-a7de28250bd1",
    "orderId": "148c5a06-35c9-40d3-8ef7-e85eb2da317d",
    "country": "GB",
    "firstName": "Test Order",
    "lastName": "4",
    "companyName": "company_example",
    "addressLine1": "address example 1",
    "addressLine2": "address example 2",
    "city": "myCity",
    "postCode": "111111",
    "state": "",
    "email": "[email protected]",
    "phone": "+34 111444222",
    "isBusiness": false,
    "federalTaxId": "",
    "stateTaxId": "",
    "registrationState": ""
  },
  "shipment": {
    "shipmentMethodUid": "fed_ex_2_day",
    "shipmentMethodName": "DHL Global Parcel",
    "fulfillmentCountry": "DE",
    "fulfillmentFacilityId": "db0622e7-d7af-4453-b39f-cdf1b67f3daa",
    "packageCount": 1,
    "initialMinDeliveryDate": "2024-11-16",
    "initialMaxDeliveryDate": "2024-11-16",
    "serviceType": "normal"
  }
}