How large is the CartAI catalog?
The Catalog covers 2M+ merchants and 1B+ products. Search returns products across all of them. Checkout runs on supported merchants.
How does product search work?
Send POST /product/search with a name query. The response is a ranked list of products. Each product includes name, merchant, image, priceFrom (the lowest available price), currency, and directUrl. Search is a lightweight lookup. It does not create a cart or start a checkout.
Can I limit search results to one merchant?
You can prioritize one. Pass merchant in the request and that retailer’s products rank first. Other retailers are still included. targetMatchCount tells you how many results belong to the merchant you named. Leave merchant out to compare across retailers in one call.
Does product search return live availability?
No. Search returns priceFrom and a directUrl. For price and stock on each variant, call POST /product/details with that directUrl.
How do I get variants, stock, and price for a product?
Call POST /product/details with the product page URL. Set allVariants to true to get every option. The response includes dimensions (the option names, such as Color and Size) and a list of variants. Each variant has variantId, price, available, attributes, and url. Show a buy action only for variants where available is true. Out of stock variants are included so you can show them as disabled.
What is a checkout estimate?
POST /checkout-estimates returns subtotal, shipping, tax, and total for a merchant, a destination ZIP, and a list of items. It is read only and does not open a cart. Pass the variant price as unitPrice. If shippingKnown is false, treat the estimate as incomplete. An estimate is optional. You can start a checkout without one.
How do I pass a catalog result into checkout?
Pass the product URL as tasks[].url in POST /checkout. If the product has no variants, use the directUrl from search. If the customer chose a variant, use that variant’s url from Product Details and set selectedVariant to match its attributes.
Does product search support pagination?
No. Search returns a single ranked list. The request accepts name and an optional merchant.