---
title: "Upgrade the cartridge"
url: "https://docs.adyen.com/plugins/salesforce-commerce-cloud/sfra/upgrade"
source_url: "https://docs.adyen.com/plugins/salesforce-commerce-cloud/sfra/upgrade.md"
canonical: "https://docs.adyen.com/plugins/salesforce-commerce-cloud/sfra/upgrade"
last_modified: "2024-01-04T14:57:00+01:00"
language: "en"
---

# Upgrade the cartridge

[View source](/plugins/salesforce-commerce-cloud/sfra/upgrade.md)

We recommend that you upgrade when we have a major release.

If you are on a version that is not maintained according to our [cartridge support schedule](/plugins/salesforce-commerce-cloud/#support-levels), we recommend that you upgrade to the [latest version available](https://github.com/Adyen/adyen-salesforce-commerce-cloud/releases/latest).

To stay up to date on the released fixes and features, subscribe to our [releases on GitHub](https://github.com/Adyen/adyen-salesforce-commerce-cloud/releases).

The integration effort involved in upgrading depends on whether you have made any [customizations](/plugins/salesforce-commerce-cloud/sfra/customization-guide) to the cartridge.

There are different steps to follow for:

* [Default integration](#default-integration)
* [Customized Integration](#customized-integration)

## Default Integration

1. Check which [SFRA version](/plugins/salesforce-commerce-cloud/sfra#supported-versions) is required for this upgrade and migrate if necessary. We recommend you use the latest version of SFRA.

2. Download the Adyen cartridge version that you want to install from [GitHub](https://github.com/Adyen/adyen-salesforce-commerce-cloud/releases).

3. Reupload the metadata:
   1. Include your customizations in the metadata file.

4. Open the **package/metadata/site\_import/sites/** folder.

5. Rename the **yourSiteId** (RefArch) folder to the ID of your site in your Salesforce Business Manager.

6. Open the **package/metadata/site\_import/jobs.xml** file.

7. Rename the `site-id` to the ID of your site in your Salesforce Business Manager.

8. Zip the **site\_import** folder. 

9. In the Business Manager, go to **Administration** > **Site Development** > **Site Import & Export** and import the zipped file.

10. Run to following command from the root directory to transpile, compile and upload the compatible, auto-generated code:
    ```bash
    npm run build
    ```

11. Adjust your cartridge path setup:

    1. In the Salesforce Business Manager, go to **Administration** > **Sites** > **Manage Sites** > **\[yourSite]** > **Settings**.

    2. In the **Cartridges** field for SFRA, enter, your cartridge path. [The cartridge path](/plugins/salesforce-commerce-cloud/sfra/set-up-the-cartridge) depends on the version you are upgrading to:

       | v23.3.2 or earlier                                         | v24.1.0 or later                                        |
       | ---------------------------------------------------------- | ------------------------------------------------------- |
       | int\_adyen\_SFRA:int\_adyen\_overlay:app\_storefront\_base | app\_adyen\_SFRA:int\_adyen\_SFRA:app\_storefront\_base |

## Customized Integration

Before you begin, check if there are any [breaking changes](#breaking-changes-for-customized-integrations) that affect your custom code.

1. [Extract any custom code you have added to the cartridge](/plugins/salesforce-commerce-cloud/sfra/customization-guide#extract-custom-code-from-the-default-cartridge).

2. [Add the extracted custom code in a separate cartridge](/plugins/salesforce-commerce-cloud/sfra/customization-guide#add-custom-code-in-a-separate-cartridge). For example, **int\_custom\_cartridge**.

3. Check which [SFRA version](/plugins/salesforce-commerce-cloud/sfra#supported-versions) is required for this upgrade and migrate if necessary. We recommend you use the latest version of SFRA.

4. Download the Adyen cartridge version that you want to install from [GitHub](https://github.com/Adyen/adyen-salesforce-commerce-cloud/releases). Create a folder with the downloaded cartridge.

5. Re-upload the metadata:

   1. Include your customizations in the metadata file.

6. Open the **package/metadata/site\_import/sites/** folder.

7. Rename the **yourSiteId** (RefArch) folder to the ID of your site in your Salesforce Business Manager.

8. Open the **package/metadata/site\_import/jobs.xml** file.

9. Rename the `site-id` to the ID of your site in your Salesforce Business Manager.

10. Zip the **site\_import** folder. 

11. In the Business Manager, go to **Administration** > **Site Development** > **Site Import & Export** and import the zipped file.

12. Run the following command from the root directory of the unmodified Adyen cartridge to transpile, compile and upload the compatible, auto-generated code:

    ```bash
    npm run build
    ```

13. Run the following command from the root directory of your customized cartridge to transpile, compile and upload the compatible, auto-generated code:

    ```bash
    npm run build
    ```

14. Check if the custom code is compatible with the new version and apply changes if needed.

15. Adjust your cartridge path setup:

    1. In the Salesforce Business Manager, go to **Administration** > **Sites** > **Manage Sites** > **\[yourSite]** > **Settings**.

    2. In the **Cartridges** field for SFRA, enter: **int\_custom\_cartridge:YOUR\_CARTRIDGE\_PATH**. [The cartridge path](/plugins/salesforce-commerce-cloud/sfra/set-up-the-cartridge) depends on the version you are upgrading to:

       | v23.3.2 or earlier                                         | v24.1.0 or later                                        |
       | ---------------------------------------------------------- | ------------------------------------------------------- |
       | int\_adyen\_SFRA:int\_adyen\_overlay:app\_storefront\_base | app\_adyen\_SFRA:int\_adyen\_SFRA:app\_storefront\_base |

16. Re-enable the [Salesforce Business Manager configuration page](/plugins/salesforce-commerce-cloud/sfra/set-up-the-cartridge?plugin=Salesforce%20SFRA\&integration=cartridge\&version=24.3.1#set-up-the-business-manager).

Watch how to upgrade your customized SFCC cartridge:

Embedded video (Vimeo): <https://player.vimeo.com/video/843123446>

### Breaking changes for customized integrations

New versions may include changes that affect [custom code](/plugins/salesforce-commerce-cloud/sfra/customization-guide), these are documented in our [release notes](/plugins/release-notes) as **Breaking Changes**. To see an overview of all breaking changes introduced between versions, use the **What's changed?** feature in our release notes.

The changes you must consider depends on the cartridge version you are upgrading from. For example, when upgrading from v21.2.0 to v23.1.0, you must not only consider the breaking changes in the v23.1.0, but all the breaking changes that were introduced between these versions.
