Getting Started with Spree API

Spree comes with a fully-featured API that allows it to operate in a fully headless mode.
To use the APIs, install the spree_api gem with a version corresponding to your version of Spree. If you're using spree_starter as a base for your project, the API will be included out of the box.
Currently there are two types of APIs:
  • Storefront API - that's designed to allow customers to interact with the store via external applications (e.g. Vue Storefront or a dedicated mobile app).
  • Platform API - that provides management capabilities, allowing third party apps to perform actions otherwise available via the admin panel.
Spree also offers a legacy v1 API, that's been extracted to spree_api_v1gem in Spree 4.5. It uses an outdated architecture and is now deprecated.