What is needed to configure an integration?

In order to be able to use VTEX integrations, the first thing to do is to:

1. Know which domain is to be working with (e.g. my-awesome-store.myvtex.com).

2. Have a pair of credentials generated (which is composed of an "application key" and an "application token"). Those credentials have to be kept with the level of secrecy a password should be kept! Also, the generated credentials should have read permissions to all the involved resources that will be described here.

   

The application tokens are, however, only retrievable on token creation.

Is there any limitation on streams and data types?

In this integration type, each stream corresponds to a call to retrieve data from a particular API endpoint. Each endpoint has its particularities, and all of them imply some degree of pagination at some level (typically 15 or 20 records), which involves several calls to the same API endpoint, depending on the amount of records to retrieve.

This said, the following streams are available in the system to be selected:

• brands: The brands of the available products in our system.
• docks: The docks, used for delivery analysis.
• inventory: The inventory, given sku and warehouse data. Selecting this stream requires selecting the skus stream as well.
• paid_orders. The orders that were paid. Each of these orders has their payment embedded in the same record. This is the only stream to be executed incrementally (see the next section), while all the others are strictly full-table replication.
• pickup_points: The pickup points, used for delivery analysis.
• prices: The price of a product (ready to be sold). Selecting this stream requires selecting the skus stream as well.
• product_offers: The offers associated to a product. Selecting this stream requires selecting the products stream as well.
• products: The products, with all the needed description data.
• sellers: The registered sellers.
• shipping_policies: The policies for delivery (e.g. fees and working hours). Typically associated to docks and intended for delivery analysis.
• skus: The list of stock keeping units in our system (this is strictly related to products and their ability to be sold and dispatched).
• warehouses: The warehouses, used for delivery analysis and inventory tracking.