How do I get my VTEX API credentials?

Log in to your VTEX Admin, go to **Account Settings → Application Keys**, and create a new App Key. You'll receive an App Key and App Token pair. You also need your Account Name (the subdomain you use to access the VTEX Admin, e.g., 'mystore'). Ensure the key has **OMS** read/write permissions. No code, no SDK — just connect and go.

Can my agent register an invoice and tracking number at the same time?

Yes! The 'register_invoice' tool accepts the invoice number and an optional tracking number in one call. Once submitted, the order automatically moves to 'Invoiced' status — eliminating the manual step of navigating to the VTEX Admin, opening the order detail, and filling each field separately.

How does the agent handle order cancellations with refunds?

Just tell your agent to cancel the order. It uses the 'cancel_order' tool with an optional reason (so your team has an audit trail). VTEX then handles the refund automatically based on the payment method. No tab-switching, no admin navigation — your support team resolves it in one conversation.

Can I monitor fulfillment status across hundreds of orders?

Absolutely. The 'search_orders' tool supports status filters and pagination, so your agent can scan the entire order queue — for example, listing all orders stuck in 'ready-for-handling' to identify fulfillment delays. Perfect for operations teams managing high-volume VTEX stores with multiple sellers.

VTEX Orders MCP Server for Claude Code 6 tools — connect in under 2 minutes

Name: VTEX Orders
Availability: InStock
Author: Vinkius

docs.anthropic.com/en/docs/claude-code

Built by Vinkius GDPR 6 Tools CLI

Claude Code is Anthropic's agentic CLI for terminal-first development. Add VTEX Orders as an MCP server in one command and Claude Code will discover every tool at runtime. ideal for automation pipelines, CI/CD integration, and headless workflows via Vinkius.

Get MCP Server for AI Agents

ASK AI ABOUT THIS MCP SERVER

Open in ChatGPT Open in Claude Open in Perplexity

Vinkius supports streamable HTTP and SSE.

RecommendedModern Approach — Zero Configuration

Vinkius Desktop App

The modern way to manage MCP Servers — no config files, no terminal commands. Install VTEX Orders and 2,500+ MCP Servers from a single visual interface.

Download Free Open SourceNo signup required

Classic Setup·bash

# Your Vinkius token. get it at cloud.vinkius.com
claude mcp add vtex-orders --transport http "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"

Fully ManagedVinkius Servers

60%Token savings

High SecurityEnterprise-grade

IAMAccess control

EU AI ActCompliant

DLPData protection

V8 IsolateSandboxed

Ed25519Audit chain

<40msKill switch

Stream every event to Splunk, Datadog, or your own webhook in real-time

* Every MCP server runs on Vinkius-managed infrastructure inside AWS - a purpose-built runtime with per-request V8 isolates, Ed25519 signed audit chains, and sub-40ms cold starts optimized for native MCP execution. See our infrastructure

About VTEX Orders MCP Server

Connect your VTEX Order Management System (OMS) to any AI agent and take full control of your store's order lifecycle through natural conversation.

Claude Code registers VTEX Orders as an MCP server in a single terminal command. Once connected, Claude Code discovers all 6 tools at runtime and can call them headlessly. ideal for CI/CD pipelines, cron jobs, and automated workflows where VTEX Orders data drives decisions without human intervention.

What you can do

Order Lookup — Retrieve the full details of any order by ID, including items, client profile, payment method, logistics, and current status.
Order Search — Search and filter orders by status (e.g., 'ready-for-handling', 'invoiced', 'canceled') with built-in pagination for large result sets.
Status Updates — Advance orders through the fulfillment pipeline by updating their status (e.g., move from 'ready-for-handling' to 'handling').
Shipment Tracking — Retrieve tracking information for shipped packages, including carrier, tracking number, and tracking URL.
Invoice Registration — Attach tax invoices (NF-e) and tracking numbers to orders, automatically moving them to 'Invoiced' status.
Order Cancellation — Cancel orders with an optional reason, triggering automatic refund processing.

The VTEX Orders MCP Server exposes 6 tools through the Vinkius. Connect it to Claude Code in under two minutes — no API keys to rotate, no infrastructure to provision, no vendor lock-in. Your configuration, your data, your control.

How to Connect VTEX Orders to Claude Code via MCP

Follow these steps to integrate the VTEX Orders MCP Server with Claude Code.

Install Claude Code

Run npm install -g @anthropic-ai/claude-code if not already installed

Add the MCP Server

Run the command above in your terminal

Verify the connection

Run claude mcp to list connected servers, or type /mcp inside a session

Start using VTEX Orders

Ask Claude: "Using VTEX Orders, show me...". 6 tools are ready

Why Use Claude Code with the VTEX Orders MCP Server

Claude Code provides unique advantages when paired with VTEX Orders through the Model Context Protocol.

Single-command setup: `claude mcp add` registers the server instantly. no config files to edit or applications to restart

Terminal-native workflow means MCP tools integrate seamlessly into shell scripts, CI/CD pipelines, and automated DevOps tasks

Claude Code runs headlessly, enabling unattended batch processing using VTEX Orders tools in cron jobs or deployment scripts

Built by the same team that created the MCP protocol, ensuring first-class compatibility and the fastest adoption of new protocol features

VTEX Orders + Claude Code Use Cases

Practical scenarios where Claude Code combined with the VTEX Orders MCP Server delivers measurable value.

CI/CD integration: embed VTEX Orders tool calls in your deployment pipeline to validate configurations or fetch secrets before shipping

Headless batch processing: schedule Claude Code to query VTEX Orders nightly and generate reports without human intervention

Shell scripting: pipe VTEX Orders outputs into other CLI tools for data transformation, filtering, and aggregation

Infrastructure monitoring: run Claude Code in a cron job to query VTEX Orders status endpoints and alert on anomalies

VTEX Orders MCP Tools for Claude Code (6)

These 6 tools become available when you connect VTEX Orders to Claude Code via MCP:

cancel_order

Cancel an order

get_order

Get full details of a specific order

get_tracking_info

Get tracking info for an order package

register_invoice

search_orders

g., "ready-for-handling"). Search for orders by status or pagination

update_order_status

Update the status of an order

Example Prompts for VTEX Orders in Claude Code

Ready-to-use prompts you can give your Claude Code agent to start working with VTEX Orders immediately.

"Show me the details of order v-1234567890"

"List all orders with status 'ready-for-handling'"

"Cancel order v-444 — customer requested wrong size"

Troubleshooting VTEX Orders MCP Server with Claude Code

Common issues when connecting VTEX Orders to Claude Code through the Vinkius, and how to resolve them.

Command not found: claude

Ensure Claude Code is installed globally: npm install -g @anthropic-ai/claude-code

Connection timeout

Check your internet connection and verify the Edge URL is reachable

VTEX Orders + Claude Code FAQ

Common questions about integrating VTEX Orders MCP Server with Claude Code.

How do I add an MCP server to Claude Code?

Run claude mcp add --transport http "" in your terminal. Claude Code registers the server and discovers all tools immediately.

Can Claude Code run MCP tools in headless mode?

Yes. Claude Code supports non-interactive execution, making it ideal for scripts, cron jobs, and CI/CD pipelines that need MCP tool access.

How do I list all connected MCP servers?

Run claude mcp in your terminal to see all registered servers and their status, or type /mcp inside an active Claude Code session.

Connect VTEX Orders with your favorite client

Step-by-step setup guides for every MCP-compatible client and framework:

Claude DesktopIDE

Anthropic's native desktop app for Claude with built-in MCP support.

CursorIDE

AI-first code editor with integrated LLM-powered coding assistance.

VS Code CopilotIDE

GitHub Copilot in VS Code with Agent mode and MCP support.

WindsurfIDE

Purpose-built IDE for agentic AI coding workflows.

ClineIDE

Autonomous AI coding agent that runs inside VS Code.

Claude CodeCLI

Anthropic's agentic CLI for terminal-first development.

OpenAI Agents SDKSDK

Python SDK for building production-grade OpenAI agent workflows.

Google ADKSDK

Google's framework for building production AI agents.

Pydantic AISDK

Type-safe agent development for Python with first-class MCP support.

Vercel AI SDKSDK

TypeScript toolkit for building AI-powered web applications.

Mastra AISDK

TypeScript-native agent framework for modern web stacks.

CrewAIFramework

Python framework for orchestrating collaborative AI agent crews.

LangChainFramework

Leading Python framework for composable LLM applications.

LlamaIndexFramework

Data-aware AI agent framework for structured and unstructured sources.

AutoGenFramework

Microsoft's framework for multi-agent collaborative conversations.

Connect VTEX Orders to Claude Code

Get your token, paste the configuration, and start using 6 tools in under 2 minutes. No API key management needed.

Get MCP Server for AI Agents