Orders

Update Shipping Address

Updates the shipping address of a goodsout.

PUT

/v1/orders/goodsouts/{id}/shipping_address

curl --request PUT \
  --url https://public-api.bladepro.io/v1/orders/goodsouts/{id}/shipping_address \
  --header 'Content-Type: application/json' \
  --data '
{
  "address_one": "<string>",
  "address_three": "<string>",
  "address_two": "<string>",
  "company": "<string>",
  "country_id": "<string>",
  "county": "<string>",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "mobile": "<string>",
  "postcode": "<string>",
  "secondary_telephone": "<string>",
  "telephone": "<string>",
  "title": "<string>",
  "town": "<string>",
  "vat_number": "<string>"
}
'

{
  "data": {
    "address_one": "Unit 4",
    "address_three": null,
    "address_two": "Radar Way",
    "company": "ACME LTD",
    "country_id": 1,
    "county": "Dorset",
    "email": "support.team@i-fulfilment.co.uk",
    "first_name": "Support",
    "last_name": "Team",
    "mobile": "00000000000",
    "postcode": "BH23 4FL",
    "secondary_telephone": "0000000000000",
    "telephone": "00000000000",
    "title": "Mr",
    "town": "Christchurch",
    "vat_number": "GB999 9999 73"
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::ORDERS::MANAGE

Path Parameters

idstringrequired

Path parameter: id

Pattern: [1-9][0-9]{0,}

Body

address_onestringrequired

First line of address.

address_threestring

Third line of address.

address_twostring

Second line of address.

companystring

Company name.

country_idstringrequired

Country ISO 2 or ISO 3 code.

countystring

County.

emailstring

Email.

first_namestringrequired

First name.

last_namestringrequired

Last name.

mobilestring

Mobile number.

postcodestringrequired

Postcode.

secondary_telephonestring

Secondary telephone number.

telephonestring

Landline number.

titlestring

Title.

townstringrequired

Town.

vat_numberstring

VAT number.

Response

successful operation

address_onestring

First line of address.

address_threestring

Third line of address.

address_twostring

Second line of address.

companystring

Company name.

countryobject

The address country.

Show child attributes

country_idnumber

ID of the country.

countystring

County name.

emailstring

Email.

first_namestring

First name.

idnumber

The address' unique identifier.

last_namestring