For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Carts
      • Checkouts
      • Consent
      • Customers
      • Subscriptions
      • Form Fields
      • Orders
      • Pickup Options
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
On this page
  • Authentication
  • What’s inside
  • Common use cases
RESTStorefront

Storefront REST APIs

Was this page helpful?
Previous

REST API Overview

Next

Storefront Carts

Built with

Client-side REST APIs designed for use in a browser or storefront context. These APIs let you interact with carts, checkouts, and customer data directly from storefront JavaScript without a server-side proxy.

Authentication

Storefront REST APIs use same-origin CORS authentication — no token is required when requests are made from the store’s native storefront. Requests must originate from the storefront domain.

For server-side or headless usage, consider the GraphQL Storefront API, which offers broader capabilities with bearer token authentication.

For full details, see Authentication overview.

What’s inside

  • Carts — Create and manage shopping carts, cart items, and cart currency
  • Checkouts — Manage checkout state, billing address, consignments, coupons, and gift certificates
  • Checkout Spam Protection — Validate checkout spam protection
  • Checkout Store Credit — Apply and remove store credit during checkout
  • Consent — Manage cookie consent preferences
  • Customers — Create customer accounts from the storefront
  • Subscriptions — Manage customer subscriptions
  • Form Fields — Retrieve storefront form field configuration
  • Orders — Look up order details from the storefront
  • Pickup Options — Retrieve available pickup options

Common use cases

  • Cart manipulation via storefront JavaScript
  • Checkout customization and payment flow
  • Customer signup and consent management
  • Order lookup from confirmation pages

For richer querying and mutations from the storefront, consider the GraphQL Storefront API, which supports product queries, customer management, and cart operations with bearer token authentication.