Skip to main content

Request types

Public request families for the commerce layer agents call.

These are the main callable families already exposed through the current public developer contract. They are intentionally grouped by builder workflow rather than by every underlying internal route.

Request familyExamplesDefault pathWhy it matters
Authentication and merchant contextGET /agent/v1/merchantsREST with X-API-KeyValidate the key, confirm the branded API base, and establish merchant context before deeper flows.
Search and recommendationMCP search_catalog / get_product / get_alternatives / get_intelREST / MCPResolve products, offers, and merchant data through a structured commerce surface instead of crawling merchant sites.
Cart validationPOST /agent/v1/cart/validateREST (sandbox for writes)Validate items and cart structure before checkout creation or deeper order flows.
Checkout intentsPOST /agent/v1/checkout/intentsREST (sandbox for writes)Create merchant-native checkout flows that carry execution into payment-aware paths.
OrdersPOST /agent/v1/orders/create, GET /agent/v1/ordersRESTCreate and inspect order flows while keeping merchant systems in the execution loop.
Order events and execution signalsGET /agent/v1/orders/eventsRESTInspect timeline events and execution state instead of inferring outcomes from front-end surfaces alone.
WebhooksPortal-managed destinations and delivery history (account-scoped contract)REST + portal-managed lifecycleSubscribe to events, test delivery, verify signatures, and keep downstream systems aligned after execution begins.