PUT api/customers/deliveryaddress
Update customer delivery address.
Request Information
URI Parameters
None.
Body Parameters
CustomerDeliveryAddressPutRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id for the customer delivery address |
globally unique identifier |
None. |
| CustomerNumber |
Customer number |
integer |
None. |
| Name |
Name on the delivery address |
string |
Required Max length: 50 |
| Address1 |
Address line 1 |
string |
Max length: 50 |
| Address2 |
Address line 2 |
string |
Max length: 50 |
| Address3 |
Address line 3 |
string |
Max length: 50 |
| PostalCode |
Postal code |
string |
Max length: 50 |
| Town |
Town |
string |
Max length: 50 |
| CountryId |
Id of the country |
string |
Max length: 2 |
| Phone1 |
Phone |
string |
Max length: 50 |
| Phone2 | string |
Max length: 50 |
|
| IsDefaultAddress |
True if delivery address should be selected as default in e.g order |
boolean |
Required |
Remarks
None.
Example
None.
Request Formats
application/json, text/json
Sample:
{
"Id": "65a747dc-d8e9-4e69-a511-0bb9a6f7b64d",
"CustomerNumber": 2,
"Name": "sample string 3",
"Address1": "sample string 4",
"Address2": "sample string 5",
"Address3": "sample string 6",
"PostalCode": "sample string 7",
"Town": "sample string 8",
"CountryId": "sample string 9",
"Phone1": "sample string 10",
"Phone2": "sample string 11",
"IsDefaultAddress": true
}
application/xml, text/xml
Sample:
<CustomerDeliveryAddressPutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business"> <Address1>sample string 4</Address1> <Address2>sample string 5</Address2> <Address3>sample string 6</Address3> <CountryId>sample string 9</CountryId> <IsDefaultAddress>true</IsDefaultAddress> <Name>sample string 3</Name> <Phone1>sample string 10</Phone1> <Phone2>sample string 11</Phone2> <PostalCode>sample string 7</PostalCode> <Town>sample string 8</Town> <CustomerNumber>2</CustomerNumber> <Id>65a747dc-d8e9-4e69-a511-0bb9a6f7b64d</Id> </CustomerDeliveryAddressPutRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
CustomerDeliveryAddressPutResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors |
List of errors when updating delivery address for customer |
Collection of PutCustomerDeliveryAddressError |
None. |
| Success |
Returns true if customer delivery address is updated |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Errors": [
{
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
},
{
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
}
],
"Success": true
}
application/xml, text/xml
Sample:
<CustomerDeliveryAddressPutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Business">
<Errors>
<PutCustomerDeliveryAddressError>
<ErrorCode>InternalServerError</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</PutCustomerDeliveryAddressError>
<PutCustomerDeliveryAddressError>
<ErrorCode>InternalServerError</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</PutCustomerDeliveryAddressError>
</Errors>
<Success>true</Success>
</CustomerDeliveryAddressPutResponse>