Features
| Feature | Supported | Notes |
|---|---|---|
| Set pipeline frequency | Yes | For more details, see the guide. |
| Token connection | Yes |
📘 This connector collects the following VTEX objects:
Quick Start
To create a pipeline, open the Collect module, go to "Pipelines", and click "New Pipeline".
Choose the Data Source
Use an existing source or register a new one
Connection Parameters (Source Registration)
| Field name | Description | Example |
|---|---|---|
| Account name | Your company's identifier in VTEX | nomedaempresa |
| Account environment | Your VTEX account environment | vtexcommercestable |
| Application key | Credentials generated and managed in your VTEX account. Find your key here. | vtexappkey-products2-HPABLV |
| Application token | Application token associated with your key. The appToken is shown only when created and cannot be retrieved later. For more information, see this guide. |
Pipeline Information
Assign a name and a brief description to your pipeline.
Pipeline Configuration Parameters
| Field name | Description | Example |
|---|---|---|
| Time window | Number of days used to retrieve entities based on their creation date. | 0-7 |
📘
Configure the time window according to your business rules. This field is needed because e-commerce purchases may change within a period of days. For example, a 7-day window updates data from the last 7 days in addition to appending new data.
Click "Save and Continue".
Frequency
- Finally, configure how often your pipeline should run. Choose one of the available options or enter a custom frequency using a cron expression. For more information, see the guide.
📘
The default time zone for scheduling is UTC.
All frequency methods define when extractions begin. They do not control how long replication runs or when the data actually reaches its destination.
Done! Wait for collection to run on the scheduled day and time.
To run the pipeline immediately, you can start it manually within 30 seconds after creating it. Go to "Pipelines", "List", and "Synchronize Pipeline".
After a few minutes, your pipeline will be cataloged as a Data Asset in the Explore tab.
You can also open "View pipeline" in the pipeline list to review the summary, collected entities and columns, execution history, and micro-transformation history.