Connector guide9-minute read34 MCP tools7 languages

Connect VTEX to Claude via MCP: Orders and Stock

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

HCBy HelpCode teamUpdated 9 min read Open-source on GitHub

No credit card · 7-day trial · Self-host alternative available

VTEX

VTEX

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

tools

34

Region

INTL

Category

E-commerce

Authentication

API Key

Required env vars

VTEX_ACCOUNT_NAMEVTEX_ENVIRONMENTVTEX_APP_KEYVTEX_APP_TOKEN
Install in one click on Cloud

7-day free trial · No credit card

  • 7-day free trial
    No credit card required
  • GDPR & SOC 2 ready
    EU data residency, audit logs
  • Open-source on GitHub
    Open source · AGPL-3.0
  • Works with ChatGPT, Claude, Gemini
    Any MCP-compatible client

Summary

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

Guided setup

Connect VTEX to Claude in 2 minutes

Start a free trial on AnythingMCP Cloud, connect VTEX in the guided setup, then add your MCP URL to Claude. No code and no server to run.

No credit card · 7-day trial · Self-host alternative available

AnythingMCP is listed in Claude's connector directory: add it to Claude in one click (opens in a new tab), then sign in and choose which MCP servers Claude may use.

Try asking

Example prompts for VTEX

Click any prompt to copy it. Paste into Claude, ChatGPT, Cursor, Gemini, Copilot or OpenClaw to run it against this connector.

VTEX · live via MCP
Share
Opus 4.7

Claude is AI and can make mistakes. Please double-check responses.

💡 No install? Use cloud.anythingmcp.com directly. Sign in, click Connectors → VTEX, paste your credentials, mint an MCP API key and you're done. No Docker, no git clone, no local server.

VTEX + Claude

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

Prerequisites

See the full setup instructions baked into the connector (visible in the in-app store when you select the connector). The required environment variables for this connector are:

VTEX_ACCOUNT_NAME, VTEX_ENVIRONMENT, VTEX_APP_KEY, VTEX_APP_TOKEN

Step 1 — Get credentials

Setting up takes about 5 minutes.

  1. In the VTEX Admin open Account settings, Account, Security, API keys (older admins: Account settings, Account management, Application keys) and click Generate key. Give it a name.
  2. Assign roles to the key in Roles (License Manager): for read and write use the predefined roles OMS - Full access, Logistics full access, Catalog, Pricing and a Master Data role, or a custom role with the resources you need. A read-only key works for the read tools.
  3. Copy the App key into VTEX_APP_KEY and the App token into VTEX_APP_TOKEN (the token is shown only once).
  4. Enter the account name (the first part of https://<account>.myvtex.com) in VTEX_ACCOUNT_NAME and keep the environment vtexcommercestable.

The connector sends the key and token in the headers X-VTEX-API-AppKey and X-VTEX-API-AppToken on every call.

Where to start: vtex_list_orders (filter with f_status, for example ready-for-handling), then vtex_get_order for items, address and payment. For a product start at vtex_search_products or vtex_get_sku_by_ref_id, then vtex_get_sku, vtex_get_price and vtex_get_sku_inventory.

Orders: vtex_list_orders (no items in the list; at most 30 pages of up to 100, only the last two years), vtex_get_order, vtex_get_order_group, vtex_get_order_conversation, vtex_get_payment_transaction. Move a paid order on with vtex_start_handling_order, log a note with vtex_add_order_interaction and send delivery events with vtex_update_tracking_status. Three tools are installed switched off: vtex_cancel_order (cannot be undone, refunds a paid order), vtex_invoice_order (invoicing makes VTEX capture the payment and freezes the order) and vtex_update_invoice_tracking (changes an invoice). Money values in orders are integers in cents (totalValue 12990 is 129.90).

Catalog: vtex_list_product_and_sku_ids, vtex_get_product, vtex_get_product_by_ref_id, vtex_list_product_skus, vtex_get_sku, vtex_get_sku_by_ref_id, vtex_get_sku_by_ean, vtex_search_products (storefront search with live price and available quantity), vtex_get_category_tree, vtex_list_brands. Product and SKU ids are numbers; RefId is the merchant's own code.

Prices: vtex_get_price, vtex_get_computed_price, vtex_list_price_tables, vtex_update_price. Pricing values are decimals (49.9), unlike order values.

Stock and logistics: vtex_get_sku_inventory, vtex_update_sku_inventory (sets the total in one warehouse), vtex_list_warehouses, vtex_list_docks, vtex_list_shipping_policies.

Customers (Master Data v1): vtex_search_customers, vtex_get_customer, vtex_update_customer, and vtex_search_documents for any entity (AD holds addresses, linked by userId to the CL id). Searches return at most 100 rows per call, chosen with range_start and range_end; ask only for the fields you need, because a key without rights on a field gets 403 when _all is used.

Limits and pitfalls: VTEX allows about 6,000 order reads per minute per account and answers 429 when an API is overloaded. Dates in filters are UTC. A 403 means the key's role lacks the resource the call needs; a 404 on an order older than two years is expected.

Step 2 — Install the adapter

curl -fsSL https://raw.githubusercontent.com/HelpCode-ai/anythingmcp/main/docker-compose.quickstart.yml -o docker-compose.yml
printf 'JWT_SECRET=%s\nENCRYPTION_KEY=%s\n' "$(openssl rand -hex 32)" "$(openssl rand -hex 32)" > .env
docker compose up -d

Step 3 — Add the connector in Claude

Your server URL: in AnythingMCP, open MCP Servers → the server this connector is on, and copy its URL (https://cloud.anythingmcp.com/mcp/…). Use it wherever this guide shows YOUR_SERVER_ID.

Recommended path: works on claude.ai web without editing any config file.

  1. In Claude, open Plugins (still called Customize on some plans) → Connectors.
  2. Click + Add, then Add custom connector.
  3. Enter a name, e.g. VTEX, and the remote MCP server URL https://cloud.anythingmcp.com/mcp/YOUR_SERVER_ID, then click Continue, keep the detected settings and click Continue again.
  4. Choose Sign in now, click Add and sign in to AnythingMCP (OAuth) to allow access.

All tools below appear in your chat: start typing prompts.

Available tools

ToolWhat it does
vtex_list_ordersList orders of the last two years, newest first by default: orderId, creationDate, clientName, totalValue in cents, status and…
vtex_get_orderRead one order: status, value and totals in cents, items (SKU id, refId, name, quantity, price, sellingPrice), clientProfileData…
vtex_get_order_groupRead all orders of one checkout (an order group splits into one order per seller): the same fields as vtex_get_order for each order
vtex_start_handling_orderMove an order from ready-for-handling to handling, which tells VTEX the seller started to prepare it. VTEX answers 204 with no body…
vtex_add_order_interactionWrite a line into the order's interaction log (shown in the order's history in the admin), e.g. a note from the warehouse. Does not change…
vtex_get_order_conversationRead the email conversation of an order: messages VTEX and the store sent to the customer (subject, from, to, date, body)
vtex_get_payment_transactionRead the payment transaction of an order: transaction id, status, payments with method, value in cents, installments and the event history.…
vtex_update_tracking_statusSend tracking events to an invoice that already has a tracking number (isDelivered, deliveredDate and the list of events with city, state…
vtex_cancel_orderCancel an order that is not invoiced yet, with a reason. Cannot be undone; paid orders are refunded by VTEX. Installed switched off
vtex_invoice_orderSend the invoice of an order (type Output for a sale), which moves it to invoiced and makes VTEX settle (capture) the payment. invoiceValue…
vtex_update_invoice_trackingAdd a tracking number, tracking link, carrier and dispatch date to an existing invoice of an order. Changes the invoice; installed switched…
vtex_list_product_and_sku_idsList product ids with their SKU ids, optionally in one category: data maps each productId to its SKU ids, range.total gives the total. Page…
vtex_get_productRead one product: Id, Name, DepartmentId, CategoryId, BrandId, LinkId (URL slug), RefId, IsVisible, IsActive, Description, Title…
vtex_get_product_by_ref_idFind a product by its reference code (RefId) and read the same fields as vtex_get_product
vtex_list_product_skusList the SKUs of a product: Id, ProductId, IsActive, Name, RefId, EAN-related fields, dimensions, weight and measurement unit
vtex_get_skuRead one SKU with its context: Id, ProductId, NameComplete, ProductName, SkuName, AlternateIds (EAN, RefId), images, dimensions, sellers…
vtex_get_sku_by_ref_idFind a SKU by its reference code (RefId): Id, ProductId, IsActive, Name, RefId, dimensions and weight
vtex_get_sku_by_eanFind a SKU by its EAN barcode and read the same fields as vtex_get_sku
vtex_search_productsSearch the published catalog as the storefront does: productId, productName, brand, link, categories and items (SKUs) with sellers and…
vtex_get_category_treeRead the category tree down to the given depth: id, name, hasChildren, url and children for each category
vtex_list_brandsList all brands: id, name, isActive, title, metaTagDescription and imageUrl
vtex_get_priceRead the prices of a SKU from the Pricing API: itemId, listPrice, costPrice, markup, basePrice and fixedPrices per trade policy…
vtex_get_computed_priceRead the price a price table (trade policy) actually charges for a SKU after the pricing rules: tradePolicyId, listPrice, costPrice…
vtex_list_price_tablesList the price table ids of the account (for example 1 for the main trade policy, or names like gold)
vtex_update_priceCreate or update the base price of a SKU: give base_price alone (markup and cost are then derived), or cost_price with markup in percent…
vtex_get_sku_inventoryRead the stock of a SKU in every warehouse: warehouseId, warehouseName, totalQuantity, reservedQuantity, hasUnlimitedQuantity, timeToRefill…
vtex_update_sku_inventorySet the stock of a SKU in one warehouse: quantity replaces the total quantity (reservations are kept apart); unlimited_quantity true keeps…
vtex_list_warehousesList warehouses: id, name, warehouseDocks (dock ids with time and cost) and isActive
vtex_list_docksList loading docks: id, name, priority, dockTimeFake, salesChannels, freightTableIds and the pickup store info
vtex_list_shipping_policiesList shipping policies (carriers and freight tables): id, name, shippingMethod, isActive, deliveryOnWeekends, maxDimension and business…
vtex_search_customersSearch customer profiles (Master Data entity CL): email, firstName, lastName, document, phone, isCorporate, corporateName, createdIn and…
vtex_get_customerRead one customer profile (entity CL) by document id: the fields named in fields
vtex_update_customerChange fields of a customer profile (entity CL); only the fields given are changed, e.g. phone or isNewsletterOptIn
vtex_search_documentsSearch any Master Data v1 entity by its two-letter acronym, e.g. AD for customer addresses (filter on userId), or a custom entity: the…

Example prompts

  • "Which VTEX orders are ready for handling right now?"
  • "Show order 1478920512345-01 with its items, address and payment."
  • "What is the price and stock per warehouse of SKU ref TSHIRT-BLK-M?"
  • "Set the stock of SKU 2001 in warehouse 1_1 to 80."
  • "Which shipping policies and docks are active?"

FAQ

Does it work with Claude Code as well as Claude Desktop? Yes, point both at https://cloud.anythingmcp.com/mcp/YOUR_SERVER_ID.

Where do the app key and token come from? In the VTEX Admin under Account settings, Account, Security, API keys: generate a key, assign roles such as OMS, Logistics, Catalog and Pricing, and copy the app key and the app token (shown once).

What does it cover? Orders (OMS) with handling, interactions and tracking, catalog products and SKUs, storefront search, prices and price tables, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data.

Which tools install switched off? vtex_cancel_order, vtex_invoice_order and vtex_update_invoice_tracking, because they cancel or invoice orders for the customer. Switch them on on the connector page only if the AI should use them.

Next steps

Was this guide helpful?

Connect VTEX to Claude in 2 minutes

Start a free trial on AnythingMCP Cloud, connect VTEX in the guided setup, then add your MCP URL to Claude. No code and no server to run.

Related guides

Connectors

Connect VTEX to ChatGPT via MCP: Orders and Prices

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

Connectors

Connect VTEX to Microsoft Copilot via MCP

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

Connectors

Connect VTEX to Cursor via MCP: Products and Stock

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

Connectors

Connect VTEX to Gemini CLI via MCP: Orders and Stock

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

Connectors

Connect VTEX to Meta Muse via MCP: Orders and Stock

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.

Connectors

VTEX MCP Server: Orders, Products and Inventory

VTEX commerce platform: orders (OMS) with handling and tracking, catalog products and SKUs, storefront search, prices, inventory per warehouse, docks and shipping policies, and customer profiles in Master Data. App key and app token.