Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words Sign in

CartAI MCP Server

✓ service owner · cartai.ai

by TheCartAIversion 1.0.2i★ 1iRuns on your computerOfficial site ↗
Registry nameai.cartai/cartai-mcp-server

How to install

What it does

Agentic checkout with or without a human in the loop, product catalog, and an agent wallet.

  • Connects Runs on your computer
  • Account or key Needs CARTAI_API_KEY
  • Category Online shops & payments

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity4/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering0/8The cloud endpoint answered at the last check
Usage score16/100

Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install CartAI MCP Server. Follow https://mcp.popnx.com/i/cartai-mcp-server.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 21, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude, with some setup first

You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone

Let AI install it

Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server CartAI MCP Server for Claude on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "cartai": { "command": "npx", "args": [ "-y", "cartai-mcp-server" ], "env": { "CARTAI_API_KEY": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For CARTAI_API_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the CartAI MCP Server tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a CartAI MCP Server key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the CartAI MCP Server site ↗

  3. Open the Claude desktop app’s settings file

    SettingsDeveloperEdit Config

  4. Paste these settings and save the file

    {
      "mcpServers": {
        "cartai": {
          "command": "npx",
          "args": [
            "-y",
            "cartai-mcp-server"
          ],
          "env": {
            "CARTAI_API_KEY": "your-value"
          }
        }
      }
    }

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Quit Claude and open it again

  6. Try it

    Use CartAI MCP Server and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using CartAI MCP Server or shows a CartAI MCP Server tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect CartAI MCP Server yet

CartAI MCP Server runs on your computer, but ChatGPT can only connect servers that run on the web

What you can do instead

A · Use an app that can connect CartAI MCP Server

  • You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
  • You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time)
  • You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time)
  • You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time)

B · Others in Online shops & payments that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code, with some setup first

You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server CartAI MCP Server for Claude Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user cartai --env CARTAI_API_KEY=your-value -- npx -y cartai-mcp-server 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For CARTAI_API_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the CartAI MCP Server tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a CartAI MCP Server key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the CartAI MCP Server site ↗

  3. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  4. Paste this command and press Enter

    claude mcp add --scope user cartai --env CARTAI_API_KEY=your-value -- npx -y cartai-mcp-server

    Replace “your-value” with your key before pressing Enter

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Type /mcp in Claude Code

    You should see CartAI MCP Server listed as connected

  6. Try it

    Use CartAI MCP Server and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using CartAI MCP Server or shows a CartAI MCP Server tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor, with some setup first

You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server CartAI MCP Server for Cursor on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "cartai": { "command": "npx", "args": [ "-y", "cartai-mcp-server" ], "env": { "CARTAI_API_KEY": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For CARTAI_API_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the CartAI MCP Server tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a CartAI MCP Server key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the CartAI MCP Server site ↗

  3. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  4. Fill in your key

    In the CartAI MCP Server settings, CARTAI_API_KEY is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in Cursor in Agent mode

  6. Try it

    Use CartAI MCP Server and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using CartAI MCP Server or shows a CartAI MCP Server tool in the answer, you are connected

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code, with some setup first

You need a CartAI MCP Server key (create it on the maker’s site) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server CartAI MCP Server for VS Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "cartai": { "type": "stdio", "command": "npx", "args": [ "-y", "cartai-mcp-server" ], "env": { "CARTAI_API_KEY": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For CARTAI_API_KEY, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the CartAI MCP Server tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Sign up and create a CartAI MCP Server key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    Open the CartAI MCP Server site ↗

  3. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  4. Fill in your key

    In the CartAI MCP Server settings, CARTAI_API_KEY is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in VS Code in Agent mode

  6. Try it

    Use CartAI MCP Server and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using CartAI MCP Server or shows a CartAI MCP Server tool in the answer, you are connected

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

JSON settings are under “For developers” below

Stuck? Ask people who use CartAI MCP Server💬 Discussion →
For developers: Terminal commands and JSON settings

Installed on your computer

Claude Code

claude mcp add --scope user cartai --env CARTAI_API_KEY=your-value -- npx -y cartai-mcp-server

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "cartai": {
      "command": "npx",
      "args": [
        "-y",
        "cartai-mcp-server"
      ],
      "env": {
        "CARTAI_API_KEY": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "cartai": {
      "command": "npx",
      "args": [
        "-y",
        "cartai-mcp-server"
      ],
      "env": {
        "CARTAI_API_KEY": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "cartai": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "cartai-mcp-server"
      ],
      "env": {
        "CARTAI_API_KEY": "your-value"
      }
    }
  }
}

Values you fill in

  • CARTAI_API_KEY secret required env
    CartAI API key from the CartAI portal

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

Downloads per weeki
Not on npm/PyPI
Verified domain
✓ cartai.ai
Licencei
Apache-2.0
Connection
Runs on your computer
Latest versioni
1.0.2
Published to registryi
Nov 21, 2026
Code last changedi
Nov 21, 2026
Maker
TheCartAI
Packages
npm: cartai-mcp-server
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 21, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified against the domain cartai.ai (the registry checks domain ownership)

  • ✓ Pass

    Still maintained

    Code last changed today

  • ✓ Pass

    Has a licence

    Uses Apache-2.0

  • – Not applicable

    Endpoint responds

    This one runs on your computer; there is no internet endpoint

  • – Not applicable

    Sign-in with OAuth

    Runs on your computer and uses local settings instead

  • … Not checked yet

    No hidden instructions in tool descriptions

    Runs on your computer; we can only read tool lists from internet endpoints

Published vulnerabilities (OSV.dev)

Not checked yet

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/cartai-mcp-server.svg)](https://mcp.popnx.com/en/servers/cartai-mcp-server)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Online shops & paymentsi

  • More stars than 90% of the other 3027 servers in this category
  • Published to the registry more recently than 99% of the other 3027 servers in this category
  • Basic checks equal to or better than 99% of the other 3027 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is CartAI MCP Server safe?

It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: CARTAI_API_KEY

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed today, and the latest version (1.0.2) reached the registry today.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Node.js on your computer.

What can I use instead?

In the same category: Stripe MCP, flightclaw, Trade It, Marketplace Ad Pros: Amazon Ads & Seller Central, idealo MCP Server

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

Stripe MCP

Stripe’s official server lets AI view and manage customers, products, payments and invoices. Connect to Stripe’s cloud and sign in with OAuth.

by stripeWidely used★ 2.1KUpdated 13 months ago

Runs in the cloud✓ service owner · stripe.com

flightclaw

Search ~300 airlines and book flights with a checkout link. OAuth sign-in by email code.

by flightclawGrowing★ 87Updated 2 months ago

Runs in the cloud✓ service owner · flightclaw.com

Trade It

Connect brokerage accounts to AI assistants: holdings, orders, asset lookup, and approved trading.

by trade-it-incGrowing★ 62Updated 36 days ago

Runs in the cloud✓ service owner · tradeit.app

idealo MCP Server

Search products, compare prices and discover deals across 6 European markets with your AI assistant.

by idealoEarly★ 28Updated 6 months ago

Runs in the cloud✓ service owner · mcp.idealo.com
Compared with similar ones
This one
CartAI MCP Server
Stripe MCPflightclawTrade ItMarketplace Ad Pros: Amazon Ads & Seller Centralidealo MCP Server
Runs whereInstalls on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to install
Needs a keyYesNoNoNoNoNo
Add with + in ClaudeNoYesNoNoNoNo
Basic checks3/34/44/45/54/44/4
LicenseApache-2.0MITMITCC0-1.0MITMIT
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

CartAI MCP Server

CartAI Powered MCP Server for autonomous product discovery, agentic payments, and checkout.

Sign up and try it on the CartAI Portal →

An MCP (Model Context Protocol) server that exposes the CartAI Catalog, Payments, Credentials, and Checkout APIs as tools inside Claude Desktop, Claude Code, Cursor, or any MCP-compatible AI host. Powered entirely by CartAI — search for products, fetch detailed variant and pricing info, get pre-checkout shipping and tax estimates, get a customer's card authorized for agentic payments, securely store merchant logins, and execute the entire checkout autonomously — from product URLs or just product names — asynchronously, with full status tracking and interactive MFA support.


Table of Contents

  • What is MCP?
  • What this server does
  • Prerequisites
  • Installation
  • Configuration
  • Claude Desktop
  • Cursor
  • VS Code
  • MCP Inspector
  • Tools
  • Checkout
  • Catalog
  • Payments
  • Credentials
  • Example prompts
  • How it works
  • Environment variables
  • Troubleshooting
  • Resources & Support
  • License

What is MCP?

Model Context Protocol is an open standard that lets AI assistants call external tools — APIs, databases, file systems — through a common interface. Think of it like a USB-C port for AI: one standard, any device. This server plugs CartAI's checkout capability into that port.


What this server does

ToolDescription
create_checkoutStart an async checkout for one or more product URLs
create_search_checkoutStart an async checkout from product names on a given merchant — no URLs needed
get_checkoutFetch the current state of a checkout task
cancel_checkoutCancel an in-progress checkout
get_status_historyGet the full step-by-step event log for a task
send_interactive_inputsSend an MFA/OTP code to a checkout task that is waiting for it
search_productsDiscover products by name across merchants
get_product_detailsRetrieve detailed info, variants, and pricing for a product URL
get_checkout_estimatesCompute pre-checkout shipping and tax estimates before placing an order
create_payment_sessionCreate a hosted payment session URL for the customer to authorize their card
delete_payment_sessionInvalidate a payment session
get_payment_credentialsRetrieve a scoped payment credential for an authorized payment session
create_credential_sessionCreate a secure vault URL where the customer stores their merchant login

Under the hood every tool maps 1-to-1 to a CartAI REST endpoint — the MCP server is a thin, type-safe bridge with no additional logic.


Prerequisites

RequirementVersion / Notes
Node.js>= 18.0.0 (uses native fetch and ES modules)
CartAI API keyObtain from the CartAI Admin Portal — see API Docs for full reference
MCP hostClaude Desktop, Cursor, VS Code (with MCP extension), or MCP Inspector

Installation

Run with npx (recommended)

You do not need to clone the repo. Point your MCP client at npx -y cartai-mcp-server and set CARTAI_API_KEY. See Configuration.

Local development
# 1. Clone the repo

git clone https://github.com/TheCartAI/cartai-mcp-server.git cd cartai-mcp-server

2. Install dependencies

npm install

3. Set your API key

export CARTAI_API_KEY=your_api_key_here

4. Verify it starts

npm start

→ [cartai-mcp] Running on stdio ✓

Never commit your API key. The repo ships with a .gitignore that excludes .env.


Configuration

The snippets below use npx. To run a local clone instead, set "command" to node and "args" to ["/absolute/path/to/cartai-mcp-server/src/index.js"].

Claude Desktop

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{

"mcpServers": { "cartai": { "command": "npx", "args": ["-y", "cartai-mcp-server"], "env": { "CARTAI_API_KEY": "your_api_key_here" } } } }

Restart Claude Desktop. You should see the CartAI tools in the tool picker.


Cursor

Add the following to ~/.cursor/mcp.json, or to .cursor/mcp.json in a project:

{

"mcpServers": { "cartai": { "command": "npx", "args": ["-y", "cartai-mcp-server"], "env": { "CARTAI_API_KEY": "your_api_key_here" } } } }


VS Code

Install the MCP extension for VS Code, then add the following to your .vscode/mcp.json (or user-level settings.json under "mcp.servers"):

{

"servers": { "cartai": { "type": "stdio", "command": "npx", "args": ["-y", "cartai-mcp-server"], "env": { "CARTAI_API_KEY": "your_api_key_here" } } } }

Reload the VS Code window. The CartAI tools will be available to any MCP-aware agent running in the editor.


MCP Inspector

MCP Inspector is the official browser-based tool for testing and debugging MCP servers without needing a full AI client.

# Run Inspector against this server in one command

npx @modelcontextprotocol/inspector npx -y cartai-mcp-server

Set the API key in the Environment Variables panel inside Inspector (CARTAI_API_KEY = your_api_key_here), then use the Tools tab to call create_checkout, get_checkout, etc. interactively.

MCP Inspector is the fastest way to validate tool inputs/outputs before wiring up a full client.


Tools

Checkout tools
create_checkout

Creates a new async checkout task from product page URLs. CartAI runs the checkout in the background and emits status updates via webhooks. Multi-merchant carts are split into one task per merchant.

Required inputs:

FieldTypeDescription
customerobjectCustomer contact, addresses, shipping method, and payment — see Customer object
tasks[].urlstring (URI)Full product page URL
tasks[].quantityintegerUnits to purchase (min 1)

Optional inputs:

FieldTypeDefaultDescription
tasks[].selectedVariant.colorstring—Variant color
tasks[].selectedVariant.sizestring—Variant size
optionsobject—Checkout behaviour flags — see Checkout options
addons.couponCodestring[]—Coupon / promo codes to apply, e.g. ["SUMMER15"]

Returns: a groupId and a tasks[] list — one entry per merchant with taskId, executionId, merchant, initial status (queued), and a liveUrl to watch the checkout run live.


create_search_checkout

Creates an async checkout task from product names instead of URLs. Give it the merchant website and a list of item names — the CartAI agent searches the merchant's catalog, resolves each item (and any selected variant), assembles the cart, and completes shipping, payment and order confirmation in one call.

When to use: this is the go-to tool when the user already knows what they want to buy and from which store (e.g. *"order X, Y and Z from Kylie Cosmetics"*). There's no need to call search_products first.

Required inputs:

FieldTypeDescription
customerobjectSame as create_checkout — see Customer object
merchantstring (URI)Merchant website URL, e.g. https://kyliecosmetics.com/
itemList[].namestringProduct name to search for on the merchant's site

Optional inputs:

FieldTypeDefaultDescription
itemList[].quantityinteger1Units to purchase (min 1)
itemList[].selectedVariantobject—Free-form key/value pairs using the option names shown on the merchant's site, e.g. { "Shade": "candy k" } or { "Color": "Black", "Size": "M" }
optionsobject—Same as create_checkout — see Checkout options
addons.couponCodestring[]—Coupon / promo codes to apply

Returns: same shape as create_checkout — groupId plus taskId, merchant, status, and liveUrl per task.


Customer object

Shared by create_checkout and create_search_checkout.

FieldTypeDescription
customer.contact.firstNamestring—
customer.contact.lastNamestring—
customer.contact.phonestringDigits, spaces, hyphens, leading + (7–20 chars)
customer.contact.emailstring—
customer.shippingAddress.addressLine1string—
customer.shippingAddress.addressLine2string—
customer.shippingAddress.citystring—
customer.shippingAddress.provincestringState/province code e.g. NY
customer.shippingAddress.postalCodestringZIP or postal code
customer.shippingAddress.countrystringCountry code e.g. US
customer.billingAddressobjectSame shape as shippingAddress
customer.shippingMethod.strategystringe.g. "cheapest" \"fastest" \"standard"
customer.payment.data.sessionIdstringAgentic payments: sessionId from create_payment_session, after the customer has authorized their card. No provider needed.
customer.payment.providerstringSet to "test" to pass raw card details (cardNumber, cvv, name, expiryMonth, expiryYear) in data instead of a sessionId
Checkout options

All flags default to false.

FieldDescription
options.verifyBeforePlacementAgent asks for confirmation just before placing the order
options.useSavedCredentialToLoginAgent signs in to the merchant using credentials stored via create_credential_session
options.useGuestCheckoutIfLoginFailsIf the stored credentials don't work, fall back to guest checkout when the merchant offers it
options.allowInteractionInteractive flow instead of fire-and-forget — the agent can pause and request input (e.g. an OTP via send_interactive_inputs)

| options.allowPartialCheckout | If some

Only the beginning is shown; read the rest in the repo