Aurora API: Address

Address

Most address management is done via the 'Customer' and 'Order' methods as described in the Aurora API: Customer and Aurora API: Order sections in this document. This includes adding and modifying addresses for customers and orders. This section deals only with the removal of addresses. This is due to the nature of the way addresses are used in Aurora. An address assigned to an order cannot be removed, as this would leave the order with an incomplete set of data, whereas addresses assigned specifically to a Customer account can be removed without any problem.

The API takes care of these considerations automatically to ensure data integrity and can be used as described below.

Delete

Deferred: No

This method accepts any number of address IDs to be removed and processes each individually returning any failures during the removal process.

Example Request:

 <AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <Header>
         <AuthToken>...</AuthToken>
     </Header>
     <Requests>
         <Request>
             <Address>
                 <Delete>
                     <RequestID>1</RequestID>
                     <AddressIDs>
                         <AddressID>1</AddressID>
                     </AddressIDs>
                 </Delete>
             </Address>
         </Request>
     </Requests>
 </AuroraRequestEnvelope>

Example response (successful):

<AuroraResponseEnvolope>
    <Header>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
        </Response>
    </Responses>
</AuroraResponseEnvolope>

Example response (unsuccessful):

 <AuroraResponseEnvolope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>0</RequestsSucceeded>
             <RequestErrors>1</RequestErrors>
         </Summary>
     </Header>
     <Responses>
        <Response>
             <RequestID>1</RequestID>
             <Ack>FATAL</Ack>
             <Errors>
                 <Error>
                     <Code>-9</Code>
                     <Message>Record not found: Address #1</Message>
                     <Severity>FATAL</Severity>
                     <Data>a:1:{s:9:"AddressID";s:1:"1";}</Data>
                 </Error>
             </Errors>
         </Response>
     </Responses>
</AuroraResponseEnvolope>