VTEX is a comprehensive e-commerce platform that provides a wide range of solutions for online businesses. It offers tools for catalog management, order processing, payments, and logistics, enabling businesses to create and manage their online stores efficiently.

​
Configuring VTEX as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the VTEX option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You’ll need your VTEX Application Key and Token for this connection. You can generate these in your VTEX account settings. For detailed instructions, please refer to the VTEX Application Keys Guide to ensure you have given the relevant permissions.
  • App Key: Your VTEX appKey for API authentication.
  • App Token: Your VTEX appToken for API authentication.
  • Account Name: Your VTEX account name. It can be found in the subdomain of your VTEX admin URL. For example: if your admin URL is example.myvtex.com, the value to fill in this field is example.
  • Start Date: The earliest date to sync records from the API. Please note VTEX Orders API only returns data from a maximum of 2 years ago.
An App key includes specific permissions, based on License Manager roles and resources selected when creating or editing the App key. Read Managing app key permissions for more details.

​
2. Select streams

Choose which data streams you want to sync. VTEX provides access to your store’s order information.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select a name for each table (which will contain the fetched data) and the type of sync.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can determine when to execute a full sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while. Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from VTEX and their corresponding fields: