Try Unleashed Now Sandbox

    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
    show json example

    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.