Customer Delivery Addresses
The CustomerDeliveryAddresses resource allows CustomerDeliveryAddresses to be listed.
/CustomerDeliveryAddresses - returns a list of all Customer Delivery Addresses.
The full range of URIs and HTTP Verbs supported are:
| Operation |
HTTP Action |
| List all Customer Delivery Addresses |
GET /CustomerDeliveryAddresses |
GET CustomerDeliveryAddresses
These filters can be used with the GET CustomerDeliveryAddresses endpoint:
| Filter |
Description |
customerCode |
Only return customers that start with the specific customer code |
Note: Default ordering is based on the field customerId ascending
Available Fields for CustomerAddress:
| Property |
Type |
Length |
Required |
Notes |
| Addresses |
CustomerDeliveryAddress collection |
|
|
|
| CustomerCode |
String |
|
Yes |
|
Available fields for CustomerDeliveryAddress:
| Property |
Type |
Length |
Required |
Notes |
| AddressName |
String |
|
|
|
| AddressType |
String |
|
|
|
| City |
String |
|
|
|
| Country |
String |
|
|
|
| DeliveryInstruction |
String |
500 |
|
|
| PostalCode |
String |
|
|
|
| Region |
String |
|
|
|
| StreetAddress |
String |
|
|
|
| StreetAddress2 |
String |
|
|
|
| Suburb |
String |
|
|
|
| Obsolete |
Boolean |
true,false |
|
|
Examples for Request GET /CustomerDeliveryAddresses
show xml example
<?xml version="1.0"?>
<CustomerDeliveryAddresses xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
<Pagination>
<NumberOfItems>1</NumberOfItems>
<PageSize>200</PageSize>
<PageNumber>1</PageNumber>
<NumberOfPages>1</NumberOfPages>
</Pagination>
<CustomerDeliveryAddress>
<CustomerCode>FRANCK</CustomerCode>
<Addresses>
<CustomerDeliveryAddress>
<AddressName>Main Warehouse</AddressName>
<StreetAddress>31 Hurstmere Road</StreetAddress>
<StreetAddress2>Takapuna Beach Centre</StreetAddress2>
<Suburb>Takapuna</Suburb>
<City>Auckland</City>
<Region>North Shore</Region>
<Country>New Zealand</Country>
<PostalCode>0622</PostalCode>
<Obsolete>false</Obsolete>
<DeliveryInstruction>Handle with care.</DeliveryInstruction>
</CustomerDeliveryAddress>
</Addresses>
</CustomerDeliveryAddress>
</CustomerDeliveryAddresses>
show json example
{
"Pagination": {
"NumberOfItems": 1,
"PageSize": 200,
"PageNumber": 1,
"NumberOfPages": 1
},
"Items": [
{
"AddressIds": [
3
],
"CustomerId": 0,
"CustomerCode": "FRANCK",
"Addresses": [
{
"AddressType": null,
"AddressName": "Main Warehouse",
"StreetAddress": "31 Hurstmere Road",
"StreetAddress2": "Takapuna Beach Centre",
"Suburb": "Takapuna",
"City": "Auckland",
"Region": "North Shore",
"Country": "New Zealand",
"PostalCode": "0622",
"Obsolete": false,
"DeliveryInstruction": "Handle with care."
}
]
}
]
}
Use the API Sandbox to see how the object is rendered in JSON or XML.
Note: An Unleashed account is required before you can use the API Sandbox.
Trial accounts are also allowed to connect to the API.
You can register a new account here: Register.
