VTEX Checkout MCP connector

VTEX Checkout is VTEX's API for managing shopping carts, order placement, and checkout configuration in ecommerce operations. The VTEX Checkout MCP connector allows AI agents to create and manage shopping carts, process orders, and configure client profiles and preferences. It also supports adding shipping addresses and delivery options, managing payment data, applying coupons, and adding marketing and merchant context information to the checkout process.

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:

• Build complete checkout workflows from cart creation through order confirmation
• Validate customer addresses and calculate shipping costs before payment processing
• Apply discount codes and promotional offers automatically during checkout
• Capture customer profile data and payment information securely in one step
• Retrieve available pickup points and seller inventory based on customer location
• Configure custom checkout fields and validation rules for specific business requirements
• Process orders with multiple payment methods and installment options simultaneously

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 a customer.
• Apply a coupon code to an existing cart in VTEX Checkout.
• Look up what pickup points are available near this postal code in VTEX Checkout.
• Add a shipping address to the cart and show me available delivery options in VTEX Checkout.
• Process an order after the customer has added payment information in VTEX Checkout.
• Show me the current configuration settings for our checkout form in VTEX Checkout.
• Retrieve the customer profile information using their email address in VTEX Checkout.
• Calculate the total cost including shipping, taxes, and installment options in VTEX Checkout.
• Remove all items from a customer's cart in VTEX Checkout.
• Get the list of sellers available for a specific region in 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	Processes and finalizes an order for checkout and fulfillment.
CreateANewCart	Retrieves the current cart or initializes a new one for shopping.
GetCartInformationById	Retrieves detailed information about a specific cart by its identifier.
AddClientPreferences	Records client preferences such as communication and service choices.
AddClientProfile	Adds or updates customer profile information for the order.
AddMarketingData	Attaches marketing-related data such as campaigns or promotions to cart.
AddMerchantContextData	Adds merchant-specific context information to the checkout session.
AddPaymentData	Records payment method and financial details for transaction processing.
AddShippingAddress	Captures delivery address and applies the selected shipping option.
AddCoupons	Applies discount or promotional codes to reduce cart total.
SetMultipleCustomFieldValues	Sets multiple custom fields with specified values in the cart.
Removesinglecustomfieldvalue	Removes a single custom field value from the cart.
SetSingleCustomFieldValue	Assigns a value to a single custom field in the cart.
GetCartInstallments	Retrieves available payment installment options for the cart total.
Items	Adds products to the cart with quantities and specifications.
RemoveAllItems	Clears all products and items from the current cart.
ItemsUpdate	Modifies quantities and properties of existing items in cart.
PriceChange	Adjusts the price of items in the cart as needed.
ClearorderFormMessages	Removes all messages and notifications from the order form.
IgnoreProfileData	Disregards or excludes stored profile information from checkout.
PlaceOrderFromExistingOrderForm	Submits an order using an already-prepared cart configuration.
CartSimulation	Simulates cart calculations including totals, discounts, and shipping.
PlaceOrder	Submits the cart and completes the order placement process.
ListPickupPpointsByLocation	Shows available pickup locations based on geographic area or address.
GetAddressByPostalCode	Retrieves full address details when given a postal code.
GetClientProfileByEmail	Retrieves customer profile information using their email address.
GetSellersByRegion	Identifies available sellers or merchants in a specified region.
GetorderFormconfiguration	Retrieves the current settings and configuration of the order form.
UpdateorderFormconfiguration	Modifies the order form settings and configuration parameters.
GetWindowToChangeSeller	Determines the timeframe allowed for changing the selected seller.
UpdateWindowToChangeSeller	Update window to change seller.
Removeallpersonaldata	Remove all personal data.