Spartacus API

Note: Spartacus 4.x is no longer maintained. Please upgrade to the latest version.

Note: Spartacus 4.x was tested with SAP Commerce Cloud versions 1905 to 2205. Spartacus 4.x has not been verified to work with (and is not guaranteed to work with) SAP Commerce Cloud 2211 or later releases.

The Spartacus API documentation is hosted here:

The API documentation is versioned and is included in the Assets folder of each and every Spartacus library. You can download the API documentation for a particular version by accessing the Assets folder of any Spartacus library from that particular release, and then clicking on docs.tar.gz or To find the Assets folder for a particular library, access the Released Libraries for Spartacus, click on the link for the library you are interested in, and scroll to the bottom of the page.

For example, to download the API documentation for the 2.0.0 release, you could access the Assets folder of the @spartacus/storefront@2.0.0 library here.

Note: The 1.x and 2.x releases of the Spartacus libraries work only with SAP Commerce Cloud versions 1905 and 2005. Certain features, such as cancellations and returns, are only available with SAP Commerce Cloud 2005, because the necessary OCC API support is only available in SAP Commerce Cloud 2005.

Note: The Spartacus API is separate from the Commerce Cloud OCC REST APIs that Spartacus consumes. For more information, see the Commerce Cloud API Documentation and YAML Files on the SAP Help Portal.