Tutorials & Solutions
Orders management
Inventory and shipping
Payments
Catalog
Prices
Rates & Benefits
Insights
Master Data
Message Center
Sales Policies
CMS
Portal
Suggestions
Sellers
Integrations
Apps
Authentications
Account management
Billing
Credit Control
Omnichannel
VTEX IO
Projects & Integrations

How VTEX integration interfaces work

VTEX Team
VTEX Team
Last updated
4/3/2019

Integration with an ERP system enables control of your inventory regarding orders made, reserves write-offs, and price handling, both for definition of table values and application of promotional campaigns, in addition to invoicing, associating a tax invoice to the purchase, dispatching and other different resources. That is, it enables management of products, prices, inventories, orders, carriers, and others, through your ERP.

On the VTEX system, you will be able to integrate your ERP through several interfaces: API REST (JSON language) and WebService (SOAP – XML language) – which is already out of use.

ERP-VTEX-Integration

In addition to ERP, for the transmission to occur, there must be a system in place to support the communication between ERP and VTEX. This system is named as “Integrator”. In general, ERP develops its own integrator, but it may also be developed by the store itself, or by an agency contracted by the store.

To integrate ERPs into VTEX, use our specific guide.

Interfaces

API REST

This is the most up-to-date interface, being the most recommended for use together with the VTEX system.

Exclusively regarding the Catalog (Categories, Brands, Products and SKUs), the WebService may carry out some actions that APIs are not able to perform yet. However, new APIs are made available quite often, and they can be followed on our Developer Docs.

Since it uses the Json language, its processing structure is considerably lighter and simpler, enabling handling of a greater number of requests, and even developing B.I. feeding flows. This is the language used in the communication among VTEX modules.

This interface has some peculiarities regarding authentication, structuring of search parameters, request bodies, requests that do not require a body, and others. Additionally, each VTEX module (Orders Management, Payments, MasterData, and others) has its own API library with a specific function.

See below the documentation required to help start integration through the API REST Interface:

Web Service

The use of the VTEX Web Service in integration processes should be avoided as much as possible.

Except for the Catalog (Categories, Brands, Products and SKUs), whose API REST is being developed, all other VTEX modules have well defined and high performance API RESTs.

Our webservice works with a complete WSDL library that can be easily adapted to integrations made through different programming types. It will include all methods currently available for different applications regarding the resources of your organization.

Just as the API REST interface, this interface has some peculiarities regarding authentication, versions and data types, among others.

See below the documentation required to help start integration through the WebService Interface:

Still got questions?
Ask the community
Find solutions and share ideas in VTEX's community.
Talk to our experts
Get in touch if you have something specific to ask about the platform.
  • PT
  • ES
VTEX website