Skip to content
Start in the sandbox
All connectors
VTEX logo

VTEX

Commerce, marketplaces & inventory

Move VTEX orders, products and stock to the rest of your business without re-keying.

37 ways to read, 19 ways to write, each write switched on by you.

Try this in the sandboxBring us a workflow

Quality checks

Built and tested with example responses.

  1. Ready to connect: doneEvery listed action is built in.
  2. Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
VTEX with Nexra

Connected, approved, proven.

The things teams do most with VTEX, an example flow with a person in the loop, and what Nexra keeps as proof.

Top actions

  • Create brandbrands.createApproval by rule
  • Create categorycategories.createApproval by rule
  • List brandsbrands.listRead

Example flow

  1. VTEX · List brandsbrands.listDone
  2. VTEX · Create brandbrands.createMaker-checker
  3. Nexra · Record the decision and result in the evidence chainProven

Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches VTEX.

What gets logged

  • Whether it ran on its own or who approved it, and under which rule
  • A fingerprint of the exact request sent to VTEX
  • VTEX's reply: what it created or changed
  • One entry in the evidence chain, linked to the one before

Try this in the sandbox

Run the whole flow with test data in your sandbox, then connect your own account when you are ready to go live.

Try this in the sandboxBring us a workflow

For developers

Technical detail

VTEX orders and invoices, catalogue products, SKUs, brands, categories and specifications, pricing, inventory, warehouses, Master Data, promotions and subscriptions.

VTEX API docs
Source actions
37
Destination actions
19
Data types
22

What you can map

Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.

brands4
  • Create brandDestinationProvider duplicate protectionApproval before production

    Creates a brand with a numeric ID you choose.

  • Get brandSource

    One brand with SEO texts, menu flag and score.

  • List brandsSource

    Brands with activation, page title and meta description.

  • Update brandDestinationProvider duplicate protectionApproval before production

    Replaces a brand's name, texts, activation and slug.

categories4
  • Create categoryDestinationNot retried automaticallyApproval before production

    Creates a department or a category under a parent; unmapped flags default to visible.

  • Get categorySource

    One category with SEO texts, storefront flags and tree path.

  • List categoriesSource

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

  • Update categoryDestinationProvider duplicate protectionApproval before production

    Replaces a category's name, parent, texts and storefront flags.

category specifications1
  • List category specificationsSource

    Product and SKU specification fields defined for a category.

computed prices1
  • Get computed priceSource

    Selling and list price of a SKU in a price table or trade policy after price rules, before promotions and taxes.

customers5
  • Create customer profileDestinationNot retried automaticallyApproval before production

    Creates a CL customer profile document with consent and corporate fields.

  • Get customer profileSource

    One CL customer profile document by ID.

  • List CustomersSource

    List operation for Customers.

  • Search customer profilesSourceIncremental

    CL customer profiles by email or last update, oldest change first.

  • Upsert CustomersDestinationNexra idempotency keyApproval before production

    Upsert operation for Customers.

data entities1
  • List Master Data entitiesSource

    Master Data v1 data entities (acronym and name), such as CL and AD.

docks2
  • Get loading dockSource

    One loading dock with sales channels, shipping policies and address.

  • List loading docksSource

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

documents4
  • Create Master Data documentDestinationNot retried automaticallyApproval before production

    Creates a document in any data entity; VTEX assigns the ID.

  • Get Master Data documentSource

    One document of any data entity by ID, with the requested fields.

  • Search Master Data documentsSourceIncremental

    Documents of any data entity, optionally changed since a time or filtered on non-personal fields.

  • Update Master Data documentDestinationProvider duplicate protectionApproval before production

    Updates only the mapped fields of a document by ID (partial update).

fixed prices2
  • List fixed pricesSource

    Fixed prices of a SKU in one price table or trade policy, with quantity tiers and dates.

  • Set fixed pricesDestinationProvider duplicate protectionApproval before production

    Creates or replaces fixed prices (with optional quantity tiers and date ranges) for a SKU in a price table or trade policy.

inventory3
  • Get SKU inventory by warehouseSource

    Total, reserved and available quantity of one SKU in every warehouse.

  • List InventorySource

    List operation for Inventory.

  • Set SKU inventory in a warehouseDestinationProvider duplicate protectionApproval before production

    Sets the absolute quantity (or unlimited stock) and lead time of a SKU in a warehouse.

invoices2
  • Send order invoiceDestinationProvider duplicate protectionApproval before production

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

  • Send invoice trackingDestinationProvider duplicate protectionApproval before production

    Adds the tracking number, URL and carrier to an invoice already sent for an order.

orders4
  • Get orderSource

    One order with items, totals, customer profile, shipping address and invoices.

  • List OrdersSource

    List operation for Orders.

  • Search ordersSourceIncremental

    Order summaries filtered by creation date range and status, oldest first.

  • Start handling orderDestinationProvider duplicate protectionApproval before production

    Moves a ready-for-handling order to handling, as an ERP does when it accepts the order.

price tables1
  • List price tablesSource

    Price table names configured in the Pricing module.

prices3
  • Get SKU priceSource

    Cost, base, list price, markup and fixed prices of a SKU from the Pricing API.

  • List PricesSource

    List operation for Prices.

  • Upsert PricesDestinationNexra idempotency keyApproval before production

    Upsert operation for Prices.

product specifications2
  • List product specificationsSource

    Specification names and values of a product.

  • Set product specificationDestinationProvider duplicate protectionApproval before production

    Sets a product specification's values by field and group name, creating the field or values when they do not exist.

products4
  • Create productDestinationNot retried automaticallyApproval before production

    Creates a catalogue product in an existing category and brand.

  • Get productSource

    Catalogue product by ID with category, brand and visibility.

  • List ProductsSource

    List operation for Products.

  • Update productDestinationProvider duplicate protectionApproval before production

    Replaces a catalogue product's name, category, brand, texts, visibility and tax code.

promotions2
  • Get promotionSource

    One promotion with discount type and values.

  • List promotionsSource

    Promotions with type, activation, dates and campaign codes (read only).

sku specifications1
  • List SKU specificationsSource

    Specification field and value assignments of a SKU.

skus5
  • Create SKUDestinationProvider duplicate protectionApproval before production

    Creates an inactive SKU on a product with a unique reference code and shipping dimensions.

  • Get SKUSource

    SKU detail with product, reference code, dimensions and activation state.

  • List SKU IDsSource

    Every SKU ID in the catalogue, page by page; use skus.get for details.

  • List SKUs of a productSource

    Every SKU of a product with reference code, dimensions and update time.

  • Update SKUDestinationProvider duplicate protectionApproval before production

    Replaces a SKU's name, reference code, activation, dimensions and units.

subscription plans1
  • List subscription plansSource

    Subscription plans with frequencies and purchase day.

subscriptions2
  • Get subscriptionSource

    One subscription with plan, items and purchase settings.

  • List subscriptionsSource

    Subscriptions with status, plan, items and next purchase date (read only).

warehouses2
  • Get warehouseSource

    One warehouse with its docks, pickup points and priority.

  • List warehousesSource

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

Access and limits

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.
Pagination
page/per_page for orders (30-page cap), page/pagesize for SKU IDs, REST-Range resources=x-y for Master Data (10,000-document cap).
Provider events
Orders feed and hook for order status changes; Broadcaster for catalogue changes. Flows can start the moment something happens: when an order is ready for handling; when an order is invoiced; when an order is cancelled.

Before you build a flow

  • Customer upsert, verified price upsert and commerce reads implemented.
  • 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.
  • 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.
  • Intentionally excluded: order cancellation, return (Input) invoices, payment notifications, coupon and promotion writes, subscription changes, price table and pricing rule changes, warehouse and dock activation changes, and every delete.
  • products.update, skus.update and categories.update use VTEX PUT endpoints that replace the record; map every field you want to keep.
  • documents.create has no VTEX idempotency key; uncertain creates are not repeated automatically.
  • Promotions and subscriptions are read only. Subscription reads use the v3 Subscriptions API.

Developer reference

  1. Create the VTEX credentials described above with the narrowest permissions your flows need.
  2. In Nexra, open Connect, then Connections, then New connection, choose VTEX, enter its settings and credentials, and tick only the write actions you need. Connection guide
  3. Test the connection, then use its actions as flow sources and destinations. Flow guide
VTEX docsAPI referenceVTEX docsAuthenticationVTEX docsRate limitsVTEX docsWebhooks

Machine-readable detail: GET /api/public/connect/connectors/vtex and the Connections API.