Custom order search export fields and templates (XML, CSV, XLS)

Overview

Custom order export template capabilities provide you with complete control over order data from the 2Checkout system. Order data portability through customizable reports is available for both eStore and Channel Manager (Partners), enabling you to build reports of the orders placed by shoppers buying directly from you as well as the sales made to your partners.

The 2Checkout order data portability capabilities enable you to export sales information using: XML (Extensible Markup Language - eStore orders only), CSV (comma-separated values) or XLS (Excel) files.

This feature enables you to choose the column headers of the order search report which can be exported as a CSV (comma-separated values) or an XLS (Excel) file, or the XML elements when the export is an XML file. Order data will be included or excluded from the report based on whether the column headers/XML elements governing specific types of information are present or absent in the order report template used for export. Essentially, when a column header/XML element is present, its column will be populated with the corresponding order or product data, provided that it exists in the 2Checkout system.

Benefits

1. Streamlined order data portability;
2. Granular control over you order information;
3. Complete personalization of the orders reporting tool

Availability

Custom order export templates are available by default to all 2Checkout merchants.

Access custom order export templates

eStore orders

1. Go to Orders &customers -> Order search.
2. Select the eStore orders tab.
3. Run a search to identify the orders you're looking for.
4. Click Export.
5. Click Edit templates.

Channel Manager

1. Go to Orders &customers -> Order search.
2. Click the Partner orders tab.
3. Run a search to identify the orders you're looking for.
4. Click Export.
5. Click Edit templates.

You can export Channel Manager/Partner order data only as CSV and XLS files.

Note: Order data available is adapted to the report type you're trying to customize and export. As such, some shopper-specific information will not be featured in the Channel Manager report, and similarly, partner-related details will not be included in the eStore report.

Default templates

Three templates are available by default as read-only. You cannot edit or delete the following:

• 2Checkout Simple Export Template
• 2Checkout Full Options Template
• 2Checkout Chargeback Orders Template

You can build your own custom template using 2Checkout Simple Export Template and 2Checkout Full Options Template by clicking the Edit button. Any changes you make will be saved as a new template, without impacting the default items.

Create a custom template

1. Create a new customer template by:
   
   • Clicking the Add new template button and completely customizing the template;
   • Clicking edit for 2Checkout Simple Export Template and 2Checkout Full Options Template, and customizing the settings of the default templates.
2. Provide a unique name for the template to make it easily distinguishable from similar templates.
3. Select the desired elements from the Additional template elements area either by checking entire categories (in bulk) or standalone items (one by one), and move them to the Template elements area to the right by using the action buttons. The selected items will act as the column headers for the CSV and XLS files, and as the XML elements for the XML export file. Once added to the Template elements headers area, the elements will also be featured in your custom template.
4. You can further personalize the template by:
   
   • Changing the order of the elements in the custom template. To do this simply click on an item added to the Template elements, hold the mouse button pressed, and drag and drop the item in a new position. Note: This action will impact only the CSV and XLS exports. The order of the elements in the XML export file is predefined and will not be changed.
   • Renaming the template elements. Click on the Rename column icon to access a dialog box enabling you to enter a new label that might be better suited to your needs. Changing the name of the elements won't affect the export functionality. Note: This action will impact XML, CSV and XLS exports.
   • Remove elements from the custom template. You can remove elements from a custom template either one by one by clicking the Remove column icon, or in bulk, by multi-selecting items and clicking on the action button designed to place elements back under the Additional template elements area. Note: Removing elements from the custom template will delete any custom names you entered. You'll need to re-enter the custom label for an item that gets re-added to the custom template if previously removed. However, if you removed an element by mistake, and did not save the change, clicking Reset will restore it, complete with the custom label you provided. Note: Removing column headers from the custom template will delete any custom names you entered. You'll need to re-enter the custom label for an item that gets re-added to the custom template if previously removed. However, if you removed a column header by mistake, and did not save the change, clicking Reset will restore it, complete with the custom label you provided.
5. Click Save to preserve the custom template, as well as any custom configurations that you introduced.

Use a custom export template

When exporting order search data, use the drop-down menu to select the item best suited to your needs from the Export Template menu featuring all default and custom export templates.

Set any template that you're using with predilection as the Default template, and it will be pre-selected as the Export Template option.

What happens when I click Reset?

Clicking the Reset button on a custom template restores it to the previously saved state discarding all modifications you made but did not save. Note: All unsaved changes will be lost.

Can I delete templates?

Yes. Click to edit the template you want to be removed, and hit the Delete button in the right-hand side corner of the screen. Note: Template removal actions cannot be undone.

Order search export CSV headers

Order search export XML elements

The elements used in the XML export file for order data reflect the same information as the CSV headers detailed above. However, the labels have been adapted to match XML syntax best practices. Compare the CSV headers table above with the XML tree below to get an idea of the syntax differences.

Note: If you use custom labels for XML elements, please make sure to also follow XML syntax best practices. The 2Checkout system is designed to also ensure that there are no syntax issues, and as such will replace special characters with underscores.

All XML elements feature closing tags as long as there's content included in the export file. For example: <Product_ID>1234567</Product_ID>. Otherwise, if no data is available, the tag format will be: <SKU/>.

<?xml version="1.0" encoding="utf-8"?>
<OrdersSearchExport><Orders>
        <Order>
            <Products>
                <Product>
                    <Product_ID>1234567</Product_ID>
                    <Product_Code>bundle123456</Product_Code>
                    <Product>2Checkout Bundle</Product>
                    <Extra_info>ExtraInformationUsingTheINFOParameter</Extra_info>
                    <Quantity>1</Quantity>
                    <Unit_price__without_VAT_>99</Unit_price__without_VAT_>
                    <Total_Price>99.00</Total_Price>
                    <Total_VAT>0.00</Total_VAT>
                    <Unit_Discount>0.00</Unit_Discount>
                    <Promotion>100%</Promotion>
                    <Promotion_Coupon_Code/>
                    <SKU/>
                    <Subscription>
                        <Licence>New Acquisition</Licence>
                        <Licence>New Acquisition</Licence>
                    </Subscription>
                    <Avangate_subscription_reference>
                        <Licence>CDDA115DD6</Licence>
                        <Licence>DCDAD834F7</Licence>
                    </Avangate_subscription_reference>
                    <RenewalStatus>N/A</RenewalStatus>
                    <DIS_Cost>0.00</DIS_Cost>
                    <DIS_Profit>0.00</DIS_Profit>
                    <Billing_Cycle>N/A</Billing_Cycle>
                    <Billing_Cycles_Left>N/A</Billing_Cycles_Left>
                    <Current_Billing_Cycle>N/A</Current_Billing_Cycle>
                    <Affiliate_Commision>12.38</Affiliate_Commision>
                    <NetIncomePerProduct>77.15736842105264</NetIncomePerProduct>
                    <Product_Additional_Fields/>
                    <Pricing_Options_Name>1 User</Pricing_Options_Name>
                    <Pricing_Options_Code>oneuser1</Pricing_Options_Code>
                    <Fulfillment_information>
                        <Code>___TEST___CODE____</Code>
                    </Fulfillment_information>
                </Product>
                <Product>
                    <Product_ID>4622937</Product_ID>
                    <Product_Code>DISC_32877</Product_Code>
                    <Product>100%</Product>
                    <Extra_info/>
                    <Quantity>1</Quantity>
                    <Unit_price__without_VAT_>-94.05</Unit_price__without_VAT_>
                    <Total_Price>-94.05</Total_Price>
                    <Total_VAT>0.00</Total_VAT>
                    <Unit_Discount>0.00</Unit_Discount>
                    <Promotion/>
                    <Promotion_Coupon_Code/>
                    <SKU/>
                    <Subscription>
                        <Licence>New Acquisition</Licence>
                    </Subscription>
                    <Avangate_subscription_reference>
                        <Licence/>
                    </Avangate_subscription_reference>
                    <RenewalStatus>N/A</RenewalStatus>
                    <DIS_Cost>0.00</DIS_Cost>
                    <DIS_Profit>0.00</DIS_Profit>
                    <Billing_Cycle>N/A</Billing_Cycle>
                    <Billing_Cycles_Left>N/A</Billing_Cycles_Left>
                    <Current_Billing_Cycle>N/A</Current_Billing_Cycle>
                    <Affiliate_Commision>0.00</Affiliate_Commision>
                    <NetIncomePerProduct>-85.06049999999999</NetIncomePerProduct>
                    <Product_Additional_Fields/>
                    <Pricing_Options_Name/>
                    <Pricing_Options_Code/>
                    <Fulfillment_information/>
                </Product>
                <Product>
                    <Product_ID>1234567</Product_ID>
                    <Product_Code>my_subscription_1</Product_Code>
                    <Product>2Checkout Subscription</Product>
                    <Extra_info>ThisIsAdditionalInfoForATrial</Extra_info>
                    <Quantity>1</Quantity>
                    <Unit_price__without_VAT_>99</Unit_price__without_VAT_>
                    <Total_Price>99.00</Total_Price>
                    <Total_VAT>0.00</Total_VAT>
                    <Unit_Discount>9.90</Unit_Discount>
                    <Promotion>100%</Promotion>
                    <Promotion_Coupon_Code>123</Promotion_Coupon_Code>
                    <SKU>NewSubscriptionPurchase</SKU>
                    <Subscription>
                        <Licence>New Acquisition</Licence>
                    </Subscription>
                    <Avangate_subscription_reference>
                        <Licence>22C4327A7E</Licence>
                    </Avangate_subscription_reference>
                    <RenewalStatus>Auto</RenewalStatus>
                    <DIS_Cost>0.00</DIS_Cost>
                    <DIS_Profit>0.00</DIS_Profit>
                    <Billing_Cycle>N/A</Billing_Cycle>
                    <Billing_Cycles_Left>N/A</Billing_Cycles_Left>
                    <Current_Billing_Cycle>N/A</Current_Billing_Cycle>
                    <Affiliate_Commision>11.14</Affiliate_Commision>
                    <NetIncomePerProduct>69.44363157894736</NetIncomePerProduct>
                    <Product_Additional_Fields>
                        <Product_Additional_Field_Item>
                            <Field_Label>CustomField</Field_Label>
                            <Field_Value/>
                        </Product_Additional_Field_Item>
                    </Product_Additional_Fields>
                    <Pricing_Options_Name>1 User</Pricing_Options_Name>
                    <Pricing_Options_Code>oneuser1</Pricing_Options_Code>
                    <Fulfillment_information>
                        <Code>___TEST___CODE____</Code>
                    </Fulfillment_information>
                </Product>
            </Products>
            <Order_No>971</Order_No>
            <Order_status>COMPLETE</Order_status>
            <Test_Order>Yes</Test_Order>
            <Reference_No>43312351</Reference_No>
            <External_Reference_No/>
            <Affiliate_ID>58259</Affiliate_ID>
            <Pay_Method>Visa</Pay_Method>
            <Order_Date>2015-10-22 11:09:35</Order_Date>
            <Order_Finish_Date>2015-10-22 11:11:12</Order_Finish_Date>
            <Currency>USD</Currency>
            <General_Discount>0</General_Discount>
            <Shipping>0</Shipping>
            <Shipping_VAT>0</Shipping_VAT>
            <General_Total>94.05</General_Total>
            <Processing_fee>8.9895</Processing_fee>
            <Company/>
            <Client>2Checkout Blue</Client>
            <Address>Address </Address>
            <Phone/>
            <Email>example@test.com</Email>
            <City>LA</City>
            <Zip_Code>90810</Zip_Code>
            <Country>United States of America</Country>
            <State>Alabama</State>
            <Fiscal_Code/>
            <Registration_Number/>
            <End_user_company/>
            <End_user_name>2Checkout Blue</End_user_name>
            <End_user_address>Address </End_user_address>
            <End_user_phone_number/>
            <End_user_email_address>example@test.com</End_user_email_address>
            <End_user_city>LA</End_user_city>
            <End_user_ZIP_Code>90810</End_user_ZIP_Code>
            <End_user_country>United States of America</End_user_country>
            <End_user_state>Alabama</End_user_state>
            <Affiliate>2Checkout Green</Affiliate>
            <Affiliate_website>test.greener.com</Affiliate_website>
            <Approval_status>Finished</Approval_status>
            <Invoice_Number_Prefix/>
            <Invoice_Number/>
            <EndUserIP>91.220.121.21</EndUserIP>
            <Payment_Currency/>
            <Exchange_Rate/>
            <Final_Exchange_Rate>NO</Final_Exchange_Rate>
            <Shopper_Invoice_No/>
            <Tracking_Order_Id/>
            <Tracking_Id/>
            <Order_Flow>REGULAR</Order_Flow>
            <Net_Profit>61.54</Net_Profit>
            <Sale_Source>www.Mysource.com</Sale_Source>
            <Refund_Comment/>
            <Refund_Reason/>
            <Delivered_Filename/>
            <Downloads_Count>0|</Downloads_Count>
            <URL>http://www.2CheckoutLearningCenter.com</URL>
            <Shopper_Partner_Reference_Number/>
            <Initial_Renewal_Type>N/A</Initial_Renewal_Type>
            <Subscription_Billing_Cycle_Expiration_Date/>
            <Client_First_Name>2Checkout</Client_First_Name>
            <Client_Last_Name>Blue</Client_Last_Name>
            <End_User_First_Name>2Checkout</End_User_First_Name>
            <End_User_Last_Name>Blue</End_User_Last_Name>
            <Media_Type/>
            <Origin>Web</Origin>
            <Gateway_Response>N/A</Gateway_Response>
            <Order_Additional_Fields>
                <Order_Additional_Field_Item>
                    <Field_Label>Where did you hear about our company?</Field_Label>
                    <Field_Value/>
                </Order_Additional_Field_Item>
            </Order_Additional_Fields>
            <Pricing_Options_Value>0.00</Pricing_Options_Value>
            <Pricing_Options_Operator>ADD</Pricing_Options_Operator>
            <Initial_dispute_request/>
            <Chargeback_Close_Date/>
            <Chargeback_Reason/>
            <Chargeback_Reason_Code/>
            <Chargeback_Status/>
            <Original_External_Reference_No/>
            <Original_Sale_Source/>
        </Order></Orders><Timezone>
</OrdersSearchExport>

The XML structure groups orders under the Orders element, marked with the <Orders></Orders> tags.

Orders elements include the order export items, namely one or multiple orders. Order-level elements are included under Order, such as Products, when multiple offerings are acquired via the same order, while product-level elements are placed under Product.