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
AddressPatchName | Description | 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:
<AddressPatch> <Country>sample string 9</Country> <AdministrativeDivision>sample string 11</AdministrativeDivision> <Name>sample string 13</Name> <Line1>sample string 14</Line1> <Line2>sample string 15</Line2> <Line3>sample string 16</Line3> <Line4>sample string 17</Line4> <Line5>sample string 18</Line5> <Postcode>sample string 19</Postcode> <Town>sample string 20</Town> </AddressPatch>
Response Information
Resource Description
CustomerAddressName | Description | 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:
<CustomerAddress> <IsBilling>false</IsBilling> <IsDelivery>false</IsDelivery> <Id nil="true" /> <Country> <Country> <IsoCode /> <Name /> <PostcodeRequired>false</PostcodeRequired> </Country> </Country> <AdministrativeDivision> <AdministrativeDivision> <Name /> <IsoCode nil="true" /> </AdministrativeDivision> </AdministrativeDivision> <Name>sample string 1</Name> <Line1>sample string 2</Line1> <Line2>sample string 3</Line2> <Line3>sample string 4</Line3> <Line4>sample string 5</Line4> <Line5>sample string 6</Line5> <Postcode>sample string 7</Postcode> <Town>sample string 8</Town> </CustomerAddress>