Docs

One control layer for AI-agent shopping on Shopify.

CartBridge exposes merchant readiness, policy, audit, fallback checkout, and agent cart APIs. Agents must authenticate, send buyer IP, and include explicit user authority on cart requests.

Product search

GET /v1/shopify/products/search?shop=example.myshopify.com&q=coffee&country=US

Create cart

POST /v1/shopify/carts
Authorization: Bearer cb_live_...
X-Buyer-IP: 203.0.113.8

Create quote

POST /v1/shopify/carts/{cartId}/quote

Checkout handoff

POST /v1/shopify/carts/{cartId}/checkout-session

Required cart context

shop: the merchant .myshopify.com domain.
X-Buyer-IP: required for server-side Shopify Storefront calls.
userAuthority: approval ID, max total, allowed shops, and whether approval is required.
lines: Shopify ProductVariant IDs and quantities.

Admin readiness

Merchants can read the control-center report at /admin/readiness.json and run product-risk scans from the dashboard.

Checkout rule

CartBridge uses Shopify checkout-link fallback by default. UCP / Shop Pay direct checkout is used only when Shopify credentials, merchant UCP availability, and product eligibility are ready. CartBridge does not place orders through the Admin API and does not process payment data.

OpenAPI

The working OpenAPI spec is available at /openapi.yaml and maintained in the project repository.

LLM instructions

A compact agent-readable integration guide is available at /llms.txt.

Runtime setup

A practical MCP setup guide for LLM runtimes is available at /agent-runtime-setup.md.

Agent client

A dependency-free JavaScript client example is available at /examples/cartbridge-agent-client.mjs. It covers product search, cart creation, quote approval, checkout handoff, and order-status polling.

MCP server

A local MCP server example is available at /examples/cartbridge-mcp-server.mjs for LLM runtimes that expose tools through MCP.