Buy with Prime | Developer Documentation
Documentation
GraphQL Playground

Upgrade the Buy with Prime Cartridge

📘

Buy with Prime API is now available for early access

Sign up for early access to the Buy with Prime API using the 'Sign Up' button below. The API may change as Amazon receives feedback and iterates on it.

Sign Up

We recommend upgrading the Buy with Prime cartridge for major releases or when you need access to new features.

Compatibility

The Buy with Prime cartridge requires:

  • Storefront Reference Architecture (SFRA) 6.0 or later.
  • Compatibility Mode 22.7 or later.
  • For Amazon Pay integration, Amazon Pay cartridge version 24.1 or later.

Prerequisites

To upgrade the Buy with Prime cartridge, your organization must have the following prerequisites:

Pre-upgrade best practices

Before proceeding with the upgrade, do the following:

  • Review release notes: Review the release notes for the Buy with Prime Cartridge to understand the changes.
  • Create backups: Create a full backup of your site's data, configurations, and codebase.
  • Test in sandbox: Perform the entire upgrade process in a non-production environment that mirrors your production setup.
  • Separate custom code: Ensure all your custom code related to Buy with Prime, such as custom controllers or templates, resides in a separate custom cartridge.
  • Plan testing: Conduct comprehensive testing after the upgrade to ensure all functionalities, including your customizations, work correctly.
  • Prepare rollback plan: Have a well-defined rollback plan in case you encounter issues during or after the upgrade.

Upgrade the Buy with Prime cartridge

Step 1: Download latest version

Download the latest Buy with Prime cartridge version from the Buy with Prime for Salesforce Commerce Cloud GitHub repository.

Step 2: Update metadata

If you need to update metadata, do the following:

  1. Import the new metadata into your Salesforce Commerce Cloud instance using Business Manager.
  2. Update your site metadata in the Buy with Prime cartridge. For details, see Update your site metadata in the Buy with Prime cartridge.
  3. Import your site metadata to Salesforce Commerce Cloud. For details, see Import your site metadata to Salesforce Commerce Cloud.

Step 3: Compare changes

  1. Save a copy of your current int_buywithprime_sfra and int_buywithprime cartridges for reference.
  2. Compare the changes between the new and old versions of the int_buywithprime_sfra cartridge, focusing on updates to controllers, models, scripts, and templates. For details on comparing commits and branches, see Comparing commits.
  3. Identify any new controller routes such as replace, append, or prepend, or file overrides that were not present in your previous integration.
  4. To ensure your integration remains up-to-date, manually merge any changes from the new cartridge version into your customized files.

Step 4: Update Subresource Integrity (SRI)

If upgrading from before version 0.13.0 of the cartridge, update SRI. For details, see Update Subresource Integrity Hash Values for Scripts in the Buy with Prime Cartridge.

Step 5: Build the cartridge

  1. At a command prompt, open your buy-with-prime-for-salesforce-commerce-cloud directory.
  2. Change directory to the cartridges directory.
  3. Run npm install.
  4. Run npm run build.

Step 6: Upload cartridges

Upload the cartridges using Prophet or run npm run uploadCartridge.

Post-upgrade testing

Use the following recommended progression for testing and deploying the upgraded Buy with Prime cartridge:

  1. Sandbox testing: Test Buy with Prime functionality through manual and regression testing in the sandbox environment.
  2. QA environment: Deploy and test the upgraded cartridge in the QA environment.
  3. Staging/UAT: After QA approval, deploy the cartridge to staging for user acceptance testing (UAT).
  4. Production: After successful UAT completion, deploy the cartridge to production.

Post-upgrade rollback

If issues occur during or after the upgrade, do the following:

  1. Restore the previous versions of the int_buywithprime_sfra and int_buywithprime cartridges.
  2. If you applied any metadata updates during the upgrade process, revert any configurations such as custom site preference values or service credentials back to the previous state.
  3. Build the Buy with Prime cartridge.
  4. To upload the restored int_buywithprime_sfra and int_buywithprime cartridges to your SFCC instance, use Prophet or run npm run uploadCartridge.

Related topics

Updated 25 days ago