← Tools Reference

VTEX

VTEX integration (Marketing, Data). Imported from open-connector.

API key5 toolshttps://{account_name}.{environment}.com.br
GET
vtex_list_product_and_sku_ids
Retrieve VTEX product IDs and their SKU IDs, optionally scoped by category and product ID range.

/api/catalog_system/pvt/products/GetProductAndSkuIds

3 parameters
ParamTypeRequiredDescription
categoryIdintegeroptionalVTEX category identifier.
fromintegeroptionalProduct ID that starts the VTEX product and SKU ID result range.
tointegeroptionalProduct ID that ends the VTEX product and SKU ID result range.
GET
vtex_get_product
Retrieve a VTEX Catalog product by its product ID.

/api/catalog/pvt/product/{productId}

1 parameter
ParamTypeRequiredDescription
productIdintegerrequiredVTEX product unique numerical identifier.
GET
vtex_list_brands
List brands registered in a VTEX store catalog.

/api/catalog_system/pvt/brand/list

GET
vtex_list_category_tree
Retrieve the VTEX store category tree up to a requested depth.

/api/catalog_system/pub/category/tree/{categoryLevels}

1 parameter
ParamTypeRequiredDescription
categoryLevelsintegerrequiredMaximum category level depth to retrieve.
GET
vtex_search_products
Search VTEX storefront products with full text, filter query expressions, sorting, and pagination.

/api/catalog_system/pub/products/search

5 parameters
ParamTypeRequiredDescription
fullTextstringoptionalFull-text product search term sent as the ft query parameter.
filterQueriesarrayoptionalVTEX fq filter expressions, such as C:/1000041/1000049/, productId:123, or skuI…
orderBystringoptionalVTEX product search sorting method.
fromintegeroptionalInitial zero-based item number for VTEX search pagination. VTEX requires this v…
tointegeroptionalFinal item number for VTEX search pagination. When from is also provided, to mu…