Esportare gli ordini

Definizione dei campi

I campi obbligatori sono contrassegnati da una matita. Le definizioni dei campi si basano sulla sintassi MySQL.

L'esportazione contiene l'elemento <orders>. Questo elemento può contenere da 1 a n elementi <order>. L'API può essere estesa nella richiesta HTTP tramite /xxxper richiamare un file XSLT. Si otterrà quindi un file XML trasformato in base all'XSLT selezionato.

orders_id
int(11)
Numero d’ordine
shop_id
int(3)
Numero del negozio. Rilevante solo in caso di negozi multipli (impostazione predefinita: 1)
marketplace_id
int(11)
ID del marketplace
marketplace_data
text
Dati specifici del marketplace (codificati in JSON)
invoice_id_individuale
int(11)
Numero della fattura, se è stata attivata la serie di numeri di fattura personalizzata, altrimenti 0
invoice_date
date
Data della fattura, se è stata attivata la serie di numeri di fattura personalizzata
invoice_payment_term_date
date
Termine di pagamento
service_date
datetime
Data del servizio
data_prevista_del_servizio
datetime
Data di prestazione (prevista)
shipping_date
datetime
Data di consegna (prevista)
data_di_spedizione_stimata
datetime
Data di consegna (prevista)
delivery_option
varchar(30)
Opzioni di consegna speciali, ad es. data di consegna desiderata
data_di_consegna_desiderata
varchar(30)
Data di consegna desiderata
customers_id
int(11)
Numero cliente
customers_id_extern
VARCHAR(64)
Numero cliente (esterno)
manager_id
int(11)
Numero cliente del responsabile (solo se un responsabile effettua l'ordine per conto del cliente)
manager_id_extern
VARCHAR(64)
Numero cliente (esterno) del manager (solo se un manager effettua l'ordine per conto del cliente)
customers_group_id
int(11)
ID del gruppo clienti
customers_firstname
varchar(64)
Cliente: nome
customers_lastname
varchar(64)
Cliente: cognome
customers_gender
varchar(1)
Cliente: sesso (''|m|f|c) - vuoto, maschio, femmina, azienda
customers_dob
date
Cliente: data di nascita
customers_company
varchar(64)
Cliente: Ragione sociale
customers_street_address
varchar(64)
Cliente: via e numero civico
customers_suburb
varchar(64)
Cliente: Informazioni aggiuntive sull'indirizzo
customers_city
varchar(32)
Cliente: Città
codice_postale_cliente
varchar(10)
Cliente: codice postale
customers_state
varchar(32)
Cliente: Stato
customers_country
varchar(32)
Cliente: Paese (testo)
customers_country_id
int(11)
Cliente: Paese (ID)
customers_telephone
varchar(32)
Cliente: numero di telefono
customers_email_address
varchar(96)
Cliente: Indirizzo e-mail
customers_address_format_id
int(5)
Cliente: ID formato indirizzo (predefinito: 5)
delivery_firstname
varchar(64)
Consegna: nome
delivery_lastname
varchar(64)
Consegna: cognome
delivery_gender
varchar(1)
Consegna: sesso (''|m|f|c)
delivery_company
varchar(64)
Consegna: nome dell'azienda
delivery_street_address
varchar(64)
Consegna: via e numero civico
delivery_suburb
varchar(64)
Consegna: informazioni aggiuntive sull'indirizzo
delivery_city
varchar(32)
Consegna: Città
codice_postale_consegna
varchar(10)
Consegna: codice postale
delivery_state
varchar(32)
Consegna: Stato
delivery_country
varchar(32)
Consegna: Paese (testo)
delivery_country_id
int(11)
Consegna: Paese (ID)
delivery_address_format_id
int(5)
Consegna: ID formato indirizzo (predefinito: 5)
billing_firstname
varchar(64)
Fatturazione: nome
billing_lastname
varchar(64)
Fattura: Cognome
billing_gender
varchar(1)
Fattura: Sesso (''|m|f|c)
billing_company
varchar(64)
Fattura: Ragione sociale
billing_company_tax_id
varchar(32)
Fattura: Partita IVA
billing_street_address
varchar(64)
Fattura: via e numero civico
billing_suburb
varchar(64)
Fattura: informazioni aggiuntive sull'indirizzo
billing_city
varchar(32)
Fattura: Città
billing_postcode
varchar(10)
Fattura: codice postale
billing_state
varchar(32)
Fattura: Stato
billing_country
varchar(32)
Fattura: Paese (testo)
billing_country_id
int(11)
Fattura: Paese (ID)
billing_address_format_id
int(5)
Fattura: ID formato indirizzo (predefinito: 5)
payment_method
varchar(64)
Pagamento (testo)
cc_type
varchar(64)
-
cc_owner
varchar(64)
-
cc_number
varchar(32)
-
cc_cvv2
varchar(4)
-
cc_expires
varchar(4)
-
last_modified
datetime
Ultima modifica
date_purchased
datetime
Data dell'ordine
orders_status
int(5)
Stato attuale dell'ordine (ID)
orders_date_finished
datetime
-
valuta
char(3)
Codice valuta (ISO3)
valore_valuta
decimale(13,8)
Valore della valuta (predefinito 1,0, diverso se non è la valuta predefinita del negozio)
account_name
varchar(32)
-
account_number
varchar(20)
-
numero_po
varchar(50)
Numero dell'ordine di acquisto (numero d'ordine interno)
acquistato_senza_account
tinyint(1)
Acquisto senza account cliente (1 = sì, 2 = no)
customers_ip
varchar(15)
Cliente: indirizzo IP (mascherato)
billing_cf
varchar(25)
-
billing_piva
varchar(25)
-
peso_totale_ordine
decimale(8,4)
Peso totale (kg)
payment_class
varchar(32)
Pagamento: classe
payment_module
varchar(32)
Pagamento: sottomodulo (solo per determinate classi)
payment_instructions
text
Istruzioni di pagamento (ad es. per l'acquisto con fattura PayPal)
shipping_class
varchar(32)
Spedizione: Classe
language_id
int(11)
Lingua del cliente (ID)
strict_id
int(11)
Pagamento: numero dell'operazione (solo per determinate classi)
pay_id
varchar(64)
ID pagamento 2
documento
varchar(32)
-
testo_individuale0
longtext
Testo personalizzato di conferma dell'ordine
indiv_text1
longtext
Testo personalizzato della fattura
indiv_text2
testo_lungo
Testo personalizzato della bolla di consegna
indiv_text3
testo_esteso
Testo personalizzato della lista di imballaggio
indiv_text4
testo_lungo
Testo personalizzato dell'offerta
rating_mail
tinyint(1)
Autorizzazione all'invio dell'e-mail di valutazione (sistema esterno)
rating_mail_shop
tinyint(1)
Autorizzazione all'invio dell'e-mail di valutazione consentita (sistema interno)
tax_flag
varchar(1)
Indicazione fiscale (0 = lordo (IVA inclusa), 1 = netto (IVA esclusa), 2 = netto (esente da IVA))
external_id
varchar(64)
Numero esterno / ID pagamento 1
ebay_username
varchar(150)
Nome utente eBay (API eBayLegacy)
ebay_extendedorderid
varchar(20)
ID ordine esteso eBay (API eBayLegacy)
hold
tinyint(1)
.
customers_additional_address
mediumtext
Cliente: - (non più in uso) 
indirizzo_di_consegna_aggiuntivo
mediumtext
Consegna: - (non più in uso) 
billing_additional_address
mediumtext
Pagamento: - (non più in uso) 
fsk_check
varchar(100)
-
passportfile
varchar(200)
-
nota_di_credito_retroattiva
int(1)
-
dati_stazione_postale_consegna
testo medio
-
verifica_privacy_spedizione
tinyint(4)
Consenso alla trasmissione dell'indirizzo e-mail/numero di telefono al corriere (1 = Sì, 0 = No)
indiv_rg
varchar(64)
File di fattura personalizzato (sostituisce la visualizzazione standard della fattura)
indiv_ls
varchar(64)
Bolla di consegna personalizzata (sostituisce la visualizzazione standard della bolla di consegna)
device
enum('mobile','desktop')
Ordine effettuato da dispositivo mobile o desktop
handling_fee
decimale(16,8)
Commissione forfettaria di gestione
commissione_transazione
decimal(16,8)
Commissioni di transazione
commissione_di_vendita
decimale(16,8)
Commissioni di vendita
other_fee
decimale(16,8)
Altre commissioni
orders_change_cache
text
- (utilizzato internamente per la sovrascrittura di moduli speciali)
vca_ready
tinyint(4)
- (solo per l'integrazione VCA)
vca_exported
tinyint(4)
- (solo per connessione VCA)
vca_blocked
tinyint(4)
- (solo per connessione VCA)
vca_last_email
datetime
- (solo per l'integrazione con VCA)
suppliers_id
int(11)
Numero fornitore (un valore maggiore di 0 indica che si tratta di un ordine fornitore)
suppliers_orders_id
varchar(40)
Numero dell'ordine del fornitore
suppliers_order_details
text
-
dettagli_ordine_fornitori2
testo
-
tipo_ordine_fornitori
varchar(4)
-
dettagli_ordine_fornitori_ultimo_aggiornamento
datetime
-
dettagli_ordine_fornitori_ultimo_aggiornamento2
datetime
-
dettagli_ordine_esterno
testo medio
-
dettagli_ordine_esterno_ultimo_aggiornamento
datetime
-
dettagli_errore_ordine_esterno
testo medio
-
dettagli_errore_ordine_esterno_ultimo_aggiornamento
datetime
-
controllo_prodotto_ordine_esterno
tinyint(1)
-
controllo_documento_esterno
tinyint(1)
-
payment_part_1
DECIMAL(16,8)
Importo della rata 1
payment_part_2
DECIMAL(16,8)
Importo della rata 2
payment_part_3
DECIMAL(16,8)
Importo della rata 3
payment_part_4
DECIMAL(16,8)
Importo della rata 4
payment_part_5
DECIMAL(16,8)
Importo della rata 5
data_pagamento_1
DATETIME
Data della rata 1
payment_date_2
DATETIME
Data del pagamento rateale 2
payment_date_3
DATETIME
Data della rata 3
data_pagamento_4
DATETIME
Data della rata 4
data_pagamento_5
DATETIME
Data della rata 5
payment_purpose_1
VARCHAR(255)
Causale del pagamento rateale 1
payment_purpose_2
VARCHAR(255)
Causale del pagamento rateale 2
payment_purpose_3
VARCHAR(255)
Causale del pagamento rateale 3
payment_purpose_4
VARCHAR(255)
Causale del pagamento rateale 4
payment_purpose_5
VARCHAR(255)
Causale del pagamento rateale 5
payment_hash_1
VARCHAR(255)
Hash del pagamento rateale 1
payment_hash_2
VARCHAR(255)
Hash del pagamento rateale 2
hash_pagamento_3
VARCHAR(255)
Hash del pagamento rateale 3
hash_pagamento_4
VARCHAR(255)
Hash del pagamento rateale 4
hash_pagamento_5
VARCHAR(255)
Hash del pagamento rateale 5
ID stato ordine
int(11)
Stato attuale dell'ordine (ID)
orders_status_name
varchar(50)
Stato attuale dell'ordine (nome)
orders_status_label
enum('primary'
Stato attuale dell'ordine (classe di colore)
orders_status_label_bg
varchar(7)
Stato attuale dell'ordine (codice esadecimale del colore di sfondo #XXXXXX)
orders_status_label_color
varchar(7)
Stato attuale dell'ordine (codice esadecimale del colore del testo #XXXXXX)
orders_status_sort_order
int(3)
Stato attuale dell'ordine (ordine di ordinamento)
customers_language_code
varchar(255)
Cliente: codice lingua (ISO2, minuscolo)
customers_country_code
varchar(255)
Cliente: Paese (ISO2)
delivery_country_code
varchar(255)
Consegna: Paese (ISO2)
billing_country_code
varchar(255)
Fatturazione: Paese (ISO2)
ordini_commento
varchar(255)
Commento sull'ordine
prodotti
prodotto
Ogni nodo products contiene [1..n] nodi product.
product
orders_products_id
int(11)
Chiave primaria della voce d'ordine
orders_id
int(11)
Numero d'ordine
products_id
int(11)
Prodotto: ID
marketplace_id
INT(11)
Marketplace: ID del marketplace
bundle_id
INT(11)
Prodotto: ID del pacchetto
marketplace_external_id
VARCHAR(128)
Marketplace: ID esterno della voce d'ordine
marketplace_data
TEXT
Piattaforma: dati aggiuntivi esterni della voce d'ordine (codificati in JSON)
products_model
varchar(255)
Prodotto: codice articolo
products_name
varchar(255)
Prodotto: Nome
prezzo_prodotti_ek
decimale(16,8)
Prodotto: Prezzo di acquisto (netto) per unità di imballaggio
products_price
decimale(16,8)
Prodotto: prezzo di vendita (netto) per unità di imballaggio
final_price
decimal(16,8)
Prodotto: prezzo di vendita finale (al netto, ad es. in caso di attributi a pagamento) per unità di imballaggio
products_tax
decimale(8,4)
Prodotto: aliquota fiscale
quantità_prodotti
decimale(16,8)
Prodotto: quantità
prodotti_magazzini
mediumtext
Prodotto: distribuzione del numero totale tra i magazzini (codificato in JSON, solo se la funzionalità multi-magazzino è attiva)
products_unit
varchar(128)
Prodotto: unità
service_date
datetime
Prodotto: Data del servizio
data_di_servizio_stimata
datetime
Prodotto: Data di prestazione (prevista)
shipping_date
datetime
Prodotto: data di consegna
data_di_spedizione_stimata
datetime
Prodotto: Data di consegna (prevista)
shipping_profile_id
INT(11)
Prodotto: profilo di spedizione (ID)
shipping_profile
TEXT
Prodotto: Profilo semaforo (Testo)
date_available
date
Prodotto: Data di disponibilità
ebay_transaction_id
varchar(255)
Prodotto: numero di transazione eBay (API legacy di eBay)
ebay_item_id
varchar(255)
Prodotto: ID articolo eBay (API legacy di eBay)
ean
varchar(20)
Prodotto: GTIN
products_review_hash
varchar(256)
- (interno: hash della valutazione per il sistema di valutazione interno)
contratto_ok_flag
TINYINT(1)
- (interno: flag di verifica del contratto)
products_weight
varchar(255)
Prodotto: Peso
storage_comment
varchar(255)
Prodotto: nota sulla bolla di consegna (solo per la bolla di consegna)
totali
total
Ogni nodo "totals" contiene [1..n] nodi "total".
total
orders_total_id
INT(10)
Chiave primaria della riga OrderTotal
orders_id
INT(11)
Numero d'ordine
title
VARCHAR(255)
OrderTotal: titolo (ad es. spese di spedizione, totale)
text
VARCHAR(255)
OrderTotal: valore come testo
value
DECIMAL(16,8)
OrderTotal: valore (numero in virgola mobile)
sovrascrivi
DECIMAL(16,8)
OrderTotal: valore di sovrascrittura (se modificato tramite l'editor degli ordini)
tax
decimale(11,8)
OrderTotal: imposta (valore)
class
VARCHAR(32)
OrderTotal: Classe (identifica in modo univoco il tipo, ad es. ot_shipping: spese di spedizione, ot_total: totale)
sort_order
INT(11)
OrderTotal: Ordine di ordinamento (per l'output)
html
TEXT
OrderTotal: HTML (dato facoltativo, ad es. ripartizione dettagliata delle spese di spedizione)

Modello openTRANS

Con il modello opentrans (/Export/XML/order/{id}/opentrans) riceverete l'ordine nel formato openTRANS 2.1. Ogni articolo costituisce una voce (ORDER_ITEM), così come le righe di riepilogo relative a spese di spedizione, spedizione speciale, commissione per pagamento in contrassegno, supplemento per quantità minima, sconto, sconto fedeltà, coupon, buono, commissione di pagamento e sconto cassa; per queste, la classe è indicata in BUYER_PID. TOTAL_ITEM_NUM è la somma delle quantità degli articoli più il numero di queste righe di riepilogo, TOTAL_AMOUNT è il valore di ot_total.

Modificato nella v2.122.13 (Shop 4.9.174): lo sconto fedeltà (ot_loyalty_discount) appare come detrazione: una voce con importo negativo che viene conteggiata in TOTAL_ITEM_NUM. Fino alla v2.122.12 il modello richiedeva ot_loyality_discount (errore di battitura). Lo sconto mancava e il totale delle voci superava TOTAL_AMOUNT. Esempio: articolo 119,00 €, sconto fedeltà 5,95 €, TOTAL_AMOUNT 113,05 €: fino alla versione v2.122.12 il totale delle voci era pari a 119,00 €. I modelli personalizzati del negozio che hanno ripreso l’elenco delle classi da orders-opentrans.xsl mantengono l’errore di battitura; modificate ot_loyality_discount in ot_loyalty_discount (nel conteggio e nella selezione delle voci).

Esempio di file XML

Il file XML di esempio contiene 1 ordine cliente con un prodotto e diverse voci di totale.

Scarica l’esempio:

Download

Last updated: 27 ottobre 2026