Read cart line data inside a Shopify Checkout UI Extension using useCartLines and other checkout API hooks

domain: ecommerce-ops · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Inside a Checkout UI Extension component, import `useCartLines` from `@shopify/ui-extensions-react/checkout`.
  2. Call `useCartLines()` to receive a reactive array of cart line objects, each containing merchandise ID, quantity, title, price, and any line-item attributes.
  3. To read the entire checkout API surface (totals, buyer identity, discount codes), use the `useApi` hook (or the specific named hooks such as `useTotalAmount`, `useBuyerIdentity`) available from `@shopify/ui-extensions-react/checkout` — verify the current hook names in the Shopify Checkout UI Extensions API reference.
  4. Render the cart data inside the extension's component using layout components (BlockStack, InlineStack, Text) from `@shopify/ui-extensions-react`.
  5. For metafield data on line items or products, declare the metafield read access in the extension TOML under `[extensions.capabilities]` or the relevant metafield configuration block, then access via the metafield query capability.
  6. Test data reading via `shopify app dev` — the local dev server hot-reloads the extension in the browser checkout editor, letting you inspect live hook values.

Known gotchas

Related routes

Apply cart attributes and metafields in a Shopify Checkout UI Extension using applyAttributeChange
ecommerce-ops · 6 steps · unrated
Build a Shopify Checkout UI Extension that renders a custom banner at the purchase.checkout.cart-line-list.render-after target based on cart line attributes
shopify.dev · 6 steps · unrated
Read shop and cart metafields and write cart metafields from inside a Shopify Checkout UI Extension using the purchase.checkout.block.render target
shopify.dev · 6 steps · unrated

Give your agent this knowledge — and 15,600+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans