Orders import feature is the part of the free Orders Import addon. It is not included in the X-Cart core

Below is a list of supported fields and their respective value types for category import.

Field in CSV file What this field describes Value type
Fields supported by Orders Import addon
orderNumber* Order number. Serves as identifier.

Integer

Customer billing address fields. The following address fields might or might not be present in your X-Cart installation depending on your address fields configuration.
customerAnonymous If Yes, customer is anonymous person. Yes/No
customerAddressSame Specify Yes if the customer billing and shipping addresses are the same, No otherwise Yes/No
customerFirstnameBillingAddressField Customer first name in the billing address.
This and
String
customerLastnameBillingAddressField Customer last name in the billing address String
customerStreetBillingAddressField Customer street in the billing address String
customerCityBillingAddressField Customer city in the billing address String
customerCountryCodeBillingAddressField Customer country code (ISO 3166-1 alpha-2 format (2 characters)) in the billing address String,
Max. length: 2
customerStateIdBillingAddressField Customer state name if the X-Cart has the defined state for the customer. Otherwise, use customerCustomStateBillingAddressField.
Example: Oklahoma
String
customerCustomStateBillingAddressField Customer state name in case the X-Cart doesn't have defined state for the country String
customerZipcodeBillingAddressField Customer zipcode in the billing address. String
customerPhoneBillingAddressField Customer phone number in the billing address. String
customerVatNumberBillingAddressField Customer VAT number in the billing address. Requires the VAT module to be installed. String
Customer shipping address fields. The following address fields might or might not be present in your X-Cart installation depending on your address fields configuration.
customerFirstnameShippingAddressField Customer first name in the billing address.
This and the following address fields might or might not be present in your X-Cart installation depending on your address fields configuration.
String
customerLastnameShippingAddressField Customer last name in the billing address String
customerStreetShippingAddressField Customer street in the billing address String
customerCityShippingAddressField Customer city in the billing address String
customerCountryCodeShippingAddressField Customer country code (ISO 3166-1 alpha-2 format (2 characters)) in the billing address String,
Max. length: 2
customerStateIdShippingAddressField Customer state name if the X-Cart has the defined state for the customer. Otherwise, use customerCustomStateShippingAddressField.
Example: Oklahoma
String
customerCustomStateShippingAddressField Customer state name in case the X-Cart doesn't have defined state for the country String
customerZipcodeShippingAddressField Customer zipcode in the billing address. String
customerPhoneShippingAddressField Customer phone number in the billing address. String
customerVatNumberShippingAddressField Customer VAT number in the billing address. Requires the VAT module to be installed. String
Order item fields. Each field is a Multirow field and each row represents one specific product.
itemName* Order item name. String,
Multirow
itemSKU* Order item SKU. String,
Multirow,
Max. length: 32
itemAttributes Order item product attributes. Multiple,
Multirow
itemPrice* Order item selling price. Float,
Multirow
itemQuantity* Order item name. Integer,
Multirow
itemSubtotal* Order item subtotal value (without order item surcharges). Float,
Multirow
itemTotal* Order item total value. Float,
Multirow
subtotal* Order subtotal (without order surcharges). Float
Order surcharges. Each surcharge field consists of UPPERCASED surcharge code and (surcharge) suffix. The following two fields are the examples of the general order surchages and may or may not be present in your X-Cart installation
DISCOUNT (surcharge) Order discount surcharge in absoulte value. Example: -3. This example value stands for $3.00 USD discount, if the order currency in USD. Float
SHIPPING (surcharge) Order shipping surcharge. Example: 3.02. Float
total* Order total with surcharges included. Float
currency* Code of the order currency. Example: USD. String,
Max. length: 3
shippingMethod Order shipping method name. String
trackingNumber Order tracking number. String
Order payment transactions. The following fields, prefixed by 'paymentTransaction', are Multirow and each row represents a single payment transaction. Order should have at least one payment transaction.
paymentTransactionMethod* Order payment transaction method internal name. String
paymentTransactionStatus* Order payment transaction status.
Possible values are:
  • 'I' (Initialized)
  • 'P' (In Progress)
  • 'S' (Success)
  • 'W' (Pending)
  • 'F' (Failed)
  • 'C' (Canceled)
  • 'V' (Void)
String,
Max. length: 1
paymentTransactionValue* Order payment transaction value. Float
paymentTransactionNote Order payment transaction processor note. Generally contains errors from the payment processing. String
paymentTransactionType* Order payment transaction type.
Possible values are:
  • 'auth' (Only authorize)
  • 'sale' (Authorize and capture)
  • 'capture' (Capture payment)
  • 'capturePart' (Capture payment part. Transaction is closed afterwards)
  • 'captureMulti' (Capture payment part. Can be repeated)
  • 'void' (Cancel payment)
  • 'voidPart' (Cancel payment part. Transaction is closed afterwards)
  • 'voidMulti' (Cancel payment part. Can be repeated)
  • 'refund' (Refund payment)
  • 'refundPart' (Refund payment part. Transaction is closed afterwards)
  • 'refundMulti' (Refund payment. Can be repeated)
String
paymentTransactionId* Order payment transaction public id. String
paymentTransactionCurrency Order payment transaction currency. Can be omitted, order currency will be used instead. String
date Order creation date. Example: Tue, 12 Jan 2016 13:18:22 +0000 String
recent Specify Yes if the order has been processed by the admin, No otherwise. Yes/No
paymentStatus* Order payment status.
Possible values are:
  • 'A' (Authorized)
  • 'P' (Paid)
  • 'PP' (Partially paid)
  • 'D' (Declined)
  • 'C' (Cancelled)
  • 'Q' (Queued)
  • 'R' (Refunded)
String,
Max. length: 3
shippingStatus* Order shipping status.
Possible values are:
  • 'N' (New order)
  • 'P' (Processing)
  • 'S' (Shipped)
  • 'D' (Delivered)
  • 'WND' (Will not deliver)
  • 'WFA' (Waiting for approve)
  • 'R' (Returned)
String,
Max. length: 3
notes Order customer notes. String
adminNotes Order administrator notes. String
Order history details. The following fields, prefixed by 'detail', are Multirow and each row represents a single history item.
detailCode Order history item code String
detailLabel Order history item human-readable label String
detailValue Order history item text. String
Fields added by Multivendor addon
vendor* Order vendor email. String
parent* Parent order ID. Integer
children* Child order numbers. Can be multiple. Integer,
Multiple
Fields added by Custom Order Statuses addon
paymentStatusLabel Human-readable translation of the payment status String,
Multilingual
shippingStatusLabel Human-readable translation of the shipping status String,
Multilingual

* Required field.

** See CSV field attributes for more info.

Tips:

  • If you are going to import data into X-Cart and do not wish to update certain X-Cart fields during the import process, you should not include these fields into your CSV file for import. Simply remove the respective column(s) from the file.