VTEX

VTEX order detail and search, invoice notification, catalogue products, SKUs and categories, inventory by warehouse, warehouses, docks and CL customers.

Connect customer and commerce data to your business systems.

Build a flow with VTEX Provider API documentation

Source actions

Destination actions

Data types

Validation status

Implemented · fixture tested.

Implementation is checked against provider-shaped fixtures for every action, authentication failures, rate limits, pagination and duplicate safety. Provider sandbox and authorised account validation are recorded separately when credential-backed runs are completed.

What you can map

categories

List categories
Source
Category tree flattened with parent IDs, up to the requested depth.

customers

Create customer profile
Destination
Not retried automatically
Creates a CL customer profile document with consent and corporate fields.
Get customer profile
Source
One CL customer profile document by ID.
List Customers
Source
List operation for Customers.
Search customer profiles
Source
Incremental
CL customer profiles by email or last update, oldest change first.
Upsert Customers
Destination
Duplicate protected
Upsert operation for Customers.

docks

List loading docks
Source
Loading docks with sales channels, priority, address and shipping rate providers.

inventory

Get SKU inventory by warehouse
Source
Total, reserved and available quantity of one SKU in every warehouse.
List Inventory
Source
List operation for Inventory.
Set SKU inventory in a warehouse
Destination
Duplicate protected
Sets the absolute quantity (or unlimited stock) and lead time of a SKU in a warehouse.

invoices

Send order invoice
Destination
Duplicate protected
Notifies VTEX of a selling invoice for an order (full or partial), moving it towards invoiced.

orders

Get order
Source
One order with items, totals, customer profile, shipping address and invoices.
List Orders
Source
List operation for Orders.
Search orders
Source
Incremental
Order summaries filtered by creation date range and status, oldest first.
Start handling order
Destination
Duplicate protected
Moves a ready-for-handling order to handling, as an ERP does when it accepts the order.

prices

List Prices
Source
List operation for Prices.
Upsert Prices
Destination
Duplicate protected
Upsert operation for Prices.

products

Create product
Destination
Not retried automatically
Creates a catalogue product in an existing category and brand.
Get product
Source
Catalogue product by ID with category, brand and visibility.
List Products
Source
List operation for Products.

skus

Create SKU
Destination
Duplicate protected
Creates an inactive SKU on a product with a unique reference code and shipping dimensions.
Get SKU
Source
SKU detail with product, reference code, dimensions and activation state.
List SKU IDs
Source
Every SKU ID in the catalogue, page by page; use skus.get for details.
List SKUs of a product
Source
Every SKU of a product with reference code, dimensions and update time.

warehouses

List warehouses
Source
Warehouses with their docks, pickup points, priority and active state.

Authentication

App key and app token

Plans and access

All VTEX accounts. The app key's License Manager role controls access: OMS, Catalog, Logistics and Dynamic Storage (Master Data) resources.

Test environment

Use a VTEX development or sandbox account provided by VTEX or your agency.

Rate limits

Per-route limits by API; HTTP 429 with Retry-After. Inventory updates for the same SKU and warehouse within milliseconds return 423 Locked.

Provider events

Orders feed and hook for order status changes; Broadcaster for catalogue changes. Nexra event triggers are not yet available; flows run on demand or on a schedule.

Before you build a flow

Customer upsert, verified price upsert and commerce reads implemented. Credential-backed validation is pending.
Order search uses the OMS list endpoint, which VTEX indexes with about a four-minute delay and caps at 30 pages; VTEX recommends the orders feed for integrations.
Order search filters by creation date; VTEX does not document a last-change filter on the list endpoint.
Only selling (Output) invoices are sent; return (Input) invoices, which trigger refunds, are not implemented.
Pricing API operations beyond the built-in price read and upsert are not added: VTEX documents the Pricing API on api.vtex.com/{accountName}, and the recipe runtime only calls the account host.
Product and customer document creation have no VTEX idempotency key; uncertain creates are not repeated automatically.
Master Data search returns at most 10,000 documents per query.