Export Orders

Field Definition

Required fields are marked with a pencil icon. The field definitions are based on MySQL syntax.

The export contains the element. This element can contain 1 to n elements. The API can be extended in the HTTP request using /xxxto call an XSLT file. You will then receive an XML file that has been transformed according to the selected XSLT.

orders_id
int(11)
Order number
shop_id
int(3)
Shop ID. Only relevant for multi-shops (default: 1)
marketplace_id
int(11)
Marketplace ID
marketplace_data
text
Marketplace-specific data (JSON-encoded)
invoice_id_individual
int(11)
Invoice number, if individual invoice number range has been enabled; otherwise 0
invoice_date
date
Invoice date, if the custom invoice number range has been enabled
invoice_payment_term_date
date
Payment due date
service_date
datetime
Service date
estimated_service_date
datetime
Service Date (Scheduled)
shipping_date
datetime
Shipment date (planned)
estimated_shipping_date
datetime
Delivery Date (Scheduled)
delivery_option
varchar(30)
Special delivery options, e.g., desired delivery date
desired_delivery_date
varchar(30)
Desired delivery date
customers_id
int(11)
Customer ID
customers_id_extern
VARCHAR(64)
Customer ID (external)
manager_id
int(11)
Manager's customer ID (only if a manager is assigned to the customer)
manager_id_external
VARCHAR(64)
Manager's customer number (external) (only if a manager is assigned to the customer)
customers_group_id
int(11)
Customer group ID
customers_firstname
varchar(64)
Customer: First Name
customers_lastname
varchar(64)
Customer: Last Name
customers_gender
varchar(1)
Customer: Gender (''|m|f|c) - empty, male, female, company
customers_dob
date
Customer: Date of Birth
customers_company
varchar(64)
Customer: Company Name
customers_street_address
varchar(64)
Customer: Street & House Number
customers_suburb
varchar(64)
Customer: Additional Address Information
customers_city
varchar(32)
Customer: City
customers_postcode
varchar(10)
Customer: ZIP Code
customers_state
varchar(32)
Customer: State
customers_country
varchar(32)
Customer: Country (text)
customers_country_id
int(11)
Customer: Country (ID)
customers_telephone
varchar(32)
Customer: Phone
customers_email_address
varchar(96)
Customer: Email Address
customers_address_format_id
int(5)
Customer: Address format ID (default: 5)
delivery_firstname
varchar(64)
Delivery: First Name
delivery_lastname
varchar(64)
Delivery: Last Name
delivery_gender
varchar(1)
Delivery: Gender (''|m|f|c)
delivery_company
varchar(64)
Delivery: Company Name
delivery_street_address
varchar(64)
Delivery: Street & House Number
delivery_suburb
varchar(64)
Delivery: Additional Address Information
delivery_city
varchar(32)
Delivery: City
delivery_postcode
varchar(10)
Delivery: ZIP Code
delivery_state
varchar(32)
Delivery: State
delivery_country
varchar(32)
Delivery: Country (text)
delivery_country_id
int(11)
Delivery: Country (ID)
delivery_address_format_id
int(5)
Delivery: Address Format ID (Default: 5)
billing_firstname
varchar(64)
Billing: First Name
billing_lastname
varchar(64)
Billing: Last Name
billing_gender
varchar(1)
Invoice: Gender (''|m|f|c)
billing_company
varchar(64)
Invoice: Company Name
billing_company_tax_id
varchar(32)
Invoice: Tax ID
billing_street_address
varchar(64)
Invoice: Street & House Number
billing_suburb
varchar(64)
Invoice: Additional Address Information
billing_city
varchar(32)
Invoice: City
billing_postcode
varchar(10)
Invoice: ZIP Code
billing_state
varchar(32)
Invoice: State
billing_country
varchar(32)
Invoice: Country (text)
billing_country_id
int(11)
Invoice: Country (ID)
billing_address_format_id
int(5)
Billing: Address Format ID (Default: 5)
payment_method
varchar(64)
Payment (text)
cc_type
varchar(64)
-
cc_owner
varchar(64)
-
cc_number
varchar(32)
-
cc_cvv2
varchar(4)
-
cc_expires
varchar(4)
-
last_modified
datetime
Last Modified
date_purchased
datetime
Order Date
orders_status
int(5)
Current order status (ID)
orders_date_finished
datetime
-
currency
char(3)
Currency code (ISO3)
currency_value
decimal(13,8)
Currency value (default 1.0, may vary if not the store's default currency)
account_name
varchar(32)
-
account_number
varchar(20)
-
po_number
varchar(50)
Purchase Order Number (customer's order number)
purchased_without_account
tinyint(1)
Purchase without a customer account (1 = Yes, 2 = No)
customers_ip
varchar(15)
Customer: IP address (masked)
billing_cf
varchar(25)
-
billing_piva
varchar(25)
-
total_order_weight
decimal(8,4)
Total weight (kg)
payment_class
varchar(32)
Payment: Class
payment_module
varchar(32)
Payment: Submodule (only for certain classes)
payment_instructions
text
Payment instructions (e.g., for PayPal invoice purchases)
shipping_class
varchar(32)
Shipping: Class
language_id
int(11)
Customer Language (ID)
strict_id
int(11)
Payment: Transaction number (only for certain classes)
pay_id
varchar(64)
Payment ID 2
document
varchar(32)
-
indiv_text0
longtext
Custom order confirmation text
indiv_text1
longtext
Custom invoice text
indiv_text2
longtext
Custom delivery note text
indiv_text3
longtext
Custom packing slip text
indiv_text4
longtext
Custom quote text
rating_mail
tinyint(1)
Consent to rating email allowed (external system)
rating_mail_shop
tinyint(1)
Consent to rating email allowed (internal system)
tax_flag
varchar(1)
Tax designation (0 = Gross (incl. tax), 1 = Net (excl. tax), 2 = Net (VAT-exempt))
external_id
varchar(64)
External number / Payment ID 1
ebay_username
varchar(150)
eBay username (eBayLegacy API)
ebay_extendedorderid
varchar(20)
eBay Extended Order ID (eBayLegacy API)
hold
tinyint(1)
.
customers_additional_address
mediumtext
Customer: - (no longer in use) 
delivery_additional_address
mediumtext
Delivery: - (no longer in use) 
billing_additional_address
mediumtext
Payment: - (no longer in use) 
fsk_check
varchar(100)
-
passportfile
varchar(200)
-
back_credit_note
int(1)
-
delivery_poststation_data
mediumtext
-
privacy_check_shipping
tinyint(4)
Consent to share email/phone number with shipping service providers (1 = Yes, 0 = No)
indiv_rg
varchar(64)
Custom invoice file (overrides default invoice display)
indiv_ls
varchar(64)
Custom delivery note (overrides default delivery note display)
device
enum('mobile','desktop')
Order placed from a mobile or desktop device
handling_fee
decimal(16,8)
Flat handling fee
transaction_fee
decimal(16,8)
Transaction fees
selling_fee
decimal(16,8)
Sales fees
other_fee
decimal(16,8)
Other Fees
orders_change_cache
text
- (used internally for overriding special modules)
vca_ready
tinyint(4)
- (only for VCA integration)
vca_exported
tinyint(4)
- (only for VCA connection)
vca_blocked
tinyint(4)
- (only for VCA integration)
vca_last_email
datetime
- (only for VCA integration)
suppliers_id
int(11)
Supplier ID (a value greater than 0 indicates that this is a supplier order)
suppliers_orders_id
varchar(40)
Supplier order number
suppliers_order_details
text
-
suppliers_order_details2
text
-
suppliers_order_type
varchar(4)
-
suppliers_order_details_last_updated
datetime
-
suppliers_order_details_last_updated2
datetime
-
external_order_details
mediumtext
-
external_order_details_last_updated
datetime
-
external_order_error_details
mediumtext
-
external_order_error_details_last_updated
datetime
-
external_order_product_check
tinyint(1)
-
external_document_check
tinyint(1)
-
payment_part_1
DECIMAL(16,8)
Installment Amount 1
payment_part_2
DECIMAL(16,8)
Installment Amount 2
payment_part_3
DECIMAL(16,8)
Installment Amount 3
payment_part_4
DECIMAL(16,8)
Installment Amount 4
payment_part_5
DECIMAL(16,8)
Installment Amount 5
payment_date_1
DATETIME
Installment Date 1
payment_date_2
DATETIME
Installment Date 2
payment_date_3
DATETIME
Installment Date 3
payment_date_4
DATETIME
Installment Date 4
payment_date_5
DATETIME
Installment Date 5
payment_purpose_1
VARCHAR(255)
Installment payment purpose 1
payment_purpose_2
VARCHAR(255)
Installment payment purpose 2
payment_purpose_3
VARCHAR(255)
Installment payment purpose 3
payment_purpose_4
VARCHAR(255)
Installment payment purpose 4
payment_purpose_5
VARCHAR(255)
Installment payment purpose 5
payment_hash_1
VARCHAR(255)
Installment payment hash 1
payment_hash_2
VARCHAR(255)
Installment Hash 2
payment_hash_3
VARCHAR(255)
Installment Hash 3
payment_hash_4
VARCHAR(255)
Installment Hash 4
payment_hash_5
VARCHAR(255)
Installment payment hash 5
orders_status_id
int(11)
Current order status (ID)
orders_status_name
varchar(50)
Current order status (name)
orders_status_label
enum('primary'
Current order status (color class)
orders_status_label_bg
varchar(7)
Current order status (background color hex code #XXXXXX)
orders_status_label_color
varchar(7)
Current order status (text color hex code #XXXXXX)
orders_status_sort_order
int(3)
Current order status (sort order)
customers_language_code
varchar(255)
Customer: Language code (ISO-2, lowercase)
customers_country_code
varchar(255)
Customer: Country (ISO-2)
delivery_country_code
varchar(255)
Delivery: Country (ISO-2)
billing_country_code
varchar(255)
Billing: Country (ISO-2)
orders_comment
varchar(255)
Order Comment
products
product
Each products node contains [1..n] product nodes.
product
orders_products_id
int(11)
Primary key of the order line item
orders_id
int(11)
Order number
products_id
int(11)
Product ID
marketplace_id
INT(11)
Marketplace: Marketplace ID
bundle_id
INT(11)
Product: Bundle ID
marketplace_external_id
VARCHAR(128)
Marketplace: External ID of the order line item
marketplace_data
TEXT
Marketplace: External additional data for the order line item (JSON-encoded)
products_model
varchar(255)
Product: Item number
products_name
varchar(255)
Product: Name
products_ek_price
decimal(16,8)
Product: Purchase Price (Net) per Packaging Unit
products_price
decimal(16,8)
Product: Selling price (net) per package unit
final_price
decimal(16,8)
Product: Final retail price (net, e.g., for paid attributes) per package unit
products_tax
decimal(8,4)
Product: Tax rate
products_quantity
decimal(16,8)
Product: Quantity
products_storages
mediumtext
Product: Distribution of the total quantity across warehouses (JSON-encoded, only when multi-warehouse functionality is active)
products_unit
varchar(128)
Product: Unit
service_date
datetime
Product: Service Date
estimated_service_date
datetime
Product: Service Date (Scheduled)
shipping_date
datetime
Product: Delivery Date
estimated_shipping_date
datetime
Product: Delivery Date (Scheduled)
shipping_profile_id
INT(11)
Product: Traffic Light Profile (ID)
shipping_profile
TEXT
Product: Traffic Light Profile (Text)
date_available
date
Product: Availability Date
ebay_transaction_id
varchar(255)
Product: eBay Transaction ID (eBay Legacy API)
ebay_item_id
varchar(255)
Product: eBay item ID (eBay Legacy API)
ean
varchar(20)
Product: GTIN
products_review_hash
varchar(256)
- (internal: review hash for internal review system)
contract_ok_flag
TINYINT(1)
- (internal: contract validation flag)
products_weight
varchar(255)
Product: Weight
storage_comment
varchar(255)
Product: Packing List Note (for packing list only)
totals
total
Each " totals" node contains [1..n] " total" nodes.
total
orders_total_id
INT(10)
Primary key of the OrderTotal row
orders_id
INT(11)
Order number
title
VARCHAR(255)
OrderTotal: Title (e.g., Shipping Costs, Total)
text
VARCHAR(255)
OrderTotal: Value as text
value
DECIMAL(16,8)
OrderTotal: Value (floating-point number)
overwrite
DECIMAL(16,8)
OrderTotal: Overwrite value (if modified via the order editor)
tax
decimal(11,8)
OrderTotal: Tax (value)
class
VARCHAR(32)
OrderTotal: Class (uniquely identifies the type, e.g., ot_shipping: shipping costs, ot_total: total amount)
sort_order
INT(11)
OrderTotal: Sort order (for output)
html
TEXT
OrderTotal: HTML (optional, e.g., detailed shipping cost breakdown)

Sample XML

The sample XML file contains 1 customer order with one product and multiple total items.

Download example:

Download

Last updated: May 26, 2026