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 Pydantic AI 6 tools — connect in under 2 minutes

Name: VTEX Orders
Availability: InStock
Author: Vinkius

ai.pydantic.dev/mcp

Built by Vinkius GDPR 6 Tools SDK

Pydantic AI brings type-safe agent development to Python with first-class MCP support. Connect VTEX Orders through the Vinkius and every tool is automatically validated against Pydantic schemas — catch errors at build time, not in production.

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.

python

import asyncio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerHTTP

async def main():
    # Your Vinkius token — get it at cloud.vinkius.com
    server = MCPServerHTTP(url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")

    agent = Agent(
        model="openai:gpt-4o",
        mcp_servers=[server],
        system_prompt=(
            "You are an assistant with access to VTEX Orders "
            "(6 tools)."
        ),
    )

    result = await agent.run(
        "What tools are available in VTEX Orders?"
    )
    print(result.data)

asyncio.run(main())

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.

Pydantic AI validates every VTEX Orders tool response against typed schemas, catching data inconsistencies at build time. Connect 6 tools through the Vinkius and switch between OpenAI, Anthropic, or Gemini without changing your integration code — full type safety, structured output guarantees, and dependency injection for testable agents.

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 Pydantic AI 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 Pydantic AI via MCP

Follow these steps to integrate the VTEX Orders MCP Server with Pydantic AI.

Install Pydantic AI

Run pip install pydantic-ai

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token

Run the agent

Save to agent.py and run: python agent.py

Explore tools

The agent discovers 6 tools from VTEX Orders with type-safe schemas

Why Use Pydantic AI with the VTEX Orders MCP Server

Pydantic AI provides unique advantages when paired with VTEX Orders through the Model Context Protocol.

Full type safety: every MCP tool response is validated against Pydantic models, catching data inconsistencies before they reach your application

Model-agnostic architecture — switch between OpenAI, Anthropic, or Gemini without changing your VTEX Orders integration code

Structured output guarantee: Pydantic AI ensures tool results conform to defined schemas, eliminating runtime type errors

Dependency injection system cleanly separates your VTEX Orders connection logic from agent behavior for testable, maintainable code

VTEX Orders + Pydantic AI Use Cases

Practical scenarios where Pydantic AI combined with the VTEX Orders MCP Server delivers measurable value.

Type-safe data pipelines: query VTEX Orders with guaranteed response schemas, feeding validated data into downstream processing

API orchestration: chain multiple VTEX Orders tool calls with Pydantic validation at each step to ensure data integrity end-to-end

Production monitoring: build validated alert agents that query VTEX Orders and output structured, schema-compliant notifications

Testing and QA: use Pydantic AI's dependency injection to mock VTEX Orders responses and write comprehensive agent tests

VTEX Orders MCP Tools for Pydantic AI (6)

These 6 tools become available when you connect VTEX Orders to Pydantic AI 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 Pydantic AI

Ready-to-use prompts you can give your Pydantic AI 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 Pydantic AI

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

MCPServerHTTP not found

Update: pip install --upgrade pydantic-ai

VTEX Orders + Pydantic AI FAQ

Common questions about integrating VTEX Orders MCP Server with Pydantic AI.

How does Pydantic AI discover MCP tools?

Create an MCPServerHTTP instance with the server URL. Pydantic AI connects, discovers all tools, and generates typed Python interfaces automatically.

Does Pydantic AI validate MCP tool responses?

Yes. When you define result types as Pydantic models, every tool response is validated against the schema. Invalid data raises a clear error instead of silently corrupting your pipeline.

Can I switch LLM providers without changing MCP code?

Absolutely. Pydantic AI abstracts the model layer — your VTEX Orders MCP integration works identically with OpenAI, Anthropic, Google, or any supported provider.