Headless (OCAPI) Architecture

Installing Headless (OCAPI) Architecture Cartridge

Installing the Cartridge (Headless)

Follow these steps to install the ESW Headless cartridge for the first time:

Clone the Repository

Clone the ESW cartridge repository to your local development environment.

Import the Cartridges

  • Import the following cartridges into your workspace:
    • int_eshopworld_headless
    • int_eshopworld_core
  • Link both cartridges to your SFCC server connection.

Import Site Data

  • Navigate to Metadata > Sitesdata
  • Create a ZIP archive of the sitesdata folder (e.g., sitesdata.zip).
  • Import the archive into your SFCC instance via Business Manager > Administration > Site Development > Import & Export

Assign Cartridges to the Site

Assign the int_eshopworld_headless and int_eshopworld_core cartridges to the site’s cartridge path. The cartridge path sequence should look like this:

int_eshopworld_sfra:int_eshopworld_core:int_eshopworld_headless:app_someother_cartridge

Configure OCAPI Settings

Add or update the OCAPI configuration to enable headless operations with ESW.