📘

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

The connector cartridge for Buy with Prime is an adapter that helps you integrate the Buy with Prime Cartridge for Salesforce Commerce Cloud with the Salesforce order management system (OMS). The connector cartridge takes relevant parameters from the main Buy with Prime cartridge and the Amazon Pay cartridge and creates namespaced counterparts in the connector cartridge. Jobs that synchronize Salesforce Commerce Cloud with the Salesforce OMS can read from the connector cartridge and store the values in the Salesforce OMS.

The following walks you through installing and configuring the connector cartridge in your Salesforce B2C Commerce instance. You need the connector cartridge if you're using the Buy with Prime cartridge in conjunction with the Salesforce OMS. If you aren't using the Salesforce OMS in your integration, you don't need the connector cartridge and can skip the following procedures.

Prerequisites

Set up your development environment

Set up your development environment with the following:

• An integrated development environment (IDE) of your choice.
• Node.js version 14.19 or later. For details about downloading and installing Node.js, see the Node.js website.
• Tools configured to upload your cartridges to Salesforce Commerce Cloud. For details, see the Salesforce documentation at Upload and Configure Cartridges.

Install and configure the Buy with Prime cartridge for Salesforce Commerce Cloud

Install and configure the main Buy with Prime Cartridge for Salesforce Commerce Cloud. If you install the connector cartridge without the Buy with Prime cartridge or vice versa, fields cannot be synchronized between Salesforce Commerce Cloud and the Salesforce OMS.

Clone the connector cartridge

Clone the connector cartridge. For details about the Git repository that contains the connector cartridge, work with your Buy with Prime solutions architect.

Install and upload the connector cartridge

Do the following to add the connector cartridge to your workspace and then upload the cartridge:

1. Open your IDE.
2. Navigate to the tools to add a directory to a workspace.
3. Browse to the directory where you cloned the connector cartridge.
4. Add the root folder for the connector cartridge to your workspace.
5. Use that tools that you've configured to upload your cartridge to Salesforce Commerce Cloud. For details, see the Salesforce documentation at Upload and Configure Cartridges.

Verify that you successfully uploaded the connector cartridge

Do the following:

1. Open the Business Manager tool for Salesforce Commerce Cloud.
2. From the Administration menu, under Site Development, click Code Deployment.
3. Click the link for the code version that you uploaded.
4. On the Version Summary page, verify that the connector cartridge appears in the list of cartridges.

Update the cartridge path to give precedence to the connector cartridge

You need to make the connector cartridge override the main Buy with Prime cartridge so that fields can be synchronized from Salesforce Commerce Cloud to the Salesforce OMS. The int_buywithprime_oms_connector_sfra and int_buywithprime_oms_connector cartridges must take precedence over the main Buy with Prime cartridge.

Do the following to update the cartridge path:

1. Open the Business Manager tool for Salesforce Commerce Cloud.
2. From the Administration menu, under Sites, click Manage Sites.
3. Click the name of the site that has your Buy with Prime integration.
4. Click the Settings tab.
5. In the Cartridges field, place int_buywithprime_oms_connector_sfra and int_buywithprime_oms_connector in the leftmost position in the colon-separated list of cartridges.
   For example, if you're using the Buy with Prime cartridge and using Amazon Pay as your payment service provider (PSP), specify int_buywithprime_oms_connector:int_buywithprime_oms_connector_sfra:int_buywithprime:int_buywithprime_sfra:int_amazonpay:int_amazonpay_sfra:app_storefront_base. If you're using the Buy with Prime cartridge with your own PSP, specify int_buywithprime_oms_connector:int_buywithprime_oms_connector_sfra:int_buywithprime:int_buywithprime_sfra:int_YOUR_PSP:app_storefront_base.
6. Click Apply.

Update and import the site metadata for the connector cartridge

By default, the connector cartridge adds the following attributes:

After the shopper places an order, the attributes persist in Salesforce Commerce Cloud and send asynchronously to the Salesforce OMS. The Salesforce OMS requires the Buy with Prime order attributes to map order data between the Salesforce OMS and Buy with Prime.

Do the following to import the attributes from the connector cartridge. If you customize the logic of the connector cartridge to add fields, repeat the following after the update.

1. Open the Business Manager tool for Salesforce Commerce Cloud.
2. From the Administration menu, under Site Development, click Import & Export.
3. Under Import & Export Files, click Upload.
4. Under Upload Import Files, click Choose File.
5. Navigate to the root folder for the connector cartridge, select the metadata/system-objecttype-definitions.xml file, and then click Upload.
6. Click Import & Export to return to the previous page, and then under Meta Data, click Import.
7. Select the latest system-objecttype-definitions.xml file, and then click Next.
8. After the page refreshes automatically to show that validation is complete, click Import.
9. Click Refresh to refresh the status.

The status column shows when the import is complete. If the import fails, click the link in the Process column to view the import log.

Verify the installation and configuration of the connector cartridge

To help ensure that the connector cartridge has been installed and configured correctly, do the following to place a Buy with Prime order and verify that the attributes from the connector cartridge are present.

1. In your storefront, place a Buy with Prime order.
2. Open the Business Manager tool for Salesforce Commerce Cloud.
3. From the Merchant Tools menu, under Ordering, click Orders.
4. Find the order by entering the Salesforce Commerce Cloud order identifier.
5. On the Attributes tab, go to the Buy with Prime Salesforce OMS connector section.
6. Confirm that values are present for Amazon Pay Charge Permission Id and Amazon BwP Order Id.
7. On the General tab, click Shipment.
8. In the shipment table, click Prime item Product Id.
9. On the Attributes tab, confirm that Amazon BwP Order Line Item Id has a value.

Next steps

After installing and configuring the connector cartridge, Create Your Product and Delivery Method for Buy with Prime.

Related topics

Install the Buy With Prime Cartridge