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
Streamlined order data portability;
Granular control over your order information;
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
Go to Orders &customers -> Order search.
Select the eStore orders tab.
Run a search to identify the orders you're looking for.
Click Export.
Click Edit templates.
COMPLETE
Finished
Finished
The order was fulfilled.
AUTHRECEIVED
Pending approval
Pending approval
The order has yet to be approved.
In progress / Processing
In progress
The order was approved.
Suspect
Suspect
Suspect order - potential fraud.
REVERSED
Canceled
Canceled
The order was canceled before fulfillment.
PENDING
Unfinished
Unfinished
The order has yet to be approved.
Suspect
Suspect
Suspect order - potential fraud.
TEST
TEST
TEST
Test order.
TOTAL REFUND
Refunded
Refunded
Full refund.
PARTIAL REFUND
Refunded
Refunded
Partial refund.
CHARGEBACK
Refunded
Refunded
Full refund as a result of a lost chargeback.
Channel Manager
Go to Orders &customers -> Order search.
Click the Partner orders tab.
Run a search to identify the orders you're looking for.
Click Export.
Click Edit templates.
You can export Channel Manager/Partner order data only as CSV and XLS files.
The 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 the 2Checkout Simple Export Template and the 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
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.
Provide a unique name for the template to make it easily distinguishable from similar templates.
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.
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.
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.
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.
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.
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.
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.
Template removal actions cannot be undone.
Order search export CSV headers
Order
Reference No
Order reference identifier. A refund order will have the same Reference No as the initial order.
int
INT
Order status
Possible values:
COMPLETE
AUTHRECEIVED
REVERSED
PENDING
TEST
TOTAL REFUND
PARTIAL REFUND
CHARGEBACK
string
VARCHAR(30)
Approval status
Possible values:
Finished
Pending approval
In progress
Canceled
Unfinished
TEST
Suspect
Refunded
string
VARCHAR(30)
Order No
Orders placed by your customers receive consecutive numbers. Order No can be null for unfinished orders.
int
INT
External Reference No
An identifier that you can set for orders.
string
VARCHAR(38)
Original External Reference No
The External Reference No values set for the initial orders when the subscriptions were first acquired. Available for subscription renewals. Not available in the default template. For bundled products, multiple reference numbers are separated using "|", as such: RefNo1| RefNo2.
string
VARCHAR(100)
Order Date
The date when the order was placed. Datetime stamp is time zone sensitive.
datetime (yyyy-mm-dd hh:ii:ss)
DATETIME
Order Finish Date
The date when the order was finished. Datetime stamp is time zone sensitive.
datetime (yyyy-mm-dd hh:ii:ss)
DATETIME
Pay Method
The name of the payment method used by the shopper:
Visa
MasterCard
Wire transfer
American Express
Diners Club
PayPal
And more.
string
VARCHAR(30)
Gateway Response
The answer received from the payment processor. Possible values: Approved, error message, N/A (when this functionality is not available for your account).
string
VARCHAR(30)
Origin
Possible values:
Web - new acquisitions or manual renewal orders placed via Web
API - orders placed via API
Automatic Billing - orders renewed automatically by 2Checkout
Mobile - orders placed through Mobile devices
string
VARCHAR(30)
Sale Source
The URL used by customers to reach the shopping cart. Not available for partner orders.
string
VARCHAR(255)
Delivery Type
Product delivery type. Possible values:
Electronic
Physical
Electronic and physical
string
VARCHAR(255)
Shipping date
Order shipment date. Orders for physical products that are not marked as shipped will appear as 'Not shipped'.
Orders for electronic products are displayed with 'N/A'.
string
VARCHAR(255)
Original Sale Source
Sale source (link source, the SRC parameter) values for the initial orders when the subscriptions were first acquired. Available for subscription renewals. Not available in the default template. For bundled products, multiple sale sources are separated using "|", as such: Source1| Source2.
string
VARCHAR(255)
EndUserIP
Shopper IP.
string: (127.0.0.1)
VARCHAR(20)
Fulfillment information
Activation keys delivered to customers. For bundled products, multiple product keys are separated using "|", as such: Key1| Key2.
string
VARCHAR(255)
Chargeback Status
The status of the chargeback dispute from the moment the report is generated.
Possible values:
OPEN = a chargeback was opened by a customer and the dispute continues to be unresolved.
WON = the dispute was won by you and no money was paid back to the customer.
LOST = the dispute was lost and the entire value of the order was reimbursed to the customer.
NONE = if a chargeback wasn't requested.
string
VARCHAR(20)
Chargeback Reason
The reason why the chargeback was initiated. Possible values:
1. Order not fulfilled/not delivered: Customers claim that they did now receive the product they purchased or that they cannot access the service acquired.
2. Product(s) not as described/unfunctional: Customers claim that the product/subscription/service purchased does not work or functions differently than you advertised it would.
3. Duplicate order: Customers claim that they were charged twice when purchasing the same product.
4. Fraud/Order not recognized: Customers claim that they don't recognize the charge.
5. Agreed refund not processed: Customers have opened a chargeback dispute because the refund they agreed on with you failed to process.
6. New/renewal order not recognized: Customers have opened a chargeback dispute because the refund they agreed on with you failed to process.
7. Authorization problem: Customers claim that the payment authorization failed and are surprised to see that the charge went through.
8. Information request: The customer's bank requested details about a charge. This is a temporary status, which can be closed once customers recognize the charge, or result in a chargeback for one of the reasons listed above.
string
VARCHAR(80)
Chargeback Reason Code
An identifier for the chargeback dispute reason from the 2Checkout system. Possible values:
MERCHANDISE_NOT_RECEIVED - Order not fulfilled/not delivered
NOT_AS_DESCRIBED - Product(s) not as described/nonfunctional
DUPLICATE_TRANSACTION - Duplicate order
FRAUD / NOT_RECOGNIZED - Fraud/Order not recognized
CREDIT_NOT_PROCESSED - Agreed refund not processed
NOT_RECOGNIZED - New/renewal order not recognized
AUTHORIZATION_PROBLEM - Authorization problem
INFO_REQUEST - Information request
UNKNOWN - Unknown
String
VARCHAR(25)
Chargeback Request Date
The date when the chargeback dispute was initiated. Datetime stamp is time zone sensitive.
datetime (yyyy-mm-dd hh:ii:ss)
DATETIME
Chargeback Close Date
The date when the chargeback dispute was closed. Datetime stamp is time zone sensitive.
datetime (yyyy-mm-dd hh:ii:ss
DATETIME
Order Additional Fields
Information collected from customers during the ordering process via one or multiple per-order custom additional fields. The Order Additional Fields column will report data collected from shoppers according to the following format:
- for CSV and XLS: "Field Name: Value." When multiple additional fields are used for a single order, data reported will be separated using "|", as such: Field Name1: Value1| Field Name2: Value2.
This column will be filled only for the first line of that order (first product) in the export file.
For "CHECKBOX" additional fields, if the field was checked during the ordering process "CHECKED" value is showed in the export file. If the field was not checked, no information is displayed in the export.
- for XML: <Order_Additional_Fields> <Order_Additional_Field_Item> <Field_Label>Label1(the same as the Field text)</Field_Label>
<Field_Value>Value1</Field_Value>
</Order_Additional_Field_Item> <Order_Additional_Field_Item>
<Field_Label>Label2 (the same as the Field text)</Field_Label> <Field_Value>Value2</Field_label>
</Order_Additional_Field_Item>
</Order_Additional_Fields>
Order_Additional_Fields elements will be displayed per-order.
string
VARCHAR(255)
Shopper / Partner Reference Number
The internal reference number your customers or partners assign to orders during the checkout process.
Customers and partners using Purchase Orders (POs) as the payment method during the ordering process have the option of setting identifiers for their orders designed to track and manage purchases in their own system.
string
VARCHAR(255)
Refund Comment
Comments entered for refunded orders. Displayed only on the first row of a refund order.
string
VARCHAR(255)
Test Order
Differentiates test orders from real orders. Available values:
YES
NO
boolean
VARCHAR(3)
Product
Product ID
The unique identifier of products configured in the 2Checkout system.
int
INT
Product Code
The identifiers that you control and can associate with products configured in the 2Checkout system.
string
VARCHAR(38)
Product
Product name.
string
VARCHAR(80)
Extra info
The text entered in the Additional information field when generating Buy links, or via the INFO[productid]= parameter used in the Buy links.
string
VARCHAR(255)
Pricing Options Name
The name of the pricing option selected by the shopper during the purchase process.
string
VARCHAR(255)
Pricing Options Code
The code of the pricing option selected by the shopper during the purchase process.
string
VARCHAR(255)
SKU
Stock Keeping Unit
string
VARCHAR(255)
Product Additional Fields
Information collected from customers during the ordering process via one or multiple per-product custom additional fields. The Product Additional Fields column will report data collected from shoppers according to the following format:
- for CSV and XLS: "Field Name: Value." When multiple additional fields are used for a single product, data reported will be separated using "|", as such: Field Name1: Value1| Field Name2: Value2. Product Additional Fields features all values set by the customer in the ordering process for the additional fields defined for the product listed in the respective export row.
- for XML: <Product_Additional_Fields> <Product_Additional_Field_Item> <Field_Label>ExportData</Field_Label> <Field_Value>ExportData</Field_Value> </Product_Additional_Field_Item> </Product_Additional_Fields>
For "CHECKBOX" additional fields, if the field was checked during the ordering process "CHECKED" value is showed in the export file. If the field was not checked, no information is displayed in the export.
string
VARCHAR(255)
Delivered Filename
The name of the product file delivered to customers as a part of the fulfillment process.
string
VARCHAR(255)
Pricing Options Operator
Array with all the price operators corresponding to each price option. Possible values:
ADD
SUBTRACT
string
VARCHAR(9)
Pricing Options Value
Array with all the prices corresponding to each option (prices are in the order currency). In the case of usage scale pricing options groups, it will return the price of the metered resources consumed by the customer in the order currency.
int
VARCHAR(12)
Downloads Count
Integer indicating the number of times a product was downloaded.
int
INT
Price
Currency
The currency used to place the order.
string
VARCHAR(15)
Unit price (without VAT)
Price per unit. Taxes are not included.
double
DOUBLE
Quantity
Number of units.
int
INT
Unit Discount
The value of the discount per unit.
double
DOUBLE
Promotion
The name of the promotion used during the ordering process.
string
VARCHAR(255)
Promotion Coupon Code
The coupon code.
string
VARCHAR(20)
Total Price
The total costs incurred by the customer per product.
double
DOUBLE
Total VAT
The total value of VAT.
double
DOUBLE
General Discount
The total discount per order.
double
DOUBLE
General Total
Total value of the order.
double
DOUBLE
Shipping
Per-order shipping cost.
double
DOUBLE
Shipping VAT
The VAT for shipping costs.
double
DOUBLE
Customer and End User information
Company
The name of the company on whose behalf the order was placed from the billing details.
string
VARCHAR(80)
Client
The name of the customer placing the order from the billing details.
string
VARCHAR(80)
Address
The address of the customer placing the order from the billing details.
string
VARCHAR(100)
Phone
The phone number of the customer placing the order from the billing details.
string
VARCHAR(20)
The email of the customer placing the order from the billing details.
string
VARCHAR(100)
City
The city of the customer placing the order from the billing details.
string
VARCHAR(50)
Zip Code
The zip code of the customer placing the order from the billing details.
string
VARCHAR(20)
Country
The country of the customer placing the order from the billing details.
string
VARCHAR(50)
State
The state of the customer placing the order from the billing details.
string
VARCHAR(30)
Fiscal Code
VAT ID for companies from the billing details.
string
VARCHAR(20)
Registration Number
Company registration number.
string
VARCHAR(20)
End-user company
The name of the company on whose behalf the order was placed from the delivery details.
string
VARCHAR(80)
End user name
The name of the end-user from the billing details.
string
VARCHAR(50)
End-user address
The address of the end-user from the billing details.
string
VARCHAR(100)
End-user phone number
The phone number of the end-user from the billing details.
string
VARCHAR(20)
End-user email address
The email of the end-user from the billing details.
string
VARCHAR(100)
End-user city
The city of the end-user from the billing details.
string
VARCHAR(50)
End-user ZIP Code
The zip code of the end-user from the billing details.
string
VARCHAR(20)
End-user country
The country of the end-user from the billing details.
string
VARCHAR(50)
End-user state
The state of the end-user from the billing details.
string
VARCHAR(20)
Client First Name
First name of the billing person.
string
VARCHAR(40)
Client Last Name
Last name of the billing person.
string
VARCHAR(40)
End-User First Name
First name of the product user.
string
VARCHAR(40)
End-User Last Name
Last name of the product user.
string
VARCHAR(40)
Affiliate information
Affiliate
Affiliate company name for affiliate orders. Can be empty for non-affiliate orders.
string
VARCHAR(80)
Affiliate website
Affiliate website. Can be empty for non-affiliate orders.
string
VARCHAR(100)
Affiliate ID
2Checkout affiliate ID. Can be empty for non-affiliate orders.
int
INT
Affiliate source (AFFSRC)
Affiliate order source.
string
VARCHAR(1000)
Subscription information
Avangate subscription reference
The unique identifier of subscriptions in the 2Checkout system. For bundled products, multiple subscription identifiers are separated using "|", as such: Subscription1| Subscription2.
string
VARCHAR(38)
RenewalStatus
Possible values:Manual|Auto
string
VARCHAR(20)
Subscription
Possible value: New, Renewal, Upgrade, Trial and Regular from Trial. For bundled products, multiple values are separated using "|", as such: Trial|New|Renewal.
VARCHAR(50)
DIS Cost
DIS costs incurred by the shopper.
double
DOUBLE
DIS Profit
The DIS profit after your cost is deducted from the sum paid by the shopper.
double
DOUBLE
Billing Cycle
Shows the number of times subscriptions featuring contract periods were renewed using an Int value. Otherwise, it will display the following string: N/A.
int and the 'N/A' string
VARCHAR(10)
Billing Cycles Left
The number of billing cycles remaining until the contract restarts. 2Checkout counts down from the moment a subscription goes live. For example, the BILLING_CYCLES_LEFT value for a monthly subscription with a 12-month contract will be 11 in the first month, 10 the second month, 9 the third, then 8, 7, 6, 5, 4, 3, 2, 1 and 0, before the contract restarts.
int
VARCHAR(255)
Current Billing Cycle
This parameter indicates the total number of billing cycles passed for a subscription out of the duration of the current contract. For example, the CURRENT_BILLING_CYCLE value for a monthly subscription with a 12-month contract will be 1 for the first month, 2 for the second month, and so forth until the twelfth billing cycle when the value will reach 12. Following the restart of the contract, the CURRENT_BILLING_CYCLE value will also be restarted, starting with 1 for the first month of the new contract, 2 for the second, etc.
int
VARCHAR(255)
Custom Price Billing Cycles Left
0 if you did not set a custom price for an ongoing subscription. Otherwise, this value shows the number of billing cycles that will be impacted by the custom price set for an ongoing subscription.
int
VARCHAR(255)
Financial details
Processing fee
2Checkout commission (including DIS fees).
double
DOUBLE
Affiliate Commission
The commission paid to the affiliate.
double
DOUBLE
Net Profit
Your earnings minus the commissions paid to 2Checkout, affiliates, VAT or sales tax, shipping tax, DIS costs
double
DOUBLE
Payment Currency
The currency 2Checkout uses to pay you for orders from your customers.
string
VARCHAR(15)
Exchange Rate
The currency exchange rate used to convert the money paid by shoppers into the settlement currency 2Checkout used to pay you.
double
DOUBLE
Final Exchange Rate
Possible values: YES, NO. The exchange rate is final when included into a 2Checkout Sales Report, or estimative otherwise.
string
VARCHAR(5)
NetIncomePerProduct
Your earnings minus the commissions paid to 2Checkout, affiliates, VAT or sales tax, shipping tax, DIS costs for each product in an order.
double
DOUBLE
Invoice Number Prefix
The prefix used for the invoice number.
string
VARCHAR(5)
Invoice Number
The invoice number.
int
Int(11)
Communication language
Language used during the ordering process.
string
VARCHAR(5)
FX markup
FX markup used for converting the order into your payout currency.
int
Int(11)
Template ID
ID assigned to the cart template used during the purchase.
int
Int(11)
Exported file options
Timezone
The time zone set for your account (Control Panel only, not API) via the Account settings area.
string
VARCHAR(50)
URL
Unique website URL attached to each 2Checkout merchant account. In scenarios in which you export orders for aggregated accounts, the URL will feature the link to the website associated with the account from which the export is generated.
string
VARCHAR(255)
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.
If you use custom labels for XML elements, 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/>.
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.
Last updated
Was this helpful?