PATCH v3/customers/{id}/addresses/{addressId}

Amend an address on a customers record

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
addressId		string	Required

Body Parameters

AddressPatch

Name	Type	Additional information
Country	string	None.
AdministrativeDivision	string	None.
Name	string	None.
Line1	string	None.
Line2	string	None.
Line3	string	None.
Line4	string	None.
Line5	string	None.
Postcode	string	None.
Town	string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json

Sample:

{
  "country": "sample string 9",
  "administrativeDivision": "sample string 11",
  "name": "sample string 13",
  "line1": "sample string 14",
  "line2": "sample string 15",
  "line3": "sample string 16",
  "line4": "sample string 17",
  "line5": "sample string 18",
  "postcode": "sample string 19",
  "town": "sample string 20"
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.

Response Information

Resource Description

CustomerAddress

Name	Type	Additional information
IsBilling	boolean	None.
IsDelivery	boolean	None.
Id	string	None.
Country	Country	None.
AdministrativeDivision	AdministrativeDivision	None.
Name	string	None.
Line1	string	None.
Line2	string	None.
Line3	string	None.
Line4	string	None.
Line5	string	None.
Postcode	string	None.
Town	string	None.

Response Formats

application/json

Sample:

{
  "isBilling": false,
  "isDelivery": false,
  "id": null,
  "country": {
    "isoCode": "",
    "name": "",
    "postcodeRequired": false
  },
  "administrativeDivision": {
    "name": "",
    "isoCode": null
  },
  "name": "sample string 1",
  "line1": "sample string 2",
  "line2": "sample string 3",
  "line3": "sample string 4",
  "line4": "sample string 5",
  "line5": "sample string 6",
  "postcode": "sample string 7",
  "town": "sample string 8"
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.