Customer Delivery Addresses

The CustomerDeliveryAddresses resource allows CustomerDeliveryAddresses to be listed.

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
List a page of Customer Delivery Addresses	GET `/CustomerDeliveryAddresses`

GET CustomerDeliveryAddresses

Available Filters for GET Customer Delivery Addresses

Filter	Description
`customerCode`	Returns Delivery Addresses for Customers that start with the specific customer code.
`modifiedSince`	Returns Delivery Addresses created or edited after a specified date.
`pageSize`	Specifies the page size for pagination. Default page size is 200 customers. Note: Requesting large numbers of customers can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.

Note: Date filters should be provided in the ISO format YYYY-MM-DD.

Filters are used by adding the filter and value to the URI:

/CustomerDeliveryAddresses?customerCode=ACME&modifiedSince=2012-01-01

Available Fields for Customer Delivery Addresses

Property	Type	Length
Addresses	CustomerDeliveryAddresses collection
CustomerCode	String	500

Availble Fields for Customer Delivery Address

Property	Type	Length
AddressName	String
AddressType	String
City	String
Country	String
DeliveryInstruction	String	500
Guid	Guid
LastModifiedOn	DateTime
Obsolete	Boolean	`true`,`false`
PostalCode	String
Region	String
StreetAddress	String
StreetAddress2	String
Suburb	String

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>
        <LastModifiedOn>2024-05-28T22:11:09.6589976</LastModifiedOn>
        <Guid>aeae2924-4d66-413c-8faf-463e50d3dc65</Guid>
      </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.",
                    "LastModifiedOn": "/Date(1716934269658)/",
                    "Guid": "9a1effae-f705-45e0-bc87-409e567f7de4"
                }
            ]
        }
    ]
}

Customer Delivery Addresses

The full range of URIs and HTTP Verbs supported are:

GET CustomerDeliveryAddresses

Examples for Request GET /CustomerDeliveryAddresses

Examples for Request GET `/CustomerDeliveryAddresses`