Configuring XML

XML integration

XML is a markup language that allows computers and applications to communicate. Its main feature is the hierarchically organized structure for creating texts, data bases and vector drawings.

The XML language can be combined with different standards, which makes it possible for an XML created from database A to be read by database B.

The XML configuration functionality in VTEX makes use of this feature of being able to combine different standards to enable other databases to read the structures created by the VTEX database.

This means that, when entering the tag names in the Id do Produto field, for example, with Product_Id, the VTEX database will understand that this information has to be entered there, making it possible to understand by Google, Facebook, Buscapé and many other systems that will read the structure.

Changes to XML take an average of two hours to be updated.

Here are some examples of partners that integrate with VTEX XML:

Afilio
Buscapé
Criteo
Facebook
Google
MSN
Sociomantic
UOL
UOL Dynad
Zanox

New XML

Before performing the registration of a new XML, it is important to have access to the structure of the system to which you intend to export your catalog. That is, you will need to know the names of the tags that are used by their XML and what information they require for this structure to be assembled, for example product ID, product name, SKU ID, SKU name, price, among others.

Once you have this, follow the steps below to configure your XML:

In the VTEX Admin, go to Store settings, or type Store settings in the search bar at the top of the page.
On Channels, click on XML Integration.
Click on the New XML button. You will be redirected to a form.
Choose the XML Type.
Enter the file name to identify it on the list of XMLs.
Choose the Encoding type.
Choose which collection will have its products listed.
Select the currency symbol in the prices.
Choose the price format, more specifically whether or not to use the thousands separator.
Select whether to use standard separator for categories or the Google Shopping separator (read more about configurations for XML on Google Shopping in the article Value Standard for Product Specifications Attribute – XML GoogleShopping.
Choose whether or not to display the unavailable SKUs on the marketplace site, in other words, whether the product will be displayed for purchase, even if it is not available for immediate delivery.
Select whether you want the product displayed with the default SKU information.
Thereafter, you have to enter the tags in accordance with the what has been defined by the system you will be sending the XML to. You must check the selection box in the Show content column, for the tags which have a name entered. The tags with this option checked, and which you cannot deselect, are mandatory.
The URL used to access the XML is generated automatically, according to the domain registered in the Web Site dictionary, in the CMS.

In case the trade policy has restricted access, the XML will not be generated.

Native connectors: an alternative to XML when integrating with marketplaces

Instead of integrating with a marketplace using an XML file, it is possible to do it with a native connector developed by VTEX. Whenever possible, a native connector should be your standard choice, as it provides more efficiency. The current native connectors available are the following: