Install the Salesforce OMS Package for Buy with Prime

📘

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.

The Salesforce OMS package for Buy with Prime provides a seamless integration between the Salesforce OMS, Buy with Prime, and your Salesforce Commerce Cloud storefront. Before installing the OMS package for Buy with Prime, complete the prerequisites related to the Salesforce OMS. For details about the prerequisites, see Configure the Salesforce OMS and Provision a B2C Commerce Connection.

When installing the OMS package for Buy with Prime, first install the OMS package, and then install the OMS extension package. The extension package contains Salesforce invocable methods that you can use in the Salesforce Flow tool to integrate your workflow with Buy with Prime.

Install the Salesforce OMS package for Buy with Prime

The OMS package for Buy with Prime cartridge is available through your Buy with Prime solutions architect. To install the OMS package, do the following:

  1. Reach out to your Buy with Prime solutions architect to get the package ID for the OMS package for Buy with Prime.
  2. In a browser, enter the following URL to install the OMS package in your Salesforce production environment. Replace {Package ID} with the package ID.
    https://login.salesforce.com/packaging/installPackage.apexp?p0={Package ID}
    
    Alternatively, enter the following URL to install the OMS package in a sandbox environment for testing. For details, in the Salesforce documentation, see Sandboxes: Staging Environments for Customizing and Testing.
    https://test.salesforce.com/packaging/installPackage.apexp?p0={Package ID}
    
  3. If you're not already logged in to the Salesforce organization where you want to install the OMS package, log in to your Salesforce organization when prompted.
  4. Click Install for Admins Only, and then click Install.
    By installing the OMS package for administrators only, you can control access to the OMS package after installation.
  5. Under Approve Third-Party Access, select the checkboxes to allow data to be sent between your Salesforce organization and the OMS package for Buy with Prime, and then click Continue.

For details about installing Salesforce packages, in the Salesforce documentation see Installing Packages.

Install the OMS extension package for Buy with Prime

The OMS extension package for Buy with Prime contains Salesforce invocable methods. In the Salesforce Flow tool, you can use the invocable methods to customize your workflow to integrate with Buy with Prime.

Before installing the OMS extension package for Buy with Prime, install the Salesforce OMS package for Buy with Prime. Errors occur if you attempt to install the extension package without first installing the OMS package.

Do the following to install the OMS extension package:

  1. Reach out to your Buy with Prime solutions architect to get the package ID for the OMS extension package.
  2. In a browser, enter the following URL to install the extension package in your Salesforce production environment. Replace {Package ID} with the package ID.
    https://login.salesforce.com/packaging/installPackage.apexp?p0={Package ID}
    
    Alternatively, enter the following URL to install the extension package in a sandbox environment for testing. For details, in the Salesforce documentation, see Sandboxes: Staging Environments for Customizing and Testing.
    https://test.salesforce.com/packaging/installPackage.apexp?p0={Package ID}
    
  3. If you're not already logged in to the Salesforce organization where you want to install the extension package, log in to your Salesforce organization when prompted.
  4. Click Install for Admins Only.
    By installing the extension package for administrators only, you can control access to the extension package after installation.
  5. Under Advanced Options, click Compile all Apex in the org (default), and then click Install.

Verify installation of the OMS package for Buy with Prime

After installing the OMS package for Buy with Prime and the OMS extension package, do the following to verify the installation:

  1. In your Salesforce organization, click the App Launcher.
  2. On the App Launcher menu, in the search box, type Amazon Buy with Prime for OMS.
  3. Verify that Amazon Buy with Prime for OMS appears in the list.

Related topics

Configure the Salesforce OMS and Provision a B2C Commerce Connection
Steps for Installing the Salesforce OMS Package for Buy with Prime