VTEX Checkout MCP connector
VTEX Checkout is VTEX's API for managing shopping carts, order placement, and checkout configuration on the VTEX commerce platform. The VTEX Checkout MCP connector allows AI agents to create and retrieve carts, process orders, and add client profiles, preferences, and marketing data to a checkout session. It also supports configuring payment data, shipping addresses and delivery options, merchant context data, and coupons throughout the checkout flow.
Authentication type
- API Key - Requires a static API key to be configured before the agent can connect to the service.
Uses
Use the VTEX Checkout MCP connector to perform the following actions:
- Create and manage shopping carts from start to checkout completion
- Apply coupons, custom fields, and pricing adjustments to active carts
- Capture client profiles, preferences, and marketing data during checkout
- Configure shipping addresses, delivery options, and pickup points for orders
- Process and place orders directly from existing shopping carts
- Simulate cart totals and installment options before finalizing purchases
- Retrieve postal code addresses and regional seller availability
- Adjust orderForm configuration and clear checkout messages as needed
Example prompts
Use the following example prompts to invoke VTEX Checkout MCP connector tools from your AI assistant or Boomi Connect workflow:
Create a new shopping cart in VTEX Checkout for this customer.Add these three items to the current cart in VTEX Checkout.Apply the SUMMER20 coupon code to this VTEX Checkout cart.Show me the installment options for this VTEX Checkout order.Update the shipping address on this VTEX Checkout cart.Place the order from cart ID 12345 in VTEX Checkout.Find the nearest pickup points for this delivery address in VTEX Checkout.Look up the client profile linked to this email in VTEX Checkout.Change the price of this item in the VTEX Checkout cart.Get the address details for this postal code using VTEX Checkout.
VTEX Checkout MCP connector tools
The VTEX Checkout MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.
| Tool | Description |
|---|---|
| ProcessOrder | Process order |
| CreateANewCart | Get current or create a new cart |
| GetCartInformationById | Get cart information by ID |
| AddClientPreferences | Add client preferences |
| AddClientProfile | Add client profile |
| AddMarketingData | Add marketing data |
| AddMerchantContextData | Add merchant context data |
| AddPaymentData | Add payment data |
| AddShippingAddress | Add shipping address and select delivery option |
| AddCoupons | Add coupons to the cart |
| SetMultipleCustomFieldValues | Set multiple custom field values |
| Removesinglecustomfieldvalue | Remove single custom field value |
| SetSingleCustomFieldValue | Set single custom field value |
| GetCartInstallments | Cart installments |
| Items | Add cart items |
| RemoveAllItems | Remove all items |
| ItemsUpdate | Update cart items |
| PriceChange | Change price |
| ClearorderFormMessages | Clear orderForm messages |
| IgnoreProfileData | Ignore profile data |
| PlaceOrderFromExistingOrderForm | Place order from an existing cart |
| CartSimulation | Cart simulation |
| PlaceOrder | Place order |
| ListPickupPpointsByLocation | List pickup points by location |
| GetAddressByPostalCode | Get address by postal code |
| GetClientProfileByEmail | Get client profile by email |
| GetSellersByRegion | Get sellers by region or address |
| GetorderFormconfiguration | Get orderForm configuration |
| UpdateorderFormconfiguration | Update orderForm configuration |
| GetWindowToChangeSeller | Get window to change seller |
| UpdateWindowToChangeSeller | Update window to change seller |
| Removeallpersonaldata | Remove all personal data |
