📘

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

Install the Amazon Pay cartridge alongside the Buy with Prime cartridge so that shoppers can use the payment methods stored in their Amazon account. Shoppers can place an order without needing to manually enter their payment details, which helps streamline the checkout experience.

Using Amazon Pay as a payment method

Using Amazon Pay for Buy with Prime means that your shoppers can only use the payment methods supported by Amazon Pay for their Buy with Prime orders. You can use Buy with Prime without integrating Amazon Pay to allow your customers to use the existing payment options and digital wallets that your site already supports.

Amazon Pay Checkout v2 only supports a single payment per authorization charge. The Buy with Prime cartridge creates a single payment authorization charge per order by default. To charge when each item or shipment is fulfilled for orders with multiple shipments, customize the Amazon Pay cartridge to generate multiple authorization charges.

Consider installing and testing the Amazon Pay cartridge before integrating the Buy with Prime cartridge. Follow all the steps below and place test orders using your Amazon Pay sandbox for payment. For details about how to test using your Amazon Pay sandbox, see Creating Sandbox test buyer accounts.

Integrating Amazon Pay and Buy with Prime

To install and integrate the Amazon Pay and Buy with Prime cartridges, do the following:

1. Register for Amazon Pay. For details about how to register, see Use Amazon Pay for Shopper Identity.
2. Install the Amazon Pay Checkout v2 cartridge for Salesforce Commerce Cloud. For details about how to install Amazon Pay Checkout v2, see Upgrading to Checkout v2.
3. Install the Buy with Prime Cartridge for Salesforce Commerce Cloud. For details, see Install the Buy with Prime Cartridge.
4. Go to your site preferences and look for the Buy with Prime preference group. Make sure that the BWP_Payment_Processor preference is set to the value AmazonPay. For details about how to configure your site preferences, see Configure the preferences for your site.

The Buy with Prime cartridge overrides and extends the functionality of the Amazon Pay cartridge. To avoid conflicts between the cartridges, your site's cartridge path must include Buy with Prime to the left of Amazon Pay. For example:

int_buywithprime_sfra:int_buywithprime:int_amazonpay_sfra:int_amazonpay:app_storefront_base

For details about configuring your site's cartridge path, see Assign the Buy with Prime cartridge to your site.

Upgrade to a supported version of the Amazon Pay cartridge

Buy with Prime requires Amazon Pay Checkout v2, which is supported by Amazon Pay cartridge version 24.1.1 or later. To find your Amazon Pay cartridge version, look at the last line of the int_amazonpay/cartridge/templates/resources/amazon.properties file. If you're using an earlier version of the Amazon Pay cartridge, upgrade to a version that supports Amazon Pay Checkout v2 before installing the Buy with Prime cartridge.

For example: amazon.cartridge.version=PRE-v24.01.02