Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

VTEX

Unified commerce platform

CategoryCommerce
Authenticationcustom
Version0.3.0
Published scopes0 published scopes
Last updatedSeptember 24, 2026

Overview

Connect VTEX with Flows360

Unified commerce platform

Use the VTEX connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 17 actions and no declared triggers.

Available actions

  • Get Product By ID
  • Create New Product
  • Update a Product
  • Get Brand List
  • Get Brand By ID
  • Create new Brand
  • Update Brand
  • Delete Brand
  • Plus 9 additional declared actions.

Available triggers

  • No triggers are declared in this pinned package.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: VTEX
  • Package: @activepieces/piece-vtex@0.3.0
  • Exact artifact digest: sha256:ad0f43e1b1860ec303d5679d4af60a0159f92006a6d239b8c4a3bf42df00ac5d
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

CUSTOM AUTH. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Get Product By ID (get-product-by-id), Find a product in your catalog by it's id Classification: read.
  • Create New Product (create-product), Create a new product in your catalog Classification: read.
  • Update a Product (Update-product), Update a product in your catalog Classification: read.
  • Get Brand List (get-brand-list), Find all Brands in your catalog Classification: read.
  • Get Brand By ID (get-brand-by-id), Find a Brand in your catalog by it's id Classification: read.
  • Create new Brand (create-brand), Create a new Brand to your catalog Classification: read.
  • Update Brand (update-brand), Update a Brand in your catalog Classification: read.
  • Delete Brand (delete-brand), Delete a Brand in your catalog by it's id Classification: read.
  • Get Category (get-category-by-id), Find a Category in your catalog by it's id Classification: read.
  • Get SKU By Product ID (get-sku-by-product-id), Find a Sku in your catalog by a Product id Classification: read.
  • Create New Sku (create-sku), Create a new SKU to your catalog Classification: read.
  • Create New Sku File (create-sku-file), Create a new SKU File to your catalog Classification: read.
  • Get Client List (get-client-list), Find all Clients Classification: read.
  • Get Client By ID (get-client-by-id), Find a Client by Id Classification: read.
  • Get Order By ID (get-order-by-id), Find a Order by Id Classification: read.
  • Get Orders List (get-order-list), Find Orders Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • No trigger delivery contracts are declared.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects17
Supported actions17
TriggersNone published

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Host Url Required
  • App Key Required · protected credential
  • App Token Required · protected credential

Supported objects

ObjectReadWriteNotes
Get Product By ID Yes No Find a product in your catalog by it's id
Create New Product Yes No Create a new product in your catalog
Update a Product Yes No Update a product in your catalog
Get Brand List Yes No Find all Brands in your catalog
Get Brand By ID Yes No Find a Brand in your catalog by it's id
Create new Brand Yes No Create a new Brand to your catalog
Update Brand Yes No Update a Brand in your catalog
Delete Brand Yes No Delete a Brand in your catalog by it's id
Get Category Yes No Find a Category in your catalog by it's id
Get SKU By Product ID Yes No Find a Sku in your catalog by a Product id
Create New Sku Yes No Create a new SKU to your catalog
Create New Sku File Yes No Create a new SKU File to your catalog
Get Client List Yes No Find all Clients
Get Client By ID Yes No Find a Client by Id
Get Order By ID Yes No Find a Order by Id
Get Orders List Yes No Find Orders
Custom API Call Yes No Make a custom API call to a specific endpoint

Supported actions

Get Product By ID · Read

Find a product in your catalog by it's id

get_product_by_id · Risk: low · Retry: safe

Inputs

  • productId · number · Required, The product ID
Create New Product · Read

Create a new product in your catalog

create_product · Risk: low · Retry: safe

Inputs

  • Name · string · Required
  • Title · string · Required
  • Description · string · Required
  • BrandId · number · Required
  • CategoryId · number · Required
  • LinkId · string · Optional
  • RefId · string · Optional
  • Id · number · Optional, Set the product ID
  • IsVisible · boolean · Optional
  • DescriptionShort · string · Optional
  • ReleaseDate · string · Optional
  • KeyWords · string · Optional, Similar words
  • IsActive · boolean · Optional
  • TaxCode · string · Optional
  • MetaTagDescription · string · Optional
  • ShowWithoutStock · boolean · Optional
  • Score · number · Optional
Update a Product · Read

Update a product in your catalog

update_product · Risk: low · Retry: safe

Inputs

  • productId · number · Required, Set the product ID
  • Name · string · Required
  • Title · string · Required
  • Description · string · Required
  • BrandId · number · Required
  • CategoryId · number · Required
  • DepartmentId · number · Required
  • LinkId · string · Optional
  • RefId · string · Optional
  • BrandName · string · Optional
  • IsVisible · boolean · Optional
  • DescriptionShort · string · Optional
  • ReleaseDate · string · Optional
  • KeyWords · string · Optional, Similar words
  • IsActive · boolean · Optional
  • TaxCode · string · Optional
  • MetaTagDescription · string · Optional
  • ShowWithoutStock · boolean · Optional
  • Score · number · Optional
Get Brand List · Read

Find all Brands in your catalog

get_brand_list · Risk: low · Retry: safe

Get Brand By ID · Read

Find a Brand in your catalog by it's id

get_brand_by_id · Risk: low · Retry: safe

Inputs

  • BrandId · number · Required, The Brand ID
Create new Brand · Read

Create a new Brand to your catalog

create_brand · Risk: low · Retry: safe

Inputs

  • Name · string · Required
  • SiteTitle · string · Optional
  • LinkId · string · Optional
  • Id · number · Optional, Set the brand ID
  • Text · string · Optional
  • MenuHome · boolean · Optional
  • Keywords · string · Optional, Similar words
  • Active · boolean · Optional
  • Score · number · Optional
Update Brand · Read

Update a Brand in your catalog

update_brand · Risk: low · Retry: safe

Inputs

  • Id · number · Required, Set the brand ID
  • Name · string · Required
  • SiteTitle · string · Required
  • LinkId · string · Required
  • Text · string · Required
  • MenuHome · boolean · Required
  • Keywords · string · Required, Similar words
  • Active · boolean · Required
  • Score · number · Required
Delete Brand · Read

Delete a Brand in your catalog by it's id

delete_brand · Risk: low · Retry: safe

Inputs

  • brandId · number · Required, The Brand ID
Get Category · Read

Find a Category in your catalog by it's id

get_category_by_id · Risk: low · Retry: safe

Inputs

  • categoryId · number · Optional, The Category ID
Get SKU By Product ID · Read

Find a Sku in your catalog by a Product id

get_sku_by_product_id · Risk: low · Retry: safe

Inputs

  • productId · number · Required, The Product ID
Create New Sku · Read

Create a new SKU to your catalog

create_sku · Risk: low · Retry: safe

Inputs

  • ProductId · number · Required, ID of the product to be associated with this SKU
  • Name · string · Required, Name the variation of the product
  • PackagedHeight · number · Required
  • PackagedLength · number · Required
  • PackagedWidth · number · Required
  • PackagedWeightKg · number · Required
  • IsActive · boolean · Optional
  • IsKit · boolean · Optional
  • Id · number · Optional, Set the Sku ID
Create New Sku File · Read

Create a new SKU File to your catalog

create_sku_file · Risk: low · Retry: safe

Inputs

  • SkuId · number · Required, Set the Sku ID
  • Url · string · Required
  • Name · string · Required
  • IsMain · boolean · Required
  • Label · string · Optional
  • Text · string · Optional, General text of the image
Get Client List · Read

Find all Clients

get_client_list · Risk: low · Retry: safe

Get Client By ID · Read

Find a Client by Id

get_client_by_id · Risk: low · Retry: safe

Inputs

  • clientId · number · Required, The Client ID
Get Order By ID · Read

Find a Order by Id

get_order_by_id · Risk: low · Retry: safe

Inputs

  • OrderId · number · Required, The Order ID
Get Orders List · Read

Find Orders

get_order_list · Risk: low · Retry: safe

Inputs

  • fromYear · number · Required
  • toYear · string · Required
  • fromMonth · string · Optional
  • toMonth · string · Optional
  • fromDay · string · Optional
  • toDay · string · Optional
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Setup

Setup

  1. Add the VTEX connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • Host Url (hostUrl), required.
  • App Key (appKey), required; stored as a sensitive connection value.
  • App Token (appToken), required; stored as a sensitive connection value.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-vtex@0.3.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 17 actions and 0 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required VTEX connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-vtex@0.3.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com