VTEX is a Brazilian e-commerce giant that offers a unified commerce platform used by more than 2500 companies in 25 countries, among them are Walmart, Coca-Cola, Sony, Disney and AmBev.
Our pipeline allows you to place VTEX information in your Data Warehouse and cross-reference it with data from other tools.
Adding the data source
To add the VTEX data source on the Kondado platform, follow the steps below:
1) Access the VTEX administrative panel with the master user account
2) In the sidebar, go to Account Settings, then Account Management and then click Application Keys
3) Click the Manage My Keys button, you will be taken to the My Keys page:
4) Click the Generate Key button
5) Enter a name for the application key being created
IMPORTANT STEP FOR DATA SOURCE OPERATION:
6) Click on +Add Profiles to associate the key with the desired acess profiles -> the application key will be able to authenticate pipelines with the modules and functionalities to which the chosen profiles give access;
7) Click the Generate button
8) In the field that is displayed next, is the token. For security reasons, it is displayed only once. Copy this token and store it in a safe place.
9) Login to Kondado and go to add data sources page;
10) Select the VTEX data source and fill in the information as shown in the image below
a) Account Name: This is the first part of your VTEX admin URL. For example, if your URL is kondado.myvtex.com, the value to fill in is kondado
b) Access Key: corresponds to the Application Key generated in step (7)
c) Access Secret: corresponds to the Application Token generated in step (7) and copied in step (8)
d) Name your data source and click SAVE
Pipelines
Summary
Relationship Chart
Orders with the status of incomplete will not be returned
Coupons
Field/b> | Type | |
---|---|---|
text |
[en] Coupon code [upper case applied by Kondado] |
|
text |
[en] Coupon expiration interval per use. |
|
boolean |
[en] Defines if the coupon is archived (true) or not (false). |
|
timestamp |
||
float |
[en] Maximum items per client that the coupon can be applied. |
|
text |
[en] UTM campaign code. |
|
text |
[en] UTM source code. |
Inventory
Master Data
Field | Type | |
---|---|---|
text |
[en] Master data entity Id |
|
timestamp |
[en] Timestamp of when record was last updated |
|
timestamp |
[en] Timestamp of when record was created |
|
text |
[en] an example of a dynamic property |
|
float |
[en] an example of a dynamic property |
|
date |
[en] an example of a dynamic property |
Orders
Field | Type | |
---|---|---|
text |
[en] Change receipt order Id |
|
text |
[en] Order Origin: Marketplace or Fulfillment |
|
text |
[en] Order Status |
|
boolean |
[en] If is in a Work Flow Retry |
|
text |
[en] Last sent transactional message |
|
float |
[en] Order Sequence ID |
|
text |
||
text |
[en] Payment System Name |
|
text |
[en] Seller Name who was responsible for the order |
|
timestamp |
||
text |
||
boolean |
[en] If is in a Work Flow Retry |
|
timestamp |
||
text |
||
text |
[en] Marketplace Order Id |
|
text |
||
boolean |
[en] If is a Order Completed |
|
text |
||
float |
[en] Releated Gift List Type |
|
text |
[en] Order Sales Channel Id |
|
float |
[en] Total Order Items |
|
timestamp |
[en] Authorized Order Date |
|
timestamp |
[en] Order Creation Date |
|
text |
[en] Status Description |
|
text |
[en] Releated Gift List Id |
|
timestamp |
||
text |
[en] Currency Code in ISO 4217 |
|
text |
Order Logistics Info
Main Object
Field | Type | |
---|---|---|
text |
[en] Order Id |
|
float |
||
text |
||
text |
||
text |
||
text |
||
float |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
boolean |
||
text |
||
float |
||
text |
||
float |
||
text |
||
timestamp |
||
text |
[en] Shipping Country in ISO 3166 ALPHA-3 abbreviation |
|
text |
vtex_logisticsinfo__slas
Field | Type | |
---|---|---|
text |
[en] Order Id |
|
float |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
boolean |
||
text |
||
float |
||
text |
||
text |
vtex_logisticsinfo__deliveryIds
Orders Marketing Date
Field | Type | |
---|---|---|
text |
[en] Order Id |
|
text |
[en] UTM Source Parameters |
|
text |
[en] UTM Source Parameters |
|
text |
[en] UTM Medium Parameters |
|
text |
[en] UTM Campaign Parameters |
|
text |
[en] Order Discount Coupon [upper case applied by Kondado] |
|
text |
[en] UTMI Campaign Internal Parameters |
|
text |
[en] UTMI Page Internal Parameters |
|
text |
[en] UTMI Part Internal Parameters |
|
text |
[en] Marketing Tags Array |
Order Shipping Date
Main Object
Field | Type | |
---|---|---|
text |
[en] Order Id |
|
text |
[en] Shipping Address Type |
|
text |
[en] Shipping Neighborhood |
|
text |
[en] Shipping Address Id |
|
text |
[en] Shipping Complement |
|
text |
[en] Shipping Number |
|
text |
[en] Shipping Street |
|
text |
[en] Shipping Geo Coordinates Array |
|
text |
[en] Shipping City |
|
text |
[en] Shipping Reference |
|
text |
[en] Shipping Receiver Name |
|
text |
[en] Shipping Country in ISO 3166 ALPHA-3 abbreviation |
|
text |
[en] Shipping State |
|
text |
[en] Shipping Postal Code |
vtex_orders_shipping_data__selectedAddresses
Type | Type | |
---|---|---|
text |
[en] Related Order Id |
|
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
Order Details
Field | Type | |
---|---|---|
text |
[en] Change receipt order Id |
|
text |
[en] Order Origin: 'Marketplace' or 'Fulfillment' |
|
text |
[en] Marketplace Services Endpoint |
|
text |
[en] Open Text Field Object |
|
text |
[en] Order Sequence ID |
|
text |
||
text |
[en] Marketplace Order Id |
|
text |
[en] Custom Data Object |
|
text |
[en] Responsible store e-mail |
|
boolean |
||
timestamp |
[en] Order Last Change Date |
|
text |
||
boolean |
[en] If is a Order Completed |
|
text |
[en] Seller Name who was responsible for the order |
|
text |
||
text |
||
text |
[en] Cliente Corporate Telephone |
|
boolean |
[en] If the Client is a Corporate Client |
|
text |
||
text |
[en] Client Corporate Document |
|
text |
[en] Client Telephone |
|
text |
[en] Client User Profile ID |
|
text |
[en] Client Document Type |
|
text |
||
text |
[en] Client First Name |
|
text |
||
text |
[en] Client Last Name |
|
text |
[en] Client Corporate Inscription |
|
text |
[en] Client Corporate Name |
|
text |
[en] Client Document |
|
text |
[en] Client e-mail |
|
text |
[en] Order Form Id |
|
timestamp |
[en] Order Creation Date |
|
boolean |
[en] If Cancellation is allowed |
|
text |
||
timestamp |
[en] Invoice Date |
|
boolean |
[en] If Order Edition is allowed |
|
text |
[en] Merchant Name |
|
timestamp |
[en] Authorized Order Date |
|
text |
[en] Cancel Reason |
|
text |
[en] Account Hostname registered in License Manager |
|
text |
[en] Call Center Operator responsible for the order |
|
float |
[en] Price Tag Value |
|
text |
[en] Status Description |
|
text |
||
text |
[en] Order Group Id |
|
text |
[en] Order Status |
|
text |
[en] Order Seller Id |
|
text |
||
text |
||
float |
[en] Rounding Error Total Amount |
|
text |
[en] Order Sales Channel Id |
|
text |
[en] If is a Certified Marketplace |
|
text |
[en] Marketplace Base URL |
|
text |
[en] Marketplace Name |
Order Items
Main Object
Field | Type | |
---|---|---|
text |
[en] Order Id |
|
int |
[en] This field is calculated by Kondado and indicates the position of the given item within the order response array - useful for referrencing with other pipelines that use the field 'itemindex' |
|
text |
||
text |
||
text |
||
boolean |
[en] If this item is a gift in order context |
|
float |
[en] Comission value registered to Seller |
|
float |
[en] Comission value registered to Seller |
|
text |
||
float |
[en] Item Shipping Price |
|
text |
[en] SKU EAN |
|
text |
||
text |
[en] Item Name |
|
text |
||
text |
||
text |
[en] Item Measurement Unit |
|
float |
[en] Item Unit Multipler |
|
text |
[en] Item Product ID |
|
text |
[en] Item Reference ID |
|
text |
[en] Item Tax Code |
|
text |
||
float |
[en] Item Tax |
|
text |
[en] Product Slug URL |
|
text |
||
text |
[en] Call Center Operator responsible for the order |
|
text |
[en] Item ID |
|
text |
[en] Item Seller |
|
text |
[en] Item Order Unique ID |
|
float |
||
text |
[en] Item Pre Sale Date |
|
float |
[en] Item Selling Price |
|
text |
[en] Invoice Date |
|
float |
[en] Item Price |
|
text |
||
float |
[en] Item Reward value |
|
text |
[en] Reservation ID |
|
text |
[en] SKU Image URL |
|
float |
[en] Item List Price |
|
float |
[en] Item Quantity |
|
text |
[en] Brand Name |
|
text |
[en] Brand ID |
|
text |
[en] Item Category ID |
|
text |
[en] All releated Product Clusters |
|
text |
||
text |
||
text |
||
text |
||
float |
[en] Item Cubic Weight |
|
float |
[en] Item Height |
|
float |
[en] Item Length |
|
float |
[en] Item Weight |
|
float |
[en] Item Width |
vtex_orders_items__additionalinfo__categories
Orders Payment Transactions
Main Object
Field | Type | |
---|---|---|
text |
||
boolean |
[en] If is a active transaction |
|
text |
[en] Transaction Merchant Name |
|
text |
[en] Transaction Status |
|
text |
[en] Transaction Id |
vtex_payment_transactions__payments
Field | Type | |
---|---|---|
text |
||
text |
[en] Transaction Id |
|
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
||
text |
[en] Connector Return Code |
|
text |
||
text |
[en] Connector Authorization Id |
|
text |
||
text |
||
text |
||
text |
||
text |
[en] Payment Card Holder |
|
date |
[en] Payment Due Date |
|
text |
[en] Payment Card expire Month |
|
text |
[en] Payment Card expire Year |
|
text |
[en] Payment Card First Digits |
|
text |
||
text |
[en] Gift Card Caption |
|
text |
[en] Gift Card Id |
|
text |
[en] Gift Card Name |
|
text |
||
text |
[en] Payment Group. It represents the payment method. |
|
text |
||
float |
||
text |
||
text |
[en] Payment Card Last Digits |
|
text |
||
text |
||
text |
||
text |
||
text |
||
float |
||
text |
||
text |
[en] Payment URL |
|
float |
Order Rates and Benefits
Main Object
Field | Type | |
---|---|---|
text |
[en] Order Seller Id |
|
text |
[en] Item Description |
|
boolean |
[en] If it is allowed to acumulate the Rates and Benefits |
|
text |
[en] The id of the promotion[Kondado] |
|
text |
[en] Rates and Benefits Name |
vtex_orders_rates_and_benefits_matchedParameters
Total Orders
Field | Type | |
---|---|---|
text |
[en] Change receipt order Id |
|
float |
[en] Itens total |
|
float |
[en] Discounts total |
|
float |
[en] Shipping/freight total |
|
float |
[en] Tax total |
Promotions
Main Object
Field | Type | |
---|---|---|
text |
[en] Promotion ID |
|
boolean |
[en] If set as true, gifts Multiplier is activated. |
|
boolean |
[en] If set to false, this Promotion will be applied to any trade policies present on the idsSalesChannel field. If set to true, trade policies present on that field will make this Promotion or Tax not to be applied. |
|
timestamp |
[en] Promotion or Tax Begin Date |
|
text |
[en] Internal description of the Promotion or Tax. |
|
timestamp |
[en] Promotion or Tax End Date |
|
boolean |
||
boolean |
[en] if set as true the Promotion is activated. If set as false the Promotion is deactivated. |
|
boolean |
[en] If set as true the Promotion is archived. If set as false the Promotion is not archived. |
|
boolean |
||
timestamp |
||
float |
[en] Defines how many times the Promotion can be used. |
|
text |
[en] Promotion name or Tax name. |
|
float |
[en] Percentual Tax over purchase total value. |
|
boolean |
||
float |
[en] Object composed by the brands that will activate or deactivate the Promotion |
|
boolean |
[en] if set to true, this Promotion will be applied to any brand present on the brands field. If set to false, brands present on that field will make this Promotion not to be applied. |
|
float |
[en] Object composed by the categories that will activate or deactivate the Promotion |
|
boolean |
[en] If set to true, this Promotion will be applied to any category present on the categories field. If set to false, categories present on that field will make this Promotion not to be applied. |
|
float |
[en] Object composed by the collections that will activate or deactivate the Promotion |
|
boolean |
||
float |
[en] Object composed by the products that will activate or deactivate the Promotion |
|
boolean |
[en] If set to true, this Promotion will be applied to any product present on the products field. If set to false, products present on that field will make this Promotion not to be applied. |
|
float |
||
boolean |
||
float |
[en] Object composed by the SKUs that will activate or deactivate the Promotion |
|
boolean |
[en] If set to true, this Promotion will be applied to any SKU present on the skus field. If set to false, SKUs present on that field will make this Promotion not to be applied. |
|
text |
||
text |
[en] Defines what is the type of the promotion |
|
text |
||
text |
[en] Coupon utmSource code. |
|
text |
promotions__Campaigns
promotions_idsSalesChannel
SKUs
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[en] SKU ID |
|
float |
[en] SKU Width |
|
float |
[en] Packaged Weight in Kilos |
|
float |
[en] SKU Height |
|
float |
[en] Multiplies the amount of SKUs inserted on the cart |
|
float |
[en] Commercial Condition ID |
|
text |
[en] SKU RefId |
|
boolean |
[en] Shows if the SKU is a Kit |
|
boolean |
[en] Defines if Kit components can be sold apart |
|
text |
[en] SKU Estimated Date Arrival |
|
float |
[en] Packaged Width |
|
text |
[en] SKU Name |
|
float |
[en] Packaged Height |
|
float |
||
float |
[en] Packaged Length |
|
float |
[en] SKU Length |
|
text |
[en] Product ID |
|
text |
[en] Manufacturer Code |
|
text |
[en] Measurement Unit |
|
float |
[en] SKU Weight in Kilos |
|
float |
[en] How much the client will get rewarded by buying the SKU |
|
text |
[en] Defines deliver model |
|
timestamp |
[en] SKU Creation Date |
|
boolean |
[en] Shows if the SKU is active |
|
text |
[en] SKU EAN |
vtex_skus_videos
SKUs: Kits
Field | Type | |
---|---|---|
float |
[en] KIT SKU ID (parent) |
|
float |
[en] COMPONENT SKU ID (child) |
|
float |
[en] Component quantity. |
|
float |
[en] Component price per unit |
SKUs: Prices
Main Object
Field | Type | |
---|---|---|
float |
[en] SKU unique identifier number. |
|
float |
[en] SKU selling base price. |
|
float |
[en] SKU selling cost price. |
|
float |
[en] SKU's suggested selling price. |
|
float |
[en] The profit percentage that is to be obtained from the sale of that SKU |
vtex_skus_prices__fixedPrices
Field | Type | |
---|---|---|
float |
[en] SKU unique identifier number. |
|
timestamp |
||
timestamp |
||
float |
[en] SKU List Fixed Price. |
|
float |
[en] Minimum quantity of the SKU for the fixed price to be applied. |
|
float |
[en] Trade policy name or ID than have the fixed price configured. |
|
float |
[en] Fixed price value. |