Skip to main content
The Marzipan REST API enables you to interact with the Marzipan platform, retrieve data, and allow customers to manage their and accounts. You may wan to use our web components instead of the API.
The API is currently in beta and subject to change.

​
Two APIs

Marzipan has two separate APIs:
  • Storefront API (/v1/…) — the API this reference and the scopes below cover. It powers our web components and headless storefronts. Requests authenticate with a tenant API token, plus a customer bearer token for actions taken on behalf of a logged-in account.
  • Admin / mobile app API (/admin/v1/…) — powers the Marzipan mobile companion app, covering orders, POS, customers, subscriptions, tasks, device push notifications, and Stripe Terminal / Tap to Pay. It uses a two-factor authentication login flow.
The Admin / mobile app API is in beta and is used by the official Marzipan mobile app.

​
Getting Started

To get started with the Marzipan API, you will need to create an API key with the right permissions in your Marzipan account settings. You will be able to choose the permissions you need for your API key. The current available permissions are:
  • read - read access to products, collections, events, subscriptions and CMS
  • create - create access to products, collections, events, subscriptions and CMS
  • update - update access to products, collections, events, subscriptions and CMS
  • delete - delete access to products, collections, events, subscriptions and CMS
  • cart:create - create access to carts
  • cart:update - update access to carts
  • cart:read - read access to carts
  • cart:delete - delete access to carts

​
Authentication

The Marizpan API uses Bearer authentication. Include your generated api key in the Authorization header of your HTTP requests.
Keep your API key secure and never expose it in a public repository or share it with untrusted parties. If you believe your API key has been compromised, you can revoke it and generate a new one in your account settings.