File prodotti XML
Struttura del file xml
Nodo | Parent |
|---|---|
bindCommerceProducts | - |
<bindCommerceProducts apiversion="2.0" creator="http://www.bindcommerce.com" createdon="2020-02-25 08:55:59"> |
Nome attributo | Descrizione |
|---|---|
apiversion | versione delle api che hanno prodotto il file xml (da ora in poi feed) |
creator | valore fisso http://www.bindcommerce.com |
createdon | Data di creazione del feed (UTC) |
< Config >
Nodo | Parent |
|---|---|
Config | bindCommerceProducts |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/Config |
<Config name="Prova esportazione" product_informations="1" availability="1" prices="1" attributes="1" categories="1" images="1"></Config> |
Nodo che contiene le informazioni di configurazione che hanno prodotto il feed. |
Nome attributo | Descrizione |
|---|---|
name | nome della configurazione così come definito in bindCommerce |
product_informations | indica se il feed include le informazioni sui prodotti |
availability | indica se il feed include le informazioni sulla disponibilità |
prices | indica se il feed include le informazioni sui prezzi |
attributes | indica se il feed include le informazioni sugli attributi |
categories | indica se il feed include le informazioni sulle categorie |
images | indica se il feed include le informazioni sulle immagini |
< ProductList >
Nodo | Parent |
|---|---|
ProductList | ProductList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList |
<ProductList>...</ProductList> |
Contiene i nodi <Product> dei singoli prodotti. |
Se si desidera abbinare più alberature di categorie ad un prodotto, è possibile aggiungere più tag Category
< ProductDeletedList >
Nodo | Parent |
|---|---|
ProductList | ProductList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList |
<ProductList>...</ProductList> |
Contiene i nodi <Product> dei singoli prodotti. |
< PRODUCT >
Nodo | Parent |
|---|---|
Product | ProductList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product |
<Product id="14767" lastmodified="2020-02-25 08:53:48" createdon="2020-02-25 08:53:48" sku=”ABC123”>...</Product> |
Contiene i nodi con le informazioni dei singoli prodotti |
Nome attributo | Descrizione |
|---|---|
id | id interno bindCommerce del prodotto, identifica univocamente il record |
lastmodified | data di ultima modifica del prodotto (UTC) |
createdon | data di creazione del prodotto (UTC) |
sku | sku del prodotto |
< DETAILS >
Nodo | Parent |
|---|---|
Details | Product |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/Details |
<Details></Details> |
Contiene i dati del prodotto rappresentati dai nodi ProductInfoList, Reference e Dimension. Se l’attributo “product_informations” del nodo Config è uguale a zero i nodi ProductInfoList e Dimension non sono presenti mentre il tag Reference viene valorizzato con il solo nodo Stock qualora l’attributo availability del nodo Config sia uguale a 1. |
< ProductInfoList >
Nodo | Parent |
|---|---|
ProductInfoList | Details |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/Details/ProductInfoList |
<ProductInfoList></ProductInfoList> |
Contiene i nodi ProductInfo con le informazioni descrittive del prodotto e descrizioni alternative |
< ProductInfo >
Nodo | Parent |
|---|---|
ProductInfo | ProductInfoList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/Details/ProductInfoList/ProductInfo |
<ProductInfo type="main" lang="IT" langcode=”IT_IT”>...</ProductInfo> |
<ProductInfo type="alternative" lang="FR" langcode=”FR_FR” alt_name=”Francese” alt_id=”8”>...</ProductInfo> |
Attributi
Nome attributo | Descrizione |
|---|---|
type | Prevede due valori possibili: main se le informazioni descrittive provengono dalla tabella prodotti additional se le informazioni descrittive provengono da una alternativa |
alt_name | In caso di type=alternative contiene il nome dell’alternativa altrimenti è vuoto |
alt_id | In caso di type=alternative contiene l’id interno dell’alternativa |
lang | Codice ISO 639-1 della lingua convertita in maiuscolo |
langcode | Codice regionale lingua come da RFC 1766 convertita in maiuscolo |
Nodi figli
Nome nodo | Descrizione |
|---|---|
Name | Nome del prodotto |
ShortDescription | Descrizione breve |
DescriptionHtml | Descrizione estesa in formato html |
Notes | Note |
MetaTitle | Meta tag title |
MetaKeywords | Meta tag keywords |
MetaDescription | Meta tag description |
CustomField1 | Campo libero 1 |
CustomField2 | Campo libero 2 |
CustomField3 | Campo libero 3 |
CustomField4 | Campo libero 4 |
CustomField5 | Campo libero 5 |
CustomField6 | Campo libero 6 |
CustomField7 | Campo libero 7 |
< Dimension >
Nodo | Parent |
|---|---|
Dimension | Details |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/Details/Dimension |
<Dimension weightuom="kg" lwhuom="cm"></Dimension> |
Contiene le informazioni su peso e dimensione del prodotto |
Attributi
Nome attributo | Descrizione |
|---|---|
weightuom | Unità di misura peso |
lwhuom | Unità di misura lineare |
Nodi figli
Nome nodo | Descrizione |
|---|---|
Weight | Peso |
VolumeWeight | Peso volumetrico |
Length | Lunghezza |
Width | Base |
Height | Altezza |
< Reference >
Nodo | Parent |
|---|---|
Reference | Details |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/Details/Reference |
<Reference></Reference> |
Contiene i codici e i riferimenti (fornitore, produttore, tag di selezione) del prodotto. Se l’attributo product_informations del nodo Config è uguale a 0 e l’attributo availability è uguale a 1 questo nodo contiene solamente il nodo figlio Stock |
Nodi figli
Nome nodo | Descrizione |
|---|---|
Barcode | Codice barcode, l’attributo “kind” contiene la tipologia del barcode. Es: <Barcode kind=”EAN”>501234567890></Barcode> |
Manufacturer | Codice Produttore. Ha due attributi id e code che contengono rispettivamente l’id e il codice del produttore così come definiti in bindCommerce. Es. <Manufacturer id="378" code="KKTR2579”>3M Italia</Manufacturer> |
Supplier | Codice fornitore. Ha due attributi id e code che contengono rispettivamente l’id e il codice del fornitore così come definiti in bindCommerce. Es. <Supplier id="7" code="AD344C21”>Centro Ufficio</Supplier> |
Special | Ha valore 1 se il prodotto è stato flaggato come “In evidenza” nella scheda bindCommerce |
SelectionBit | Ha valore 1 se il prodotto è stato flaggato come “Contrassegno semplice” nella scheda bindCommerce |
SelectionTags | Contiene il valore dei tag impostati nel campo “Contrassegno con tag” nella scheda bindCommerce |
Stock | Quantità disponibile in tabella prodotti |
< PriceList >
Nodo | Parent |
|---|---|
PriceList | Product |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/PriceList |
<PriceList></PriceList> |
Contiene i nodi Price con le informazioni sui prezzi dei prodotti. Se l’attributo prices del nodo Config è uguale a 0 questo nodo non ha figli. |
< Price >
Nodo | Parent |
|---|---|
Price | PriceList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/PriceList/Price |
<Price id=”40”></Price> |
Contiene i nodi specificati di seguito con le informazioni sui prezzi dei prodotti. |
Attributi
Nome attributo | Descrizione |
|---|---|
id | id listino bindCommerce |
Nodi figli
Nome nodo | Descrizione |
|---|---|
ListCode | Codice listino così come definito nel campo “Chiave listino Export file” di bindCommerce |
ListName | Nome listino |
NetPrice | Prezzo IVA esclusa |
Currency | Codice valuta |
Vat | IVA |
GrossPrice | Prezzo IVA compresa |
Override | Applicazione prezzo scontato Può assumere i valori: 0 => disabilitato 1 => il prezzo scontato è lordo (IVA compresa) -1 => Il prezzo scontato è netto (IVA esclusa) |
OverridePrice | Prezzo scontato |
DateRange | Range di applicazione. Ha due attributi from e to che specificano la data di inizio / fine. Esempio <DateRange from=”2018-01-29 09:58:01” to=”2019-06-04 08:07:19”/> |
QtyRange | Range quantità. Ha due attributi from e to che specificano la quantità minima / massima di applicazione. Esempio <QtyRange from=”2” to=”6” /> |
< CategoryList >
Nodo | Parent |
|---|---|
CategoryList | Product |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/CategoryList |
<CategoryList filter_tag=”scarpe,donna”></CategoryList> |
Contiene i nodi Category con le informazioni sulle categorie. |
Attributi
Nome attributo | Descrizione |
|---|---|
filter_tag | Elenco dei tag che sono stati utilizzati come filtro per le categorie. Specificati attraverso l’opzione “Inviare solo le categorie contrassegnate con i tags”. Nel caso non sia stato specificato nessun tag l’attributo è presente ma non ha alcun valore. |
< Category >
Nodo | Parent |
|---|---|
Category | CategoryList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/CategoryList/Category |
<Category id="266" lang="IT" langcode="IT_IT"> |
Contiene i nodi specificati di seguito con le informazioni sulle categorie. Ogni nodo contiene inoltre un nodo <AlternativeList> con l’elenco delle descrizioni alternative specificate in “Includi le seguenti descrizioni alternative” |
Attributi
Nome attributo | Descrizione |
|---|---|
id | id categoria bindCommerce |
lang | Codice ISO 639-1 della lingua convertita in maiuscolo |
langcode | Codice regionale lingua come da RFC 1766 convertita in maiuscolo |
Nodi figli
Nome nodo | Descrizione |
|---|---|
Name | Nome della categoria |
Key | Chiave categoria così come generata automaticamente da bindCommerce |
ImageBig | Immagine grande |
ImageMini | Miniatura immagine |
ImageCatalogMain | Immagine catalogo a pagina intera |
ImageCatalogFooter | Immagine Catalogo footer |
Tags | Tags di selezione |
DescriptionHtml | Descrizione della categoria |
DropshippingEnabled | Selezione dropshipping |
Order | Ordine di esportazione |
< AlternativeList >
Nodo | Parent |
|---|---|
AlternativeList | Category |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/CategoryList/Category/AlternativeList |
<AlternativeList>...</AlternativeList> |
Contiene i nodi Alternative con le descrizioni alternative delle categorie. |
< Alternative >
Nodo | Parent |
|---|---|
Alternative | AlternativeList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/CategoryList/Category/AlternativeList/Alternative |
<Alternative id="7" name="Inglese" lang="EN" langcode="EN_US">...</Alternative> |
Contiene le descrizioni alternative della categoria. |
Attributi
Nome attributo | Descrizione |
|---|---|
id | id interno bindCommerce |
name | Nome alternativa |
lang | Codice ISO 639-1 della lingua convertita in maiuscolo |
langcode | Codice regionale lingua come da RFC 1766 convertita in maiuscolo |
Nodi figli
Nome nodo | Descrizione |
|---|---|
Name | Nome alternativo della categoria |
DescriptionHtml | Descrizione alternativa della categoria |
< WarehouseList >
Nodo | Parent |
|---|---|
WarehouseList | Product |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/WarehouseList |
<WarehouseList></WarehouseList> |
Contiene i nodi Warehouse con le informazioni sulle disponibilità di magazzino così come definite in “Stock aggiuntivi da esportare”. Se l’attributo availability del nodo Config è uguale a 0 questo nodo non ha figli. |
< Warehouse >
Nodo | Parent |
|---|---|
Warehouse | WarehouseList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/WarehouseList/Warehouse |
<Warehouse id=”40”></Warehouse> |
Contiene i nodi specificati di seguito con le informazioni sulle disponibilità aggiuntive |
Attributi
Nome attributo | Descrizione |
|---|---|
id | id stock aggiuntivo bindCommerce |
Nodi figli
Nome nodo | Descrizione |
|---|---|
Name | Nome stock aggiuntivo |
Qty | Quantità stock |
< AttributeList >
Nodo | Parent |
|---|---|
AttributeList | Product |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/AttributeList |
<AttributeList></AttributeList> |
Contiene i nodi Attribute con le informazioni sugli attributi così come definiti nella sezione “Attributi”. Se l’attributo attributes del nodo Config è uguale a 0 questo nodo non ha figli. |
< Attribute >
Nodo | Parent |
|---|---|
Attribute | AttributeList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/AttributeList/Attribute |
<Attribute id="6" lang="IT" langcode="IT_IT" key="color" name="colore"> |
Contiene i nodi specificati di seguito con le informazioni sull’attributo. |
Attributi
Nome attributo | Descrizione |
|---|---|
id | id attributo bindCommerce |
lang | Codice ISO 639-1 della lingua convertita in maiuscolo |
langcode | Codice regionale lingua come da RFC 1766 convertita in maiuscolo |
key | Valore del campo “Chiave export” così come definito nella tabella attributi bindCommerce |
name | Nome attributo |
Nodi figli
Nome nodo | Descrizione |
|---|---|
Value | Valore attributo dopo l’eventuale conversione di scala. Se è stata specificata l’opzione “Effettuare una conversione di scala degli attributi?” il tag contiene gli attributi scale_from e scale_to che contengono rispettivamente la scala di partenza e la scala di arrivo specificate in fase di configurazione. Contiene inoltre un attributo data che contiene il valore originale dell’attributo. L’eventuale conversione di scala applicata è determinata dall’attributo rescale. Se rescale è impostato a 0 gli attributi scale_from e scale_to non sono presenti.Esempi: <Value rescale="0" data="77">77</Value> <Value rescale="1" data="Bianco" scale_from=”colori_ita” scale_to=”colori_en”>White</Value> |
< ImageList >
Nodo | Parent |
|---|---|
ImageList | Product |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/ImageList |
<ImageList type="main" max_count="9" filter_tag="scarpe"></ImageList> <ImageList type="alternative" max_count="6" filter_tag="scarpe"></ImageList> |
Contiene i nodi Image con le informazioni sulle immagini dei prodotti. Se l’attributo images del nodo Config è uguale a 0 questo nodo non ha figli |
Attributi
Nome attributo | Descrizione |
|---|---|
type | Assume il valore “main” se le immagini sono state prelevate dalla tabella prodotti (opzione Da dove prelevare le immagini) altrimenti assume il valore “alternative” |
max_count | Numero massimo di immagini presenti così come definito in “Numero massimo di immagini da esportare” |
filter_tag | Elenco dei tag che sono stati utilizzati come filtro per le immagini. Specificati attraverso l’opzione “Filtro immagini sui tags”. Nel caso non sia stato specificato nessun tag l’attributo è presente ma non ha alcun valore |
< Image >
Nodo | Parent |
|---|---|
Image | ImageList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/ImageList/Image |
<Image sorting="0" tags="" type="big"/> <Image sorting="0" tags="" type="thumb"/> |
Contiene l’url dell’immagine prodotto |
Attributi
Nome attributo | Descrizione |
|---|---|
sorting | Assume il valore “main” se le immagini sono state prelevate dalla tabella prodotti (opzione Da dove prelevare le immagini) altrimenti assume il valore “alternative” |
tags | Assume il valore del campo Tag immagine così come specificato nelle informazioni relative alle immagini della tabella Prodotti |
type | Assume il valore “big” se l’immagine fa riferimento al campo Immagine grande; Assume il valore “thumb” se l’immagine fa riferimento al campo “Immagine piccola” |
< VariantList >
Nodo | Parent |
|---|---|
VariantList | Product |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList |
<VariantList></VariantList> |
Contiene i nodi Variant con le informazioni sulle varianti prodotto |
< Variant >
Nodo | Parent |
|---|---|
Variant | VariantList |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList |
<Variant id="14770" id_parent="14769" sku_parent="SCARPE-B001" sku="SCARPE-B001/36/-" created_on="2018-03-03 00:11:01" last_modified="2018-03-03 00:28:02"> |
Contiene le informazioni sulla singola variante. |
Attributi
Nome attributo | Descrizione |
|---|---|
id | id interno bindCommerce |
id_parent | id interno del prodotto padre |
sku_parent | SKU del prodotto padre |
sku | SKU del prodotto |
last_modified | data di ultima modifica del prodotto |
created_on | data di creazione del prodotto |
< ProductInfoList >
Nodo | Parent |
|---|---|
ProductInfoList | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/ProductInfoList |
Attributi e nodi figli sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/Details/ProductInfoList |
< Dimension >
Nodo | Parent |
|---|---|
Dimension | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/Dimension |
Attributi e nodi figli sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/Details/Dimension |
< Reference >
Nodo | Parent |
|---|---|
Reference | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/Reference |
Attributi e nodi figli sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/Details/Reference ad eccezione dei nodi figli Supplier e Manufacturer che, per le varianti prodotto, non vengono mai valorizzati |
< PriceList >
Nodo | Parent |
|---|---|
PriceList | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/PriceList |
Attributi e nodi figli sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/PriceList |
< WarehouseList >
Nodo | Parent |
|---|---|
WarehouseList | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/WarehouseList |
Attributi e nodi figli sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/WarehouseList |
< MainAttributeList >
Nodo | Parent |
|---|---|
MainAttributeList | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/MainAttributeList |
Contiene i nodi <Attribute …> con le informazioni sugli attributi di tipo “Prodotti - principale (genera varianti)” Attributi e nodi figli dei nodi <Attribute> sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/AttributeList/Attribute |
< AdditionalAttributeList >
Nodo | Parent |
|---|---|
AdditionalAttributeList | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/AdditionalAttributeList |
Contiene i nodi <Attribute …> con le informazioni sugli attributi di tipo “Prodotti - aggiuntivo” Attributi e nodi figli dei nodi <Attribute> sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/AttributeList/Attribute |
< ImageList >
Nodo | Parent |
|---|---|
ImageList | Variant |
Percorso completo del nodo: |
|---|
/bindCommerceProducts/ProductList/Product/VariantList/Variant/ImageList |
Attributi e nodi figli sono conformi a quanto specificato nel nodo /bindCommerceProducts/ProductList/Product/ImageList |
CHIAMATA DI CONTROLLO DELLO STATO
La chiamata precedente di importazione dei prodotti via API prende in consegna tutti i prodotti e fornisce un risultato di successo solo in merito alla presa in consegna, ma non in merito all’esito finale di importazione. Ciò perché è una chiamata batch che può richiedere diversi minuti. Per controllare invece l’esito dell’importazione occorre invece effettuare una nuova chiamata che fornisce il log di stato dell’esecuzione.
Lo stesso log può essere consultato cliccando sui pulsanti “Connettori” e “In Esecuzione” nell’interfaccia bindCommerce nel menu in alto.
Per farlo invece a livello programmatico si può usare invece la seguente usando l’id del connettore di cui si vuole conoscere lo stato. N = id del connettore.
L’autenticazione avviene attraverso lo stesso token assegnato per il nodo API.
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://miohost.bindcommerce.cloud/integrator-tool/api/connector_status.php?id=N",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: text/xml",
"token: 0a09039b989e7b705da2575ec4ae882f"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Questa chiamata restituisce un json così formato:
[
'status' => success || error
'message' => Stringa con la descrizione del log del connettore
'code' => un codice numerico che esprime successo o fallimento
]
Di seguito si riportano i valori del parametro code
200 => nessun connettore in esecuzione
201 => connettore in esecuzione
401 => errore interno
402 => manca il connettore
403 => errore interno
404 => manca il token di autenticazione
405 => token non configurato nel nodo
406 => autenticazione fallita
407 => connettore inesistente
