Sign in
Order Controller

Update order shipping address

Updates shipping recipient name, phone, and address fields. Only include fields you want to change; at least one field is required.

patch/orders/shipping-address/{id}

Path parameters

idnumber required

Request body

shippingAddress1string

Shipping address line 1

shippingAddress2string

Shipping address line 2

shippingCitystring

Shipping city

shippingPostcodestring

Shipping postcode

shippingCountystring

Shipping county

shippingPhonestring

Shipping phone number

shippingFirstNamestring

Shipping first name

shippingLastNamestring

Shipping last name

updateItWithAllLinkedOrdersboolean

Update shipping address for all linked orders

Example request

{
  "shippingAddress1": "456 Delivery Street",
  "shippingAddress2": "Apartment 5B",
  "shippingCity": "Manchester",
  "shippingPostcode": "M1 1AA",
  "shippingCounty": "Greater Manchester",
  "shippingPhone": "+44 123 456 7890",
  "shippingFirstName": "John",
  "shippingLastName": "Doe"
}

Response

Shipping address updated successfully

orderIdnumber required

Order ID

customerEmailstring required

Customer email

emailValidboolean required

Email valid

emailValidationStatusstring

Email validation status (UNKNOWN, VALID, INVALID)

isNewCustomerboolean

True if customer was auto-created during this order

documentAccessLinkstring

Permanent document access link

Example response

{
  "orderId": 1,
  "customerEmail": "customer@example.com",
  "emailValid": true,
  "emailValidationStatus": "UNKNOWN",
  "isNewCustomer": true,
  "documentAccessLink": "https://api.example.com/orders/track/abc-123-xyz"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.