Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.quickshops.app/llms.txt

Use this file to discover all available pages before exploring further.

To connect an AI agent to your Quickshops store, you need a headless API key and the MCP server URL. Once connected, your AI client can call tools to browse your catalog, manage carts, and generate checkout links in real time.

Prerequisites

Before connecting, retrieve your headless API key from Dashboard → Settings → API Keys. Keys prefixed with qk_ are your headless keys. If you want your agent to create carts, initiate checkouts, or access the subscription portal, you need a secret key — not a public/read-only key.

Connection details

SettingValue
URLhttps://mcp.quickshops.dev/mcp
Headerx-api-key: qk_your_key_here
TransportStreamable HTTP (MCP over HTTP + SSE)

Connect your client

Open your Claude Desktop configuration file (claude_desktop_config.json) and add the quickshops entry under mcpServers:
claude_desktop_config.json
{
  "mcpServers": {
    "quickshops": {
      "url": "https://mcp.quickshops.dev/mcp",
      "headers": {
        "x-api-key": "qk_your_key_here"
      }
    }
  }
}
Save the file and restart Claude Desktop. Quickshops tools will appear in the tool list when you start a new conversation.
Ask your assistant to list your products, create a test cart, or generate a checkout link to verify the connection is working.

Available tools

Every tool maps directly to a REST API route. Tool names are derived from the HTTP method and path.
Tools that access cart, checkout, and subscription data require a secret key. Connecting with a public or read-only key means those tools will return an error when called. Read product tools (get_products, get_products_productId, get_products_store) work with any key type.

Store & products

ToolDescription
get_products_storeGet your store details and metadata
get_productsList all products in your store
get_products_productIdGet a single product by ID

Cart (secret key required)

ToolDescription
post_cartCreate a new cart
get_cart_cartIdGet cart contents including lines and totals
post_cart_cartId_linesAdd a product to the cart
patch_cart_cartId_lines_productIdUpdate an item’s quantity
delete_cart_cartId_lines_productIdRemove a specific item from the cart
delete_cart_cartIdClear the entire cart

Checkout & subscriptions (secret key required)

ToolDescription
post_checkout_sessionCreate a Stripe checkout URL for a cart
post_subscription_portalGet a Stripe billing portal URL for a member
1

Get your API key

Go to Dashboard → Settings → API Keys and copy your headless API key. Use a secret key if you want your agent to manage carts and checkouts.
2

Add the MCP server to your client

Use the configuration examples above for your client. Set the URL to https://mcp.quickshops.dev/mcp and add your key as the x-api-key header.
3

Verify the connection

Start a conversation and ask your AI assistant to list your products. If it returns results, the connection is working. If it returns an error, double-check that the key is valid and that you are using the correct key type for the tools you are calling.