Skip to main content

Customer Example Payloads

This section contains copy-ready JSON payloads for frontend and backend teams integrating ACP Engine with a chat-based commerce UI.

Each example begins with its purpose, the point in the customer journey where it is used, and the integration rules that matter. The JSON is a reference fixture, not a replacement for authorization, server-side validation, idempotency, or payment security controls.

The examples are split by boundary:

  • API examples: request and response examples for ACP Engine runtime APIs, cart, checkout, and payment handoff.
  • Frontend examples: UI state and component fixture examples for chat messages, product listing, product carousel, cart, order confirmation, address/profile selection, card listing, payment, OTP, passkey, onboarding, and order summary screens.

Recommended use:

  • Backend and integration teams should start from api/.
  • Frontend teams should start from frontend/.
  • A customer BFF can map merchant product fields to frontend component fields before rendering.

Field naming note:

  • Merchant services can expose product fields such as storeId, productId, imageUrl, imageUrls, productUrl, inStock, and inventoryQuantity. imageUrls is optional and ordered; the first of at most 20 URLs is the primary image and matches imageUrl.
  • Reference frontend components should render normalized UI fields such as image, url, price_text, and in_stock.
  • Frontends with gallery support may retain all imageUrls; simpler cards should use the primary imageUrl/first gallery entry.

Do not send card numbers, CVV, full payment credentials, or unnecessary PII through chat messages or runtime tool calls. Checkout and payment details should be collected only in the customer-controlled hosted checkout, wallet, PSP SDK, or approved payment widget.