VTEX Orders (PII version) MCP connector

VTEX Orders (PII version) is VTEX's order management API that handles orders containing personally identifiable customer information. The VTEX Orders (PII version) MCP connector allows AI agents to retrieve order details, start and cancel order handling, and send invoice and payment notifications. It also supports accessing order feeds and managing order hooks to track order lifecycle events across your VTEX store.

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 (PII version) MCP connector to perform the following actions:

• Retrieve complete order details including customer information and line items from VTEX
• Cancel orders in bulk and track cancellation status across multiple transactions
• Notify customers automatically when invoices generate or update in VTEX
• Send payment confirmation notifications to customers through VTEX workflows
• Monitor order feeds to trigger automated actions based on order status changes
• Start order fulfillment workflows immediately after payment confirmation
• Track orders with personally identifiable information securely within compliance boundaries

Example prompts

Use the following example prompts to invoke VTEX Orders (PII version) MCP connector tools from your AI assistant or Boomi Connect workflow:

• Show me all orders from the last 30 days in VTEX Orders (PII version).
• Get the full details for order number 12345 including customer information.
• Cancel order 67890 and notify the customer in VTEX Orders (PII version).
• List all pending orders that need to be moved to fulfillment status.
• Send an invoice notification for order 11111 in VTEX Orders (PII version).
• Show me orders with payment issues that need follow-up notifications.
• Retrieve all orders from a specific customer by their email address.
• Start handling for order 54321 and mark it ready for shipment in VTEX.
• Send payment confirmations for all orders completed yesterday.
• Display orders currently in the order feed waiting for processing.

VTEX Orders (PII version) MCP connector tools

The VTEX Orders (PII version) MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.

Tool	Description
ListOrders2	Retrieves a list of orders with filtering and pagination options.
GetOrder2	Retrieves detailed information for a specific order.
StartHandling2	Marks an order as being processed or handled.
CancelOrder2	Cancels a specified order and updates its status.
InvoiceNotification2	Sends an invoice notification for a completed order.
SendPaymentNotification2	Sends a payment confirmation notification for an order.