Skip to main content
Feedback

VTEX Customer Credit MCP connector

Updated 

VTEX Customer Credit is VTEX's API for managing customer credit accounts, invoices, and payment terms within a commerce environment. The VTEX Customer Credit MCP connector allows AI agents to open, update, and close credit accounts, adjust credit limits, and manage account holders. It also supports retrieving account and invoice details, enabling agents to monitor credit status and payment activity across the tenant.

Authentication type

  • API Key - Requires a static API key to be configured before the agent can connect to the service.

Uses

Use the VTEX Customer Credit MCP connector to perform the following actions:

  • Open and close customer credit accounts directly from a workflow
  • Adjust credit limits and tolerance thresholds without manual store edits
  • Track and manage invoices, including cancellation and postponement
  • Mark invoices as paid to keep credit balances accurate
  • Authorize and settle payments using pre-authorization and settlement tools
  • Retrieve account statements to review customer credit activity
  • Refund settlements partially or in full when disputes arise
  • Configure store-level credit settings across a VTEX instance

Example prompts

Use the following example prompts to invoke VTEX Customer Credit MCP connector tools from your AI assistant or Boomi Connect workflow:

  • Show me all open invoices from last month in VTEX Customer Credit.
  • Open a new credit account for this customer in VTEX Customer Credit.
  • Increase the credit limit for account 12345 in VTEX Customer Credit.
  • Mark invoice 987 as paid in VTEX Customer Credit.
  • Cancel the pre-authorization for this order in VTEX Customer Credit.
  • Pull the account statement for customer 456 in VTEX Customer Credit.
  • Close the credit account for this customer in VTEX Customer Credit.
  • Refund half of the settlement amount for order 789 in VTEX Customer Credit.
  • Update the store configuration for credit tolerance in VTEX Customer Credit.
  • Find all accounts linked to this email address in VTEX Customer Credit.

VTEX Customer Credit MCP connector tools

The VTEX Customer Credit MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.

ToolDescription
SearchallaccountsSearch all accounts
OpenanAccountOpen an Account
OpenorChangeAccountOpen or Change Account
CloseanAccountClose an Account
RetrieveaAccountbyIdRetrieve an Account by Id
UpdateemailanddescriptionofaaccountUpdate email and description of a account
ChangecreditlimitofanAccountChange credit limit of an Account
AddanaccountHolderAdd an account Holder
DeleteanaccountholderDelete an account holder
SearchallinvoicesofaAccountRetrieve invoice by creditAccountId
CancelInvoiceCancel Invoice
RetrieveInvoicebyIdRetrieve Invoice by Id
ChangeInvoiceChange Invoice
MarkaninvoiceasPaidMark an invoice as Paid
PostponeaninvoicePostpone an invoice
AccountstatementsAccount statements
DecreasebalanceofanaccountDecrease balance of an account
ChangetoleranceofanaccountChange tolerance of an account
CreateaPreAuthorizationCreate a Pre Authorization
CancelaPreAuthorizationCancel a Pre Authorization
CreateaPreAuthorization(usingid)Create a Pre Authorization (using id)
PartialorTotalRefundaSettlementPartial or Total Refund a Settlement
CreateorUpdateSettlementCreate or Update Settlement
SearchallinvoicesSearch all invoices
RetrievestoreconfigurationRetrieve store configuration
CreateorchangestoreconfigurationCreate or change store configuration
On this Page