How to Use the VTEX Checkout MCP in Claude

Q: How do I use VTEX Checkout with Claude Desktop for testing?

Run the getorderform tool first. This pulls all current cart details needed for any simulation. You can then pass those details into simulatepayment to validate payment methods against your test environment.

Q: Can Claude Desktop handle client profile changes and VTEX Checkout?

Yep, you can use the createaddress tool to update or add addresses. This ensures that when a customer finally checks out through VTEX Checkout, their shipping info is current.

Q: Does Claude Desktop help with coupon application for VTEX Checkout?

Absolutely. The addcoupon tool lets your agent apply specific discounts on the fly. It updates the cart total, giving you immediate feedback before the user proceeds to checkout.

Q: Which data does the MCP Server touch during VTEX Checkout? (Claude Desktop)

This server handles core e-commerce data: client profiles (getclientprofile), shipping addresses, and order contents/payment validation data. It doesn't touch payment credentials directly.

Q: How do I use the MCP Server to pre-validate an order for VTEX Checkout?

The best way is running simulateorder first. This function calculates both shipping costs and applies coupons using addcoupon, giving you a full, accurate cost breakdown.

Manage your e-commerce flows and customer data using Claude Desktop's local tool access.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect VTEX Checkout MCP to Claude Desktop

Create your Vinkius account to connect VTEX Checkout to Claude Desktop and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup VTEX Checkout with Claude Desktop

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Calculate Cart Costs with the MCP Server

You can simulate an entire order—including shipping and coupons—before a client hits 'buy.' Just run `simulate_order` to get real-time cost estimates. This prevents checkout surprises. Need to adjust pricing? The `add_coupon` tool lets you apply specific discounts, instantly updating the cart total so your agent can guide the user to the best final price.

Verify Customer Details with Claude Desktop

Before accepting an order, always check who's buying. Call `get_client_profile` to pull up existing customer details using their ID. You get name, email, and historical data right in the chat. If you need to add them or update their saved info, use `create_address`. It adds a new mailing address directly to the client's profile record.

Check Order Status with the MCP Server

Need specifics on what’s in the cart? Use `get_orderform` to fetch all items and quantities associated with a particular shopping session. This gives you the full picture, even if the user hasn't checked out yet. Finally, simulate the payment process using `simulate_payment`. It validates card details against VTEX guidelines without actually charging anything.

Setup guide

Set up VTEX Checkout MCP in Claude Web or Desktop

1

Open Claude Settings

Go to claude.ai, click your profile icon, then navigate to Customize → Connectors.
2

Add Custom Connector

Click the "+" button and select Add custom connector. Paste your Vinkius endpoint URL: https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. For OAuth-protected servers, expand Advanced settings to add credentials.
3

Start a conversation

Open a new chat. The VTEX Checkout MCP tools are available immediately — no restart needed.

Endpoint URL

https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp

No configuration file needed — paste the URL directly in the Claude web interface.

Available on Free (1 connector), Pro, Max, Team, and Enterprise plans.

Prerequisites

Claude Desktop installed (macOS or Windows)
Active Vinkius subscription with a valid endpoint token

1

Open Claude Desktop Settings

Click the menu icon at the top-left corner, go to Settings → Developer → Edit Config. This opens claude_desktop_config.json in your default text editor.
2

Paste the VTEX Checkout MCP configuration

Copy the JSON snippet on the right into the mcpServers object. Replace [YOUR_TOKEN_HERE] with your endpoint token from cloud.vinkius.com.
3

Restart Claude Desktop

Close and reopen the application. Claude needs a full restart to load new MCPs — refreshing a conversation is not enough.
4

Verify the connection

Open a new conversation. Click the 🔌 icon at the bottom of the message input. You should see tools listed under vtex-checkout-mcp.

json

{
  "mcpServers": {
    "vtex-checkout-mcp": {
      "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    }
  }
}

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by VTEX. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect VTEX Checkout now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about VTEX Checkout MCP in Claude Desktop

Run the `get_orderform` tool first. This pulls all current cart details needed for any simulation. You can then pass those details into `simulate_payment` to validate payment methods against your test environment.

Yep, you can use the `create_address` tool to update or add addresses. This ensures that when a customer finally checks out through VTEX Checkout, their shipping info is current.

Absolutely. The `add_coupon` tool lets your agent apply specific discounts on the fly. It updates the cart total, giving you immediate feedback before the user proceeds to checkout.

This server handles core e-commerce data: client profiles (`get_client_profile`), shipping addresses, and order contents/payment validation data. It doesn't touch payment credentials directly.

The best way is running `simulate_order` first. This function calculates both shipping costs and applies coupons using `add_coupon`, giving you a full, accurate cost breakdown.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript