VTEX

List products and create orders in your VTEX commerce platform.

E-commerceAPI key17 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (17)
create-brand
create-product
create-sku
create-sku-file
delete-brand
get-brand-by-id
custom_api_call
get-brand-list
get-category-by-id
get-client-by-id
get-client-list
get-order-by-id
get-order-list
get-product-by-id
get-sku-by-product-id
update-brand
Update-product
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("vtex", "create-brand", {
    "Name": "<name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("VTEX answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "vtex-create-brand",
  name: "VTEX: Create new Brand",
  description: "Calls VTEX when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("vtex", {
      "action": "create-brand",
      "Name": "<name>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/vtex/create-brand" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"Name":"<name>"}}'

Actions

create-brandin catalog

Create new Brand. Create a new Brand to your catalog

Input	Type	Description
`Name`required	text	Name
`SiteTitle`optional	text	Site Title
`LinkId`optional	text	Link ID
`Id`optional	number	Set the brand ID
`Text`optional	text	Text
`MenuHome`optional	boolean	Menu Home
`Keywords`optional	text	Similar words
`Active`optional	boolean	Active
`Score`optional	number	Score

create-productin catalog

Create New Product. Create a new product in your catalog

Input	Type	Description
`Name`required	text	Name
`Title`required	text	Title
`Description`required	text	Description
`BrandId`required	number	Brand ID
`CategoryId`required	number	Category ID
`LinkId`optional	text	Link ID
`RefId`optional	text	Ref ID
`Id`optional	number	Set the product ID
`IsVisible`optional	boolean	Is Visible
`DescriptionShort`optional	text	Short Description
`ReleaseDate`optional	text	Release Date
`KeyWords`optional	text	Similar words
`IsActive`optional	boolean	Is Active
`TaxCode`optional	text	Tax Code
`MetaTagDescription`optional	text	Metatag description
`ShowWithoutStock`optional	boolean	Show Without Stock
`Score`optional	number	Score

create-skuin catalog

Create New Sku. Create a new SKU to your catalog

Input	Type	Description
`ProductId`required	number	ID of the product to be associated with this SKU
`Name`required	text	Name the variation of the product
`PackagedHeight`required	number	Package Height
`PackagedLength`required	number	Package Length
`PackagedWidth`required	number	Package Width
`PackagedWeightKg`required	number	Package Weight (Kg)
`IsActive`optional	boolean	Is Active
`IsKit`optional	boolean	Is Kit
`Id`optional	number	Set the Sku ID

create-sku-filein catalog

Create New Sku File. Create a new SKU File to your catalog

Input	Type	Description
`SkuId`required	number	Set the Sku ID
`Url`required	text	Image Url
`Name`required	text	Image Name
`IsMain`required	boolean	Is Main Image
`Label`optional	text	Image Label
`Text`optional	text	General text of the image

delete-brandin catalog

Delete Brand. Delete a Brand in your catalog by it's id

Input	Type	Description
`brandId`required	number	The Brand ID

get-brand-by-idin catalog

Get Brand By ID. Find a Brand in your catalog by it's id

Input	Type	Description
`BrandId`required	number	The Brand ID

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

get-brand-list

Get Brand List. Find all Brands in your catalog

No input.

get-category-by-id

Get Category. Find a Category in your catalog by it's id

Input	Type	Description
`categoryId`optional	number	The Category ID

get-client-by-id

Get Client By ID. Find a Client by Id

Input	Type	Description
`clientId`required	number	The Client ID

get-client-list

Get Client List. Find all Clients

No input.

get-order-by-id

Get Order By ID. Find a Order by Id

Input	Type	Description
`OrderId`required	number	The Order ID

get-order-list

Get Orders List. Find Orders

Input	Type	Description
`fromYear`required	number	From (Year)
`toYear`required	text	To (Year)
`fromMonth`optional	text	From (Month)
`toMonth`optional	text	To (Month)
`fromDay`optional	text	From (Day)
`toDay`optional	text	To (Day)

get-product-by-id

Get Product By ID. Find a product in your catalog by it's id

Input	Type	Description
`productId`required	number	The product ID

get-sku-by-product-id

Get SKU By Product ID. Find a Sku in your catalog by a Product id

Input	Type	Description
`productId`required	number	The Product ID

update-brand

Update Brand. Update a Brand in your catalog

Input	Type	Description
`Id`required	number	Set the brand ID
`Name`required	text	Name
`SiteTitle`required	text	Site Title
`LinkId`required	text	Link ID
`Text`required	text	Text
`MenuHome`required	boolean	Menu Home
`Keywords`required	text	Similar words
`Active`required	boolean	Active
`Score`required	number	Score

Update-product

Update a Product. Update a product in your catalog

Input	Type	Description
`productId`required	number	Set the product ID
`Name`required	text	Name
`Title`required	text	Title
`Description`required	text	Description
`BrandId`required	number	Brand ID
`CategoryId`required	number	Category ID
`DepartmentId`required	number	DepartmentId
`LinkId`optional	text	Link ID
`RefId`optional	text	Ref ID
`BrandName`optional	text	Brand Name
`IsVisible`optional	boolean	Is Visible
`DescriptionShort`optional	text	Short Description
`ReleaseDate`optional	text	Release Date
`KeyWords`optional	text	Similar words
`IsActive`optional	boolean	Is Active
`TaxCode`optional	text	Tax Code
`MetaTagDescription`optional	text	Metatag description
`ShowWithoutStock`optional	boolean	Show Without Stock
`Score`optional	number	Score

Details

Id: vtex
Category: E-commerce
Tags: commerce, marketplace, orders, products
Package: @activepieces/piece-vtex@0.2.4
Tier: Community

VTEX

List products and create orders in your VTEX commerce platform.

E-commerceAPI key17 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (17)
create-brand
create-product
create-sku
create-sku-file
delete-brand
get-brand-by-id
custom_api_call
get-brand-list
get-category-by-id
get-client-by-id
get-client-list
get-order-by-id
get-order-list
get-product-by-id
get-sku-by-product-id
update-brand
Update-product
Details

Connect

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("vtex", "create-brand", {
    "Name": "<name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("VTEX answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "vtex-create-brand",
  name: "VTEX: Create new Brand",
  description: "Calls VTEX when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("vtex", {
      "action": "create-brand",
      "Name": "<name>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/vtex/create-brand" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"Name":"<name>"}}'

Actions

create-brandin catalog

Create new Brand. Create a new Brand to your catalog

Input	Type	Description
`Name`required	text	Name
`SiteTitle`optional	text	Site Title
`LinkId`optional	text	Link ID
`Id`optional	number	Set the brand ID
`Text`optional	text	Text
`MenuHome`optional	boolean	Menu Home
`Keywords`optional	text	Similar words
`Active`optional	boolean	Active
`Score`optional	number	Score

create-productin catalog

Create New Product. Create a new product in your catalog

Input	Type	Description
`Name`required	text	Name
`Title`required	text	Title
`Description`required	text	Description
`BrandId`required	number	Brand ID
`CategoryId`required	number	Category ID
`LinkId`optional	text	Link ID
`RefId`optional	text	Ref ID
`Id`optional	number	Set the product ID
`IsVisible`optional	boolean	Is Visible
`DescriptionShort`optional	text	Short Description
`ReleaseDate`optional	text	Release Date
`KeyWords`optional	text	Similar words
`IsActive`optional	boolean	Is Active
`TaxCode`optional	text	Tax Code
`MetaTagDescription`optional	text	Metatag description
`ShowWithoutStock`optional	boolean	Show Without Stock
`Score`optional	number	Score

create-skuin catalog

Create New Sku. Create a new SKU to your catalog

Input	Type	Description
`ProductId`required	number	ID of the product to be associated with this SKU
`Name`required	text	Name the variation of the product
`PackagedHeight`required	number	Package Height
`PackagedLength`required	number	Package Length
`PackagedWidth`required	number	Package Width
`PackagedWeightKg`required	number	Package Weight (Kg)
`IsActive`optional	boolean	Is Active
`IsKit`optional	boolean	Is Kit
`Id`optional	number	Set the Sku ID

create-sku-filein catalog

Create New Sku File. Create a new SKU File to your catalog

Input	Type	Description
`SkuId`required	number	Set the Sku ID
`Url`required	text	Image Url
`Name`required	text	Image Name
`IsMain`required	boolean	Is Main Image
`Label`optional	text	Image Label
`Text`optional	text	General text of the image

delete-brandin catalog

Delete Brand. Delete a Brand in your catalog by it's id

Input	Type	Description
`brandId`required	number	The Brand ID

get-brand-by-idin catalog

Get Brand By ID. Find a Brand in your catalog by it's id

Input	Type	Description
`BrandId`required	number	The Brand ID

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

get-brand-list

Get Brand List. Find all Brands in your catalog

No input.

get-category-by-id

Get Category. Find a Category in your catalog by it's id

Input	Type	Description
`categoryId`optional	number	The Category ID

get-client-by-id

Get Client By ID. Find a Client by Id

Input	Type	Description
`clientId`required	number	The Client ID

get-client-list

Get Client List. Find all Clients

No input.

get-order-by-id

Get Order By ID. Find a Order by Id

Input	Type	Description
`OrderId`required	number	The Order ID

get-order-list

Get Orders List. Find Orders

Input	Type	Description
`fromYear`required	number	From (Year)
`toYear`required	text	To (Year)
`fromMonth`optional	text	From (Month)
`toMonth`optional	text	To (Month)
`fromDay`optional	text	From (Day)
`toDay`optional	text	To (Day)

get-product-by-id

Get Product By ID. Find a product in your catalog by it's id

Input	Type	Description
`productId`required	number	The product ID

get-sku-by-product-id

Get SKU By Product ID. Find a Sku in your catalog by a Product id

Input	Type	Description
`productId`required	number	The Product ID

update-brand

Update Brand. Update a Brand in your catalog

Input	Type	Description
`Id`required	number	Set the brand ID
`Name`required	text	Name
`SiteTitle`required	text	Site Title
`LinkId`required	text	Link ID
`Text`required	text	Text
`MenuHome`required	boolean	Menu Home
`Keywords`required	text	Similar words
`Active`required	boolean	Active
`Score`required	number	Score

Update-product

Update a Product. Update a product in your catalog

Input	Type	Description
`productId`required	number	Set the product ID
`Name`required	text	Name
`Title`required	text	Title
`Description`required	text	Description
`BrandId`required	number	Brand ID
`CategoryId`required	number	Category ID
`DepartmentId`required	number	DepartmentId
`LinkId`optional	text	Link ID
`RefId`optional	text	Ref ID
`BrandName`optional	text	Brand Name
`IsVisible`optional	boolean	Is Visible
`DescriptionShort`optional	text	Short Description
`ReleaseDate`optional	text	Release Date
`KeyWords`optional	text	Similar words
`IsActive`optional	boolean	Is Active
`TaxCode`optional	text	Tax Code
`MetaTagDescription`optional	text	Metatag description
`ShowWithoutStock`optional	boolean	Show Without Stock
`Score`optional	number	Score

Details

Id: vtex
Category: E-commerce
Tags: commerce, marketplace, orders, products
Package: @activepieces/piece-vtex@0.2.4
Tier: Community