Aurora API: Order Part Despatch

OrderPartDespatch

Using this controller you can add, update and retrieve all information related to a part dispatch. This includes updating attributes, statuses, addresses and all other part dispatch related values. You may also create empty PartDespatch IDs to later pass into the OrderPartDespatch Update method to assign ordered items to it.

Add

Deferred: No

📘

Please note that the following setting needs to be unchecked in order for this API endpoint to work, otherwise a fatal error will be thrown: Aurora backend UI > Store > Settings > Aurora > Orders > Disable order splitting.

A number of validations are performed on the request:

• UnassignedPartOrderID cannot be specified when UnassignedItemDestination equals 'new'
• ItemID's must exist and must belong to the Order (OrderID)
• The supplied QuantityExpected must be the same as the original ordered item's product quantity
• The supplied ItemID's must NOT be already assigned to another Part Despatch

Example Request:

 <?xml version="1.0" encoding="utf-8"?>
 <AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Header>
        <AuthToken>...</AuthToken>
    </Header>
    <Requests>
        <Request>
            <Order>
                <PartDespatch>
                    <Add send_confirmation="yes">
                        <OrderID>1</OrderID>
                        <PartOrderStatus>Dispatched (Courier)</PartOrderStatus>
                        <PartOrderNote>Custom note</PartOrderNote>
                        <PartOrderShippingSku>SKUEurope</PartOrderShippingSku>
                        <PartOrderShippingCost>80.00</PartOrderShippingCost>
                        <PartOrderShippingTax>20.00</PartOrderShippingTax>
                        <ShippingAddress>
                            <StorageType>P</StorageType>
                            <AddressType>ST</AddressType>
                            <EmailAddress>[email protected]</EmailAddress>
                            <OptOut>0</OptOut>
                            <Gender>male</Gender>
                            <CompanyName></CompanyName>
                            <FirstName>TEST</FirstName>
                            <LastName>API</LastName>
                            <AddressLine1>25</AddressLine1>
                            <AddressLine2>RINGWAY AVE</AddressLine2>
                            <Town>LEIGH</Town>
                            <County>LANCS</County>
                            <PostCode>WN7 1TX</PostCode>
                            <Country>United Kingdom</Country>
                            <PhoneNumber>0101010101</PhoneNumber>
                            <MobileNumber>0202020202</MobileNumber>
                        </ShippingAddress>
                        <CourierName>Royal Mail Airmail Letter</CourierName>
                        <TrackingNumber>12321412X</TrackingNumber>
                        <Items>
                            <Item>
                                <ItemID>2</ItemID>
                                <QuantityExpected>1</QuantityExpected>
                            </Item>
                        </Items>
                        <UnassignedItemDestination>existing</UnassignedItemDestination>
                        <UnassignedPartOrderID>123</UnassignedPartOrderID>
                    </Add>
                </PartDespatch>
            </Order>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example Response:

 <?xml version="1.0" encoding="utf-8"?>
 <AuroraResponseEnvelope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>1</RequestsSucceeded>
             <RequestErrors>0</RequestErrors>
         </Summary>
     </Header>
     <Responses>
         <Response>
             <RequestID>1</RequestID>
             <Ack>OK</Ack>
             <Data>
                <PartOrderID>1</PartOrderID>
				<UnassignedPartOrderID>2</PartOrderID>
             </Data>
         </Response>
     </Responses>
</AuroraResponseEnvelope>

Request Fields

This section only covers a few of the unique request fields that are applicable only to this method. All other fields are described with the OrderGet method.

Update

Deferred: No

Example Request:

 <?xml version="1.0" encoding="utf-8"?>
 <AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Header>
        <AuthToken>...</AuthToken>
    </Header>
    <Requests>
        <Request>
            <Order>
                <PartDespatch>
                    <Update send_confirmation="yes">
						<PartOrderID>4</PartOrderID>
                        <PartOrderStatus>Dispatched (Courier)</PartOrderStatus>
                        <PartOrderNote>Custom note</PartOrderNote>
                        <PartOrderShippingSku>SKUEurope</PartOrderShippingSku>
                        <PartOrderShippingCost>80.00</PartOrderShippingCost>
                        <PartOrderShippingTax>20.00</PartOrderShippingTax>
                        <ShippingAddress>
                            <StorageType>P</StorageType>
                            <AddressType>ST</AddressType>
                            <EmailAddress>[email protected]</EmailAddress>
                            <OptOut>0</OptOut>
                            <Gender>male</Gender>
                            <CompanyName></CompanyName>
                            <FirstName>TEST</FirstName>
                            <LastName>API</LastName>
                            <AddressLine1>25</AddressLine1>
                            <AddressLine2>RINGWAY AVE</AddressLine2>
                            <Town>LEIGH</Town>
                            <County>LANCS</County>
                            <PostCode>WN7 1TX</PostCode>
                            <Country>United Kingdom</Country>
                            <PhoneNumber>0101010101</PhoneNumber>
                            <MobileNumber>0202020202</MobileNumber>
                        </ShippingAddress>
                        <CourierName>Royal Mail Airmail Letter</CourierName>
                        <TrackingNumber>12321412X</TrackingNumber>
                        <Items>
                            <Item>
                                <ItemID>2</ItemID>
                                <QuantityExpected>1</QuantityExpected>
                            </Item>
                        </Items>
                        <UnassignedItemDestination>existing</UnassignedItemDestination>
                        <UnassignedPartOrderID>123</UnassignedPartOrderID>
                    </Update>
                </PartDespatch>
            </Order>
        </Request>
    </Requests>
</AuroraRequestEnvelope>

Example Response:

 <?xml version="1.0" encoding="utf-8"?>
 <AuroraResponseEnvelope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>1</RequestsSucceeded>
             <RequestErrors>0</RequestErrors>
         </Summary>
     </Header>
     <Responses>
         <Response>
             <RequestID>1</RequestID>
             <Ack>OK</Ack>
             <Data>
                <PartOrderID>4</PartOrderID>
				<UnassignedPartOrderID>123</PartOrderID>
             </Data>
         </Response>
     </Responses>
</AuroraResponseEnvelope>

Request Fields

This section only covers a few of the unique request fields that are applicable only to this method. All other fields are described with the OrderGet method.

Get

Deferred: Conditional

This method is deferred if requests are made without a limit or paging applied.

Part Orders returned by this call are currently always ordered by the date they were placed. This may change, so you should consider specifying the sort order of your results if this is going to effect your systems performance in the future.

Example Request:

 <?xml version="1.0" encoding="utf-8"?>
 <AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <Header>
                 <AuthToken>...</AuthToken>
         </Header>
         <Requests>
                 <Request>
                         <Order>
								<PartDespatch>
                             		    <Get tracking="automatic|none">
                                         		<PartOrderID>1</PartOrderID>
                                         		<Limit>100</Limit>
                                         		<Paging>
                                                		<Limit>20</Limit>
                                                 		<Page>1</Page>
                                         		</Paging>
                                 		</Get>
								</PartDespatch>
                         </Order>
                 </Request>
         </Requests>
 </AuroraRequestEnvelope>

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<AuroraResponseEnvelope>
   <Header>
      <Summary>
         <Ack>OK</Ack>
         <RequestsProcessed>1</RequestsProcessed>
         <RequestsSucceeded>1</RequestsSucceeded>
         <RequestErrors>0</RequestErrors>
      </Summary>
   </Header>
   <Responses>
      <Response>
         <RequestID>1</RequestID>
         <Ack>OK</Ack>
         <Data>
            <PartOrderDespatch>
               <OrderID>12345678</OrderID>
               <PartOrderID>8</PartOrderID>
               <PartOrderStatus>Default status</PartOrderStatus>
               <PartOrderNote>Some note</PartOrderNote>
               <CourierName>Courier name</CourierName>
               <CourierCode>CCODE</CourierCode>
               <TrackingNumber>1234567890</TrackingNumber>
               <ShippingDate>2017-05-30 00:00:00</ShippingDate>
               <PartOrderShippingSku>XXZSTD</PartOrderShippingSku>
               <PartOrderShippingCost>80.00</PartOrderShippingCost>
               <PartOrderShippingTax>20.00</PartOrderShippingTax>
               <ShippingAddress>
                  <AddressID>1</AddressID>
                  <CustomerID>0</CustomerID>
                  <StorageType>I</StorageType>
                  <AddressType>ST</AddressType>
                  <EmailAddress>[email protected]</EmailAddress>
                  <OptOut>0</OptOut>
                  <Gender>female</Gender>
                  <CompanyName>Company name</CompanyName>
                  <Title>Miss</Title>
                  <FirstName>Customer</FirstName>
                  <LastName>ABID-2026619</LastName>
                  <AddressLine1>1 BILLING Road</AddressLine1>
                  <AddressLine2>Sunshine View</AddressLine2>
                  <Town>Pixyland</Town>
                  <County>Lakeside</County>
                  <PostCode>AB1 2CD</PostCode>
                  <Country>Some country</Country>
                  <PhoneNumber>2739128</PhoneNumber>
                  <MobileNumber>15022455</MobileNumber>
               </ShippingAddress>
               <CalculatedPaymentTotal>159.97</CalculatedPaymentTotal>
               <PaymentTaken />
               <Items>
                  <Item>
                     <ItemID>2549875</ItemID>
                     <Quantity>1</Quantity>
                  </Item>
                  <Item>
                     <ItemID>2549877</ItemID>
                     <Quantity>2</Quantity>
                  </Item>
               </Items>
            </PartOrderDespatch>
         </Data>
      </Response>
   </Responses>
</AuroraResponseEnvelope>

Request Fields