Retrieve Order Information

Retrieve a list of orders

/webapps/cms/widgets/shopping/reports/edi/view-orders.csv?cid=99999999&password=ZZZZZZZZZZZZ&delimiter=,&fromdate=&todate=&orders=1

Parameter Values/Type Description
delimiter , TAB | ||| ~ if included, then changes document type to a download file, and uses specified character(s) as the delimiter
fromdate yyyy-MM-dd accepts most formated dates
todate yyyy-MM-dd accepts most formated dates
products =1 or exclude includes individual item lines and product data, with order headers repeated on each line (otherwise only order headers)
shipping =1 or exclude includes shipping/purchaser columns
orders =1 or exclude includes only finalised orders, or without shows orders in progress or stale old orders.
paid =1 or exclude includes only orders marked as paid in our system, or automatically marked as paid by credit cards
affiliate =1 or exclude show affiliate columns, or nulls if the order was not due to any affiliate
member =1 or exclude show the member record (might be different from the purchaser details if this a subsequent order)
cid number get this info from the FTP area... just the number without the CID prefix
password text get this info from the FTP area... it is the FTP password
b_id number the basket/order/invoice ID

 

Retrieve an Individual Order

/webapps/cms/widgets/shopping/reports/edi/view-order.xml?cid=99999999&password=ZZZZZZZZZZZZ&b_id=7777777

XML returned should be faily self explanetory...

Notes re GST

if IncludesTax=false, then this means that we did not specifically calculate GST.. but all prices could be assumed to be GST inclusive, so if you know this yourself to be true, then tou would then consider if IsDomestic=true, that GST was included.

Example XML Output

<?xml version="1.0" encoding="UTF-8"?>
<Invoices>
   <Invoice>
      <InvoiceType>ACCREC</InvoiceType>
      <Contact>
         <MemberID>2727791</MemberID>
         <Name>Cash Sale</Name>
         <Company />
         <EmailAddress>cash@gmail.com</EmailAddress>
         <Phone>Cash Sale</Phone>
         <Addresses>
            <Address>
               <AddressType>STREET</AddressType>
               <AddressLine1 />
               <AddressLine2 />
               <AddressCity />
               <AddressState />
               <AddressPostcode />
               <AddressCountry />
            </Address>
         </Addresses>
      </Contact>
      <Delivery>
         <Name>Cash Sale</Name>
         <Company />
         <EmailAddress>cash@gmail.com</EmailAddress>
         <Phone>Cash Sale</Phone>
         <Addresses>
            <Address>
               <AddressType>STREET</AddressType>
               <AddressLine1 />
               <AddressLine2 />
               <AddressCity />
               <AddressState />
               <AddressPostcode />
               <AddressCountry />
            </Address>
         </Addresses>
         <PreferredDeliveryTime />
      </Delivery>
      <GiftMessage />
      <Comments />
      <InvoiceDate>2017-04-11T00:00:00</InvoiceDate>
      <InvoiceNumber>24118653</InvoiceNumber>
      <InvoiceNumberFormatted>TTT24118653</InvoiceNumberFormatted>
      <BasketID>24118653</BasketID>
      <Reference />
      <Currency>$</Currency>
      <FxRate>1.0000</FxRate>
      <IsDomestic>false</IsDomestic>
      <Status>
         <PaymentStatus>
            <AmountPaid>2.23</AmountPaid>
            <PaidDate>2017-04-11T00:00:00</PaidDate>
         </PaymentStatus>
         <ShippingStatus>
            <ShippedDate>2017-04-11T00:00:00</ShippedDate>
            <CourierReference />
            <CourierURL />
         </ShippingStatus>
      </Status>
      <Totals>
         <TotalDiscount>4.35</TotalDiscount>
         <TotalVouchers>0.00</TotalVouchers>
         <TotalShipping>0.00</TotalShipping>
         <TotalTax>0.00</TotalTax>
         <TotalTransactionFee>0.00</TotalTransactionFee>
         <TotalToPay>2.23</TotalToPay>
         <TotalSavings>4.35</TotalSavings>
         <TotalGrams>0</TotalGrams>
      </Totals>
      <IncludesTax>false</IncludesTax>
      <SubTotal>2.23</SubTotal>
      <Total>2.23</Total>
   </Invoice>
   <Invoice>
      <InvoiceType>ACCREC</InvoiceType>
      <Contact>
         <MemberID>2726817</MemberID>
         <Name>rsrdgr</Name>
         <Company />
         <EmailAddress>ads@saf.yu</EmailAddress>
         <Phone>343232442342</Phone>
         <Addresses>
            <Address>
               <AddressType>STREET</AddressType>
               <AddressLine1>fdgfdg</AddressLine1>
               <AddressLine2 />
               <AddressCity>dfgdfg</AddressCity>
               <AddressState />
               <AddressPostcode>345435</AddressPostcode>
               <AddressCountry>New Zealand</AddressCountry>
            </Address>
         </Addresses>
      </Contact>
      <Delivery>
         <Name>rsrdgr</Name>
         <Company />
         <EmailAddress>ads@saf.yu</EmailAddress>
         <Phone>343232442342</Phone>
         <Addresses>
            <Address>
               <AddressType>STREET</AddressType>
               <AddressLine1>fdgfdg</AddressLine1>
               <AddressLine2 />
               <AddressCity>dfgdfg</AddressCity>
               <AddressState />
               <AddressPostcode>345435</AddressPostcode>
               <AddressCountry>New Zealand</AddressCountry>
            </Address>
         </Addresses>
         <PreferredDeliveryTime />
      </Delivery>
      <GiftMessage />
      <Comments />
      <InvoiceDate>2017-04-10T00:00:00</InvoiceDate>
      <InvoiceNumber>24116839</InvoiceNumber>
      <InvoiceNumberFormatted>24116839</InvoiceNumberFormatted>
      <BasketID>24116839</BasketID>
      <Reference />
      <Currency>NZD</Currency>
      <FxRate>1.0000</FxRate>
      <IsDomestic>true</IsDomestic>
      <Status>
         <PaymentStatus>
            <AmountPaid>0.00</AmountPaid>
            <PaidDate />
         </PaymentStatus>
         <ShippingStatus>
            <ShippedDate />
            <CourierReference />
            <CourierURL />
         </ShippingStatus>
      </Status>
      <Totals>
         <TotalDiscount>4.35</TotalDiscount>
         <TotalVouchers>0.00</TotalVouchers>
         <TotalShipping>0.00</TotalShipping>
         <TotalTax>0.00</TotalTax>
         <TotalTransactionFee>0.00</TotalTransactionFee>
         <TotalToPay>56.45</TotalToPay>
         <TotalSavings>39.55</TotalSavings>
         <TotalGrams>0</TotalGrams>
      </Totals>
      <IncludesTax>false</IncludesTax>
      <SubTotal>56.45</SubTotal>
      <Total>56.45</Total>
   </Invoice>
   <Invoice>
      <InvoiceType>ACCREC</InvoiceType>
      <Contact>
         <MemberID>2720029</MemberID>
         <Name>sdfsdfasdfasd</Name>
         <Company>sdfasdfasdf</Company>
         <EmailAddress>asdfasdfasd@sdfsdfsddfs.com</EmailAddress>
         <Phone>dfsdfasdfasd</Phone>
         <Addresses>
            <Address>
               <AddressType>STREET</AddressType>
               <AddressLine1>sdfasdfasdfas</AddressLine1>
               <AddressLine2>asdfasdf</AddressLine2>
               <AddressCity>sdfasdfasd</AddressCity>
               <AddressState>asdfasdfasd</AddressState>
               <AddressPostcode>sdfsdfasdfas</AddressPostcode>
               <AddressCountry>New Zealand</AddressCountry>
            </Address>
         </Addresses>
      </Contact>
      <Delivery>
         <Name>sdfsdfasdfasd</Name>
         <Company>sdfasdfasdf</Company>
         <EmailAddress>asdfasdfasd@sdfsdfsddfs.com</EmailAddress>
         <Phone />
         <Addresses>
            <Address>
               <AddressType>STREET</AddressType>
               <AddressLine1>sdfasdfasdfas</AddressLine1>
               <AddressLine2>asdfasdf</AddressLine2>
               <AddressCity>sdfasdfasd</AddressCity>
               <AddressState>asdfasdfasd</AddressState>
               <AddressPostcode>sdfsdfasdfas</AddressPostcode>
               <AddressCountry>New Zealand</AddressCountry>
            </Address>
         </Addresses>
         <PreferredDeliveryTime />
      </Delivery>
      <GiftMessage />
      <Comments />
      <InvoiceDate>2017-04-04T00:00:00</InvoiceDate>
      <InvoiceNumber>24105469</InvoiceNumber>
      <InvoiceNumberFormatted>TTT24105469</InvoiceNumberFormatted>
      <BasketID>24105469</BasketID>
      <Reference />
      <Currency>NZD</Currency>
      <FxRate>1.0000</FxRate>
      <IsDomestic>true</IsDomestic>
      <Status>
         <PaymentStatus>
            <AmountPaid>0.00</AmountPaid>
            <PaidDate />
         </PaymentStatus>
         <ShippingStatus>
            <ShippedDate />
            <CourierReference />
            <CourierURL />
         </ShippingStatus>
      </Status>
      <Totals>
         <TotalDiscount>0.00</TotalDiscount>
         <TotalVouchers>0.00</TotalVouchers>
         <TotalShipping>0.00</TotalShipping>
         <TotalTax>150.21</TotalTax>
         <TotalTransactionFee>0.00</TotalTransactionFee>
         <TotalToPay>1151.60</TotalToPay>
         <TotalSavings>100.14</TotalSavings>
         <TotalGrams>0</TotalGrams>
      </Totals>
      <IncludesTax>true</IncludesTax>
      <SubTotal>1001.39</SubTotal>
      <TotalTax>150.21</TotalTax>
      <Total>1151.60</Total>
   </Invoice>
</Invoices>

Index Next