📘

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

To send events to the Salesforce API, in your Salesforce organization you must create a Salesforce connected app for Buy with Prime. For details about Salesforce connected apps, in the Salesforce documentation see Connected Apps.

Create a Salesforce connected app

To create a Salesforce connected app for Buy with Prime, do the following:

1. In your Salesforce organization, open Setup.
2. In the search box, enter app manager.
3. Choose App Manager, and then choose New Connected App.
4. Choose Create a Connected App, and then choose Continue.
5. Under Basic Information, do the following:
   • In the Connected App Name box, enter Amazon Buy with Prime.
   • In the API Name box, enter Amazon_Buy_With_Prime.
   • In the Contact Email box, enter your email address.
6. Under API (Enable OAuth Settings), select Enable OAuth Settings, and then do the following:
   • In the Callback URL box, enter the URL for your Salesforce organization to which you want to redirect the user after authentication.
   • In the Available OAuth Scopes box, select Manage user data via APIs (api), and then choose Add.
   • In the Available OAuth Scopes box, select Perform requests at any time (refresh_token, offline_access), and then choose Add.
   • Clear Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows.
   • Select Enable Client Credentials Flow.
7. Choose Save, and then choose Continue.

Assign a user to the client credentials flow

The Salesforce connected app processes events in the context of the user that you choose for the client credentials flow. The package logs show the user performing events such as updating a fulfillment order or creating a return order.

To assign a user to the client credentials flow, do the following:

1. In your Salesforce organization, open Setup.
2. In the search box, enter manage connected apps.
3. Choose Manage Connected Apps, and then choose Amazon Buy with Prime.
4. Choose Edit Policies.
5. Under Client Credentials Flow, next to the Run As box, choose the magnifying glass button, which has the tooltip Run As Lookup (New Window).
6. Choose the user.
7. Choose Save.

Grant permissions to the user of the client credentials flow

If the user of the client credentials flow in your Salesforce connected app isn't an administrator, clone the Amazon Buy with Prime for OMS API User permission set and then assign the cloned permission set to the user. The Amazon Buy with Prime for OMS API User permission set provides access to update orders, handle returns, and perform other API actions. For details, see Understand Permission Sets in the OMS Package for Buy with Prime.

After cloning and modifying the permission set, assign the cloned permission set to a user who isn't an administrator. For details about assigning a permission set to a user, see Understand Permission Sets in the OMS Package for Buy with Prime.

Clone the permission set

By cloning the Amazon Buy with Prime for OMS API User permission set, you can add permissions for objects or fields while leaving the original permission set unchanged as the baseline for future configuration. For each user who needs access, clone the permission set and customize the cloned permission set to be specific to the user.

To clone the permission set, do the following:

1. In your Salesforce organization, open Setup.
2. In the search box, enter permission sets.
3. Click Permission Sets.
4. Next to Amazon Buy with Prime for OMS API User, choose Clone.
5. In the Label box, enter a name for the permission set.
6. In the API Name box, enter an API name for the permission set.
7. Choose Save.

Update the object-level and field-level settings in the cloned permission set

In the cloned permission set, grant field-level permissions to each custom field in your data mapping. The baseline Amazon Buy with Prime for OMS API User permissions set grants broad permissions. You need to grant permissions for any new fields.

For each Salesforce object mapped to an associated Buy with Prime entity, provide the object-level permissions shown in the following table:

To open the object settings in the cloned permission set, do the following:

1. In your Salesforce organization, open Setup.
2. In the search box, enter permission sets.
3. Click Permission Sets.
4. Choose the label that matches the name you assigned to your cloned permission set.
5. Under Apps, choose Object Settings.

For each Salesforce object, to grant object-level and field-level permissions for your data mapping, do the following:

1. Choose the Salesforce object in your data mapping, for example Orders.
2. Choose Edit.
3. Under Object Permissions, select each permission you want to grant.
4. Under Field Permissions, select Read Access and Edit Access adjacent to each field to which you want to grant access.

For details on how to map Buy with Prime data to Salesforce objects, see Map Your Buy with Prime Data to Your Salesforce Objects.

Retrieve the consumer key and consumer secret

The Salesforce connected app for Buy with Prime generates a consumer key and consumer secret that you can use to configure the AWS middleware. To retrieve the consumer key and consumer secret, do the following:

1. In your Salesforce organization, open Setup.
2. In the search box, enter app manager, and then choose App Manager.
3. In the row for Amazon Buy with Prime, open the menu, and then choose View.
4. Next to Consumer Key and Secret, choose Manage Consumer Details.
5. In the Verification Code box, enter your verification code, and then choose Verify.
6. Next to Consumer Key, see the consumer key.
7. Next to Consumer Secret, see the consumer secret.

For details about keeping the Salesforce connected app more secure by periodically changing the consumer secret, in the Salesforce documentation, see Rotate the Consumer Key and Consumer Secret of a Connected App.

Retrieve the domain URL for your Salesforce organization

The Salesforce organization shows the domain URL, which you can use to configure the AWS middleware. To retrieve the domain URL, do the following:

1. In your Salesforce organization, open Setup.
2. In the search box, enter my domain.
3. Choose My Domain.
4. Next to Current My Domain URL, see the domain for your Salesforce organization.

Related topics

Configure the Salesforce OMS Package for Buy with Prime
Map Your Buy with Prime Data to Your Salesforce Objects