VTEX Orders MCP connector

VTEX Orders is VTEX's order management API for tracking and processing ecommerce orders, including order details, feeds, hooks, and status changes. The VTEX Orders MCP connector allows AI agents to retrieve and update orders, manage order status and conversation history, and configure seller change windows. It also supports exporting order reports by status, monitoring order feeds, and registering changes to existing orders.

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 and automatically notify customers of shipping updates
• Export completed and in-progress orders for reporting and reconciliation
• Manage seller assignments and configure order routing rules
• Process invoices, tracking numbers, and payment notifications in real time
• Monitor order feeds and webhooks to trigger downstream fulfillment workflows
• Retrieve customer order history and details for support and analytics
• Register custom changes and add audit logs to order records

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 with a status of 'In Progress' in VTEX Orders.
• Export a report of completed orders from VTEX Orders for last week.
• Get the full details for order 12345 in VTEX Orders.
• Cancel order 67890 and register the cancellation reason in VTEX Orders.
• Add a tracking number to order 54321 in VTEX Orders.
• Retrieve all orders placed by customer john@example.com in VTEX Orders.
• Send a payment notification for order 11111 in VTEX Orders.
• Create a new feed configuration in VTEX Orders to monitor all order changes.
• Show me the conversation history for order 99999 in VTEX Orders.
• Get the current payment transaction details for order 44444 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	Retrieves the time window during which an order's seller can be changed.
UpdateWindowToChangeSeller	Modifies the time window for changing an order's seller.
StatusCompleted	Exports a report of orders with completed status.
StatusInProgress	Exports a report of orders currently in progress.
Getfeedorderstatus	Retrieves the status of order feed items.
ListOrders	Displays a list of orders based on specified filters.
GetOrder	Retrieves detailed information about a specific order.
CancelOrder	Cancels an existing order.
RegisterChange	Records a change made to an order.
GetConversation	Retrieves messages and interactions related to an order.
AddLog	Records a log entry for an order.
InvoiceNotification	Sends a notification about an order invoice.
Updatepartialinvoice_SendTrackingNumber	Updates a partial invoice and sends tracking information.
UpdateTrackingStatus	Updates the shipment tracking status of an order.
GetPaymenttransaction	Retrieves details about a payment transaction.
SendPaymentNotification	Sends a notification about a payment event.
StartHandling	Marks an order as starting to be processed.
Userorderslist	Retrieves all orders belonging to a specific customer.
Userorderdetails	Retrieves full details of a customer's specific order.
TestJSONataExpression	Tests a JSONata expression for validation and results.
Getfeedorderstatus1	Retrieves items from an order feed.
Commititemfeedorderstatus	Confirms and commits feed items to the system.
FeedConfigurationDelete	Removes an order feed configuration.
GetFeedConfiguration	Retrieves settings for an order feed.
FeedConfiguration	Creates or updates an order feed configuration.
DeleteHookConfiguration	Removes a webhook configuration.
GetHookConfiguration	Retrieves settings for a webhook.
HookConfiguration	Creates or updates a webhook configuration.