Skip to main content

API Reference

The Headless Commerce API is organized around REST. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP verbs and status codes.

Base URL

Two API Surfaces

Storefront API

/v1/storefront/*For customer-facing applications. Accessible with publishable keys (pk_*) or secret keys (sk_*).

Admin API

/v1/admin/*For back-office management. Requires secret keys (sk_*) only.

Common Headers

Rate Limiting

Requests are rate-limited per store based on plan: All responses include rate limit headers:

Interactive Reference

You can also explore and test the API interactively using the Scalar API Reference.