Formato del file di export
Il formato standard di export è XML, ma facoltativamente è possibile richiedere la trasformazione in CSV usando il parametro personalizzato API_ORDER_OUTPUT_FORMAT___CSV.
È possibile gestire i parametri personalizzati al menu:
Parametri di sistema -> Parametri personalizzati
Per creare il parametro, cliccare su Aggiungi e compilare i seguenti campi:
- Nome Parametro: API_ORDER_OUTPUT_FORMAT___CSV
- Valore Parametro: l'id del connettore di tipo "API [export documenti]". Se sono necessari più valori vanno separati da virgola.
L'export degli ordini con questa configurazione contiene tutte le informazioni riguardo gli ordini estratti dal connettore indicato, generato in modo standard.
È possibile selezionare le informazioni da esportare nel tracciato csv creando il seguente parametro personalizzato:
- Nome Parametro: API_ORDER_OUTPUT_FORMAT___CSV_OPTIONS
- Valore Parametro: JSON per indicare quali sezioni esportare nel tracciato csv
Valore Parametro JSON
È stato riportato un esempio di json per simulare un caso di utilizzo reale.
Nell'esempio, con l'esecuzione del connettore di tipo "API [export documenti]" con id 3, si ottiene l'export di tutti gli ordini estratti dal connettore e le righe dell`ordine vengono numerate con ordine progressivo.
Siccome è stato mappato anche l'attributo dell'ordine con nome "bShippingDeadlineShippingDate", anche nome e valore di questo attributo verranno esportati nel tracciato csv nelle rispettive colonne, nominate con il prefisso scelto. Scarica un esempio di csv generato dal connettore con id 3.
Nel json proposto come esempio, sono presenti anche le configurazioni riguardo l'export del tracciato per il connettore di tipo "API [export documenti]" con con id 8.
Per questo connettore, vengono riportate nel json specifiche coppie "Chiave":"Nome della colonna" da esportare nel tracciato, pertanto qualsiasi altro dato non verrà esportato. Scarica un esempio di csv generato dal connettore con id 8.
A seguire un elenco delle opzioni e delle chiavi disponibili per l'esportazione degli ordini in formato csv.
Struttura JSON
"config"
Nome | Valore |
|---|---|
row_item_progressive | se assume valore true, le righe ordine (ovvero i prodotti inclusi in un ordine) vengono numerate in modo progressivo |
columns | se presente, permette di indicare quali chiavi dell'ordine esportare e il relativo nome della colonna |
"columns" (contenuto in "config")
Nome | Valore |
|---|---|
General_bindCommerceNumber | ID bindCommerce dell`ordine, univoco |
General_Number | numero d`ordine
|
General_Node | nome del nodo relativo all`ordine
|
General_NodeID | ID del nodo relativo all`ordine, univoco
|
General_Technology | tecnologia di provenienza dell`ordine
|
General_Date | data di creazione dell`ordine
|
General_LastUpdate | data dell`ultima modifica dell`ordine
|
General_StatebindID | ID dello stato dell`ordine, univoco
|
General_StateCode | codice dello stato dell`ordine
|
General_StateName | nome dello stato dell`ordine
|
Customer_Code | ID cliente, univoco
|
Customer_Name | nome cliente
|
Customer_Surname | cognome cliente
|
Customer_Company | azienda cliente
|
Customer_Address | indirizzo cliente
|
Customer_Postcode | codice postale cliente
|
Customer_City | citta` cliente
|
Customer_Province | provincia cliente
|
Customer_CountryCode | codice paese, esempio IT, ES |
Customer_VatCode | codice imposta cliente |
Customer_FiscalCode | codice fiscale cliente |
Customer_Phone | numero telefonico cliente |
Customer_MobPhone | numero telefonico mobile cliente |
Customer_Email | email cliente |
Customer_EInvoiceDestCode | destinazione fattura cliente |
Customer_Pec | email pec cliente |
Delivery_Name | nome [informazioni di spedizione] |
Delivery_Surname | cognome [informazioni di spedizione] |
Delivery_Company | azienda [informazioni di spedizione] |
Delivery_Address | indirizzo [informazioni di spedizione] |
Delivery_Postcode | codice postale [informazioni di spedizione] |
Delivery_City | città [informazioni di spedizione] |
Delivery_Province | provincia [informazioni di spedizione] |
Delivery_CountryCode | codice paese, esempio IT, ES [informazioni di spedizione] |
Delivery_Phone | numero telefonico [informazioni di spedizione] |
Delivery_MobPhone | numero telefonico mobile [informazioni di spedizione] |
Delivery_Email | email [informazioni di spedizione] |
Row_bindID | ID bindCommerce della riga dell'ordine, univoco |
Row_Code | sku prodotto |
Row_Barcode | codice a barre prodotto |
Row_Description | nome prodotto |
Row_Qty | quantità prodotto |
Row_ProductDimensions_Weight | peso prodotto |
Row_ProductDimensions_WeightUom | unità di misura peso prodotto |
Row_ProductDimensions_WeightVolume | peso di volume prodotto |
Row_ProductDimensions_LwhUom | unità di misura dimensioni lineari prodotto |
Row_ProductDimensions_Length | lunghezza prodotto |
Row_ProductDimensions_Width | larghezza prodotto |
Row_ProductDimensions_Height | altezza prodotto |
Row_Picture | immagine prodotto |
Row_MPN | manifacturer product number prodotto |
Row_PriceVatExcluded | prezzo escluse imposte prodotto |
Row_Price | prezzo prodotto |
Row_Discounts | sconto prezzo prodotto |
Row_VatRate | percentuale imposte su prezzo prodotto |
Row_TotalVatExcluded | prezzo totale escluse imposte della riga dell'ordine |
Row_Total | prezzo totale escluse imposte della riga dell'ordine |
Row_TotalDiscounted | importo totale sconti della riga dell'ordine |
Row_Currency | sigla valuta riga ordine |
Amounts_TotalWithoutTax | ammontare riga ordine al netto delle tasse |
Amounts_VatAmount | ammontare imposte riga ordine |
Amounts_Total | ammontare totale riga ordine |
Amounts_Currency | sigla valuta ammontare riga ordine |
Amounts_ShippingCost | spese di spedizione |
Amounts_ShippingCostWithoutTax | spese di spedizione al netto delle imposte |
Amounts_ShippingTax | imposte sulle spese di spedizione |
Amounts_CouponDiscount | importo coupon sconto |
Amounts_CouponCode | codice coupon sconto |
Amounts_DiscountToCart | importo sconto sul carrello |
Shipping_Carrier | spedizioniere |
Shipping_TrackingNumber | tracciabilità spedizione |
Shipping_TransportedWeight | peso spedizione |
Shipping_ShippedTime | data spedizione |
Row_Warehouse_Key | chiave magazzino |
Row_Item_Progressive | numero progressivo della riga ordine nell'ordine di appartenenza |
col_prefixName | eventuale nome dell'attributo aggiuntivo esportato (se previsto in json parametro personalizzato) |
col_prefixValue | eventuale valore dell'attributo aggiuntivo esportato (se previsto in json parametro personalizzato) |
"map"
Nome | Valore |
|---|---|
attributes | eventuale mapping di attributi dell'ordine da esportare |
"attributes" (contenuto in "map")
Nome | Valore |
|---|---|
col_prefix
| prefisso per il nome delle colonne riservate all'attributo dell'ordine da esportare (col_prefixName, col_prefixValue) |
name | nome dell'attributo dell'ordine da esportare
|
"params" (contenuto in "map")
Nome | Valore |
|---|---|
col_prefix
| prefisso per il nome delle colonne riservate al parametro temporale dell'ordine da esportare (col_prefixName, col_prefixValue) |
name | nome del parametro temporale dell'ordine da esportare
|
"options"
Nome | Valore |
|---|---|
delimiter | carattere separatore (default ;) |
enclosure
| qualificatore di testo (default ") |
line_break
| può assumere i seguenti valori:
se non impostato è LF |
date_format | formato data, esempio Y-m-d H:i:s o Y-m-d
|
