VTEX Orders MCP connector
Updated
VTEX Orders is VTEX's commerce API for managing order lifecycles across an online store. The VTEX Orders MCP connector allows AI agents to look up order details, monitor order status feeds, and register changes such as cancellations or seller reassignments. It also supports exporting order reports, retrieving customer conversations, and managing hooks that track order status changes in real time.
Authentication type
- API Key - Requires a static API key to be configured before the agent can connect to the service.
Uses
Use the VTEX Orders MCP connector to perform the following actions:
- Track order status changes from placement through delivery in real time
- Cancel orders directly without navigating the VTEX admin console
- Notify customers automatically when invoices and tracking numbers get updated
- Export completed and in-progress order reports for reconciliation and analysis
- Sync payment and invoice notifications between VTEX and other business systems
- Configure feeds and hooks to automate order event handling
- Retrieve customer order history and conversation threads for support teams
- Update seller change windows to manage marketplace order handoffs
Example prompts
Use the following example prompts to invoke VTEX Orders MCP connector tools from your AI assistant or Boomi Connect workflow:
Show me all orders that are still in progress in VTEX Orders.Cancel order 123456 in VTEX Orders.What's the status of order 987654 in VTEX Orders?Export a report of all completed orders from last week in VTEX Orders.Send a tracking number update for order 456789 in VTEX Orders.Show me the conversation history for order 112233 in VTEX Orders.Notify the customer that their invoice is ready for order 998877 in VTEX Orders.List all orders placed by customer jane.doe@email.com in VTEX Orders.Set up a hook to notify us when orders change status in VTEX Orders.Check the payment transaction details for order 334455 in VTEX Orders.
VTEX Orders MCP connector tools
The VTEX Orders MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.
| Tool | Description |
|---|---|
| GetWindowToChangeSeller | Get window to change seller |
| UpdateWindowToChangeSeller | Update window to change seller |
| StatusCompleted | Export order report with status 'Completed' |
| StatusInProgress | Export order report with status 'In Progress' |
| Getfeedorderstatus | Get feed order status |
| ListOrders | List orders |
| GetOrder | Get order |
| CancelOrder | Cancel order |
| RegisterChange | Register change on order |
| GetConversation | Retrieve order conversation |
| AddLog | Add log in orders |
| InvoiceNotification | Order invoice notification |
| Updatepartialinvoice_SendTrackingNumber | Update order's partial invoice (send tracking number) |
| UpdateTrackingStatus | Update order tracking status |
| GetPaymenttransaction | Retrieve payment transaction |
| SendPaymentNotification | Send payment notification |
| StartHandling | Start handling order |
| Userorderslist | Retrieve user's orders |
| Userorderdetails | Retrieve user order details |
| TestJSONataExpression | Test JSONata expression |
| Getfeedorderstatus1 | Retrieve feed items |
| Commititemfeedorderstatus | Commit feed items |
| FeedConfigurationDelete | Delete feed configuration |
| GetFeedConfiguration | Get feed configuration |
| FeedConfiguration | Create or update feed configuration |
| DeleteHookConfiguration | Delete hook configuration |
| GetHookConfiguration | Get hook configuration |
| HookConfiguration | Create or update hook configuration |
