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.
Lookback window (days): While running incremental extraction, retrieve once again the records created up to the provided period prior to the creation of the latest record previously extracted.
Category tree levels (optional): The number of category tree levels to fetch. Increase this value to include deeper subcategories. Default is 10.
Order status filter: Whether to extract only complete orders, only incomplete ones or all of them.
Master data acronyms (optional): The acronyms of the master data entities to extract (e.g., CL for clients, AD for addresses). Leave empty if you don’t need to extract any master data entity.

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, catalog details, and more.

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 the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.

Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once 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 define some additional settings:

Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
Determine when to execute an Additional 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:

Categories

Stream containing detailed information about product categories.Key fields:

Field	Type	Description
`Id`	Integer	Category’s unique numerical identifier.
`Name`	String	Category name.
`FatherCategoryId`	Integer	Parent category ID, if any.
`Title`	String	Category title tag, used for SEO.
`Description`	String	Category description.
`Keywords`	String	Keywords related to the category, used for SEO.
`IsActive`	Boolean	Whether the category is active.
`LomadeeCampaignCode`	String	Lomadee campaign code.
`AdWordsRemarketingCode`	String	Google Ads remarketing code.
`ShowInStoreFront`	Boolean	Whether the category is shown in the storefront.
`ShowBrandFilter`	Boolean	Whether the brand filter is shown for this category.
`ActiveStoreFrontLink`	Boolean	Whether the storefront link is active for this category.
`GlobalCategoryId`	Integer	Google’s global category ID associated with this category.
`StockKeepingUnitSelectionMode`	String	Defines how SKU selection is displayed for this category.
`Score`	Integer	Value used to set the priority on the search result page.
`LinkId`	String	Slug used to build the category page URL.
`HasChildren`	Boolean	Whether this category has subcategories.

Category Tree

Stream containing the hierarchical tree structure of categories.Key fields:

Field	Type	Description
`id`	Integer	Category ID.
`name`	String	Category name.
`hasChildren`	Boolean	Whether this category has subcategories.
`url`	String	Category page URL.
`Title`	String	Category title tag, used for SEO.
`MetaTagDescription`	String	Category meta tag description, used for SEO.
`FatherCategoryId`	Integer	Parent category ID, if any.

Coupons

Stream containing a list of all coupons from your VTEX account.

Field	Type	Description
`lastModifiedUtc`	String	Date and time of the last update of the coupon in UTC format.
`utmSource`	String	UTM source code.
`utmCampaign`	String	UTM campaign code.
`couponCode`	String	Coupon code.
`isArchived`	Boolean	Defines if the coupon is archived (true) or not (false).
`maxItemsPerClient`	Integer	Maximum items per client that the coupon can be applied.
`expirationIntervalPerUse`	String	Coupon expiration interval per use.
`maxUsage`	Integer	Amount of times the coupon can be used.
`groupingKey`	String	If the coupon was created as a multiple coupon or using Generate coupons in bulk, this field returns the original couponCode informed.

Data Entities (Master Data)

Dynamic streams for extracting VTEX Master Data entities. Each acronym you configure in the Master data acronyms field generates a separate stream named data_entity_{acronym}.Common acronyms include CL (Clients), AD (Addresses), and OD (Orders Master Data). The schema is dynamically fetched from VTEX based on each data entity’s configuration.

Field	Type	Description
`id`	String	Unique identifier of the document.
`updatedIn`	String	Date and time of the last update (used for incremental sync).
`(additional properties)`	Variant	Custom properties according to the data entity schema.

Inventory

Stream listing inventory information for all SKUs and all warehouses.

Field	Type	Description
`skuId`	String	SKU ID.
`warehouseId`	String	Warehouse ID.
`warehouseName`	String	Warehouse name.
`totalQuantity`	Integer	Total quantity of items of the given SKU.
`reservedQuantity`	Integer	SKU reserved quantity.
`hasUnlimitedQuantity`	Boolean	When set as false, every sold unit decreases the item’s available quantity. When set as true, the SKU from the warehouse is always available for sale.
`timeToRefill`	String	Time to refill.
`dateOfSupplyUtc`	String	Supply date and time in ISO 8601 time zone offset format, as in `YYYY-MM-DDThh:mm:ss.ssZ`.
`leadTime`	String	Optional time configuration for a SKU in a warehouse (handling time, fabrication, etc.). The format is `DD.HH:MM:SS`.

Orders List

Stream containing a list of all orders in your VTEX store.

Field	Type	Description
`orderId`	String	The order ID
`creationDate`	String	The date and time when the order was created
`clientName`	String	The name of the client
`totalValue`	Number	The total value of the order
`paymentNames`	String	The payment method names
`status`	String	The order status
`statusDescription`	String	The description of the order status
`marketPlaceOrderId`	String	The marketplace order ID
`sequence`	String	The order sequence number
`salesChannel`	String	The sales channel ID
`affiliateId`	String	The affiliate ID
`origin`	String	The origin of the order
`workflowInErrorState`	Boolean	Whether the workflow is in error state
`workflowInRetry`	Boolean	Whether the workflow is in retry state
`lastMessageUnread`	String	The last unread message
`shippingEstimatedDate`	String	The estimated shipping date
`ShippingEstimatedDateMax`	String	The maximum estimated shipping date
`ShippingEstimatedDateMin`	String	The minimum estimated shipping date
`orderIsComplete`	Boolean	Whether the order is complete
`listId`	String	The list ID
`listType`	String	The list type
`authorizedDate`	String	The date and time when the order was authorized
`callCenterOperatorName`	String	The name of the call center operator
`totalItems`	Integer	The total number of items in the order
`currencyCode`	String	The currency code

Order Details

Stream containing detailed information for each order.

Field	Type	Description
`orderId`	String	The unique identifier for the order.
`sequence`	String	The order’s sequence number.
`marketplaceOrderId`	String	The order ID from the marketplace.
`marketplaceServicesEndpoint`	String	The endpoint for marketplace services.
`sellerOrderId`	String	The seller’s unique identifier for the order.
`origin`	String	The origin of the order (e.g., `Marketplace`, `Fulfillment`).
`affiliateId`	String	The affiliate ID associated with the order.
`salesChannel`	String	The sales channel ID.
`merchantName`	String	The name of the merchant.
`status`	String	The current status of the order (e.g., `handling`, `shipped`).
`statusDescription`	String	A description of the current order status.
`value`	Number	The total value of the order.
`creationDate`	String	The timestamp when the order was created.
`lastChange`	String	The timestamp of the last modification to the order.
`orderGroup`	String	The order group ID.
`followUpEmail`	String	The follow-up email address.
`hostname`	String	The hostname where the order was placed.
`isCompleted`	Boolean	A boolean indicating if the order is completed.
`roundingError`	Number	The rounding error value.
`orderFormId`	String	The ID of the order form.
`allowCancellation`	Boolean	A boolean indicating if cancellation is allowed.
`allowEdition`	Boolean	A boolean indicating if editing is allowed.
`isCheckedIn`	Boolean	A boolean indicating if the order is checked in.
`authorizedDate`	String	The timestamp when the order was authorized.
`invoicedDate`	String	The timestamp when the order was invoiced.
`cancelReason`	String	The reason for cancellation.
`totals`	Array	An array of objects containing total values for the order (e.g., `Items`, `Shipping`).
`sellers`	Array	An array of objects detailing the sellers involved in the order.
`clientPreferencesData.locale`	String	The client’s locale (e.g., `en-US`).
`clientPreferencesData.optinNewsLetter`	Boolean	Indicates if the client opted into the newsletter.
`cancellationData.RequestedByUser`	Boolean	Indicates if cancellation was requested by the user.
`cancellationData.RequestedBySystem`	Boolean	Indicates if cancellation was requested by the system.
`cancellationData.Reason`	String	The reason for cancellation.
`cancellationData.CancellationDate`	String	The date of cancellation.
`marketplace.baseURL`	String	The base URL of the marketplace.
`marketplace.isCertified`	Boolean	Indicates if the marketplace is certified.
`marketplace.name`	String	The name of the marketplace.
`storePreferencesData.countryCode`	String	The country code of the store (e.g., `USA`).
`storePreferencesData.currencyCode`	String	The currency code of the store (e.g., `USD`).
`storePreferencesData.currencySymbol`	String	The currency symbol of the store (e.g., `$`).
`storePreferencesData.timeZone`	String	The time zone of the store.
`taxData.areTaxesDesignatedByMarketplace`	Boolean	Indicates if taxes are designated by the marketplace.
`taxData.taxInfoCollection`	Array	An array of tax information objects.
`subscriptionData.SubscriptionGroupId`	String	The ID of the subscription group.
`subscriptionData.Subscriptions`	Array	An array of subscription objects.
`itemMetadata.Items`	Array	An array of item metadata objects.
`invoiceData.address`	Object	Object containing the billing address.
`changesAttachment.id`	String	The ID of the changes attachment.
`changesAttachment.changesData`	Array	An array of objects detailing the changes.
`callCenterOperatorData.id`	String	The operator’s ID.
`callCenterOperatorData.email`	String	The operator’s email.
`callCenterOperatorData.userName`	String	The operator’s username.
`packageAttachment.packages`	Array	An array of package objects.
`shippingData.address`	Object	The shipping address.
`shippingData.logisticsInfo`	Array	An array of logistics information objects.
`clientProfileData.email`	String	The client’s email.
`clientProfileData.firstName`	String	The client’s first name.
`clientProfileData.lastName`	String	The client’s last name.
`clientProfileData.document`	String	The client’s document number.
`clientProfileData.phone`	String	The client’s phone number.
`clientProfileData.isCorporate`	Boolean	Indicates if the client is a corporate customer.
`clientProfileData.userProfileId`	String	The user profile ID.
`ratesAndBenefitsData.id`	String	The ID of the rates and benefits data.
`ratesAndBenefitsData.rateAndBenefitsIdentifiers`	Array	An array of rate and benefit identifiers.
`marketingData.utmSource`	String	The UTM source.
`marketingData.utmMedium`	String	The UTM medium.
`marketingData.utmCampaign`	String	The UTM campaign.
`marketingData.coupon`	String	The coupon code used.
`marketingData.marketingTags`	Array	An array of marketing tags.
`items`	Array	An array of objects, each representing an item in the order.
`paymentData.transactions`	Array	An array of transaction objects.

Product SKU IDs

Stream containing the mapping between products and their associated SKU IDs.

Field	Type	Description
`productId`	String	Product ID.
`skuIds`	Array	Array of SKU IDs associated with this product.

Products

Stream containing a list of all products in your catalog.

Field	Type	Description
`Id`	String	Product’s unique numerical identifier.
`Name`	String	Product’s name.
`DepartmentId`	String	Department ID according to the product’s category.
`CategoryId`	String	Category ID associated with this product.
`BrandId`	String	Brand ID associated with this product.
`LinkId`	String	Slug that will be used to build the product page URL.
`RefId`	String	Product Reference Code. The limit for the product RefId is 100 characters.
`IsVisible`	Boolean	Shows (true) or hides (false) the product in search result and product pages.
`Description`	String	Product description.
`DescriptionShort`	String	Short product description.
`ReleaseDate`	String	Used to assist in the ordering of the search result of the site.
`Title`	String	Product’s Title tag. Important for SEO.
`IsActive`	Boolean	Activate (true) or inactivate (false) product.
`TaxCode`	String	Product tax code, used for tax calculation.
`MetaTagDescription`	String	Brief description of the product for SEO.
`ShowWithoutStock`	Boolean	If true, activates the Notify Me option when the product is out of stock.
`Score`	Number	Value used to set the priority on the search result page.

Promotions

Stream containing a list of all promotions of your VTEX account.

Field	Type	Description
`idCalculatorConfiguration`	String	Promotion ID.
`lastModifiedUtc`	String	Date and time when the promotion was last modified (UTC).
`name`	String	Promotion Name.
`beginDate`	String	Promotion Begin Date (UTC).
`endDate`	String	Promotion End Date (UTC).
`isActive`	Boolean	If set as true the promotion is activated. If set as false the promotion is deactivated.
`description`	String	Promotion internal description.
`type`	String	Defines the type of promotion.
`utmSource`	String	The UTM source.
`utmCampain`	String	The UTM campaign.
`utmiCampaign`	String	The UTMI campaign.
`status`	String	Status of the promotion.
`percentualTax`	Number	Percentual tax applied.
`isArchived`	Boolean	If set as true the Promotion is archived. If set as false the Promotion is not archived.
`hasMaxPricePerItem`	Boolean	Defines if there is a maximum price per item.
`isTax`	Boolean	Defines if it is a tax.
`campaigns`	Array	Campaign Audiences that activate this promotion.
`activateGiftsMultiplier`	Boolean	If set as true, it activates gifts Multiplier.
`scope.maxUsage`	Integer	Defines how many times the promotion can be used.
`scope.idsSalesChannel`	Array	List of Trade Policies that activate this promotion.
`scope.areSalesChannelIdsExclusive`	Boolean	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 not to be applied.

SKU Details

Stream containing comprehensive details for individual SKUs, including dimensions, specifications, categories, and active status.

Field	Type	Description
`Id`	Integer	SKU unique identifier.
`ProductId`	Integer	ID of the product associated with this SKU.
`NameComplete`	String	Full display name of the SKU, combining product and SKU names.
`ComplementName`	String	SKU variation name, complementing the product name.
`ProductName`	String	Name of the product associated with this SKU.
`ProductDescription`	String	Description of the product associated with this SKU.
`ProductRefId`	String	Reference code of the product associated with this SKU.
`TaxCode`	String	Product tax code, used for tax calculation.
`SkuName`	String	SKU name, meaning the variation of the associated product.
`IsActive`	Boolean	Shows if the SKU is active (true) or not (false).
`IsTransported`	Boolean	Indicates if the SKU is transported.
`IsInventoried`	Boolean	Indicates if the SKU is inventoried.
`IsGiftCardRecharge`	Boolean	Indicates if the SKU is a gift card recharge.
`ImageUrl`	String	URL of the SKU’s main image.
`DetailUrl`	String	SKU page URL.
`CSCIdentification`	String	Identification used by the Shipping Carrier Configurator.
`BrandId`	String	ID of the brand associated with this SKU’s product.
`BrandName`	String	Name of the brand associated with this SKU’s product.
`IsBrandActive`	Boolean	Whether the associated brand is active.
`Dimension`	Object	SKU commercial dimensions.
`RealDimension`	Object	SKU real (actual) dimensions, if different from the commercial ones.
`ManufacturerCode`	String	Identifier used to identify the manufacturer’s product.
`IsKit`	Boolean	Defines whether the SKU is made up of one or more SKUs (part of a kit).
`KitItems`	Array	IDs of the SKUs that make up this kit, if any.
`Services`	Array	Services associated with this SKU.
`Categories`	Array	Category paths associated with this SKU’s product.
`Attachments`	Array	Attachments (customizations) associated with this SKU.
`Collections`	Array	Collections this SKU’s product belongs to.
`SkuSellers`	Array	Sellers offering this SKU.
`SalesChannels`	Array	Sales channel (trade policy) IDs this SKU is available in.
`Images`	Array	Images associated with this SKU.
`SkuSpecifications`	Array	SKU-level specifications (e.g. Color, Size).
`ProductSpecifications`	Array	Product-level specifications associated with this SKU.
`ProductClustersIds`	String	IDs of the product clusters this SKU’s product belongs to.
`ProductCategoryIds`	String	IDs of the categories this SKU’s product belongs to.
`IsDirectCategoryActive`	Boolean	Whether the product’s direct category is active.
`ProductGlobalCategoryId`	Integer	Google’s global category ID associated with this SKU’s product.
`ProductCategories`	String	Map of category ID to category name/path, as a JSON string.
`CommercialConditionId`	Integer	Commercial condition ID.
`RewardValue`	Number	Credit that the customer receives when finalizing an order that includes the SKU.
`AlternateIds`	Array	Alternate identifiers for this SKU.
`AlternateIdValues`	Array	Alternate identifier values for this SKU.
`EstimatedDateArrival`	String	SKU estimated arrival date.
`MeasurementUnit`	String	Measurement unit (e.g., “un”).
`UnitMultiplier`	Number	Multiple number of SKU for selling.
`InformationSource`	String	Source of the SKU information.
`ModalType`	String	Modal type for special transportation.

SKU Kits

Stream containing information about SKU kits - products that are composed of multiple other SKUs.

Field	Type	Description
`Id`	String	SKU kit ID.
`StockKeepingUnitParent`	String	Parent SKU ID (the kit itself).
`StockKeepingUnitId`	String	SKU ID of the kit component.
`Quantity`	Integer	Quantity of this component in the kit.
`UnitPrice`	Number	Price per unit of the component.

SKU Prices

Stream containing pricing information for all SKUs.

Field	Type	Description
`itemId`	String	SKU pricing ID.
`listPrice`	Number	SKU list price (the “from” price displayed to customers).
`costPrice`	Number	SKU cost price.
`basePrice`	Number	SKU base price (the actual selling price).
`markup`	Number	Price markup percentage.
`fixedPrices`	Array	Array of fixed prices for specific trade policies (contains `tradePolicyId`, `value`, `listPrice`, `minQuantity`).

SKUs

Stream containing detailed information about all SKUs (Stock Keeping Units) in your catalog. SKUs represent the actual sellable variations of products.

Field	Type	Description
`Id`	Integer	SKU unique identifier.
`ProductId`	Integer	ID of the product associated with this SKU.
`Name`	String	SKU name, representing the variation of the product.
`RefId`	String	Reference code used internally for organizational purposes.
`IsActive`	Boolean	Shows if the SKU is active (true) or not (false).
`IsKit`	Boolean	Defines whether the SKU is made up of one or more SKUs.
`Height`	Number	SKU height.
`Width`	Number	SKU width.
`Length`	Number	SKU length.
`RealHeight`	Number	Actual height if different from standard.
`RealWidth`	Number	Actual width if different from standard.
`RealLength`	Number	Actual length if different from standard.
`WeightKg`	Number	Weight of the SKU (default in grams).
`RealWeightKg`	Number	Actual weight if different from WeightKg.
`CubicWeight`	Number	Cubic weight.
`ModalId`	Integer	Identifier related to logistics and transportation.
`ManufacturerCode`	String	Identifier for the manufacturer’s product.
`MeasurementUnit`	String	Measurement unit (e.g., “un”).
`UnitMultiplier`	Number	Multiple number of SKU for selling.
`CommercialConditionId`	Integer	Commercial condition ID.
`RewardValue`	Number	Credit the customer receives when purchasing this SKU.
`DateUpdated`	String	Date and time when SKU was last updated.
`EstimatedDateArrival`	String	SKU estimated arrival date.
`ActivateIfPossible`	Boolean	Auto activate SKU if possible.
`Position`	Integer	Display position of the SKU.
`IsPersisted`	Boolean	Indicates if the SKU is persisted in the system.
`IsRemoved`	Boolean	Indicates if the SKU has been removed.
`sku_detail`	Object	Detailed information about the SKU, populated from the SKU Details endpoint if active.

Skills for agents

Download VTEX skills file

VTEX connector documentation as plain markdown, for use in AI agent contexts.

Documentation

Get started

Context

Activate

Workspace

Resources

VTEX as a data source

Configuring VTEX as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields

Skills for agents

Download VTEX skills file

​Configuring VTEX as a Source

​1. Add account access

​2. Select streams

​3. Configure data streams

​4. Configure data source

​5. Check your new source

​Streams and Fields

​Skills for agents

Download VTEX skills file

Configuring VTEX as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields

Skills for agents