Manage Access to the Custom Fields 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.
Custom fields for Buy with Prime
The Salesforce OMS package for Buy with Prime creates the following custom fields on the default Salesforce OMS objects:
Salesforce object | Salesforce field | Buy with Prime API |
---|---|---|
Fulfillment Orders FulfillmentOrder | Amazon Buy with Prime Order Id Amazon_bwp_oms__amazonBwpOrderID__c | Order.Id |
Fulfillment Order Products FulfillmentOrderLineItem | Amazon Buy with Prime Order Line Id Amazon_bwp_oms__amazonBwpOrderLineID__c | Order.LineItems.Id |
Orders Order | Amazon Buy with Prime Order ID Amazon_bwp_oms__amazonBwpOrderID__c | Order.Id |
Orders Order | Amazon Pay Charge Permission ID Amazon_bwp_oms__amzPayChargePermissionId__c | ChargePermissionId |
Order Products OrderItem | Amazon Buy with Prime Order Product Id amazonBwpOrderLineID__c | Order.LineItems.Id |
Return Orders ReturnOrder | Amazon BwP Return Fulfillment Id Amazon_bwp_oms__amazonBwpOrderID__c | refunds.details.id or returns.details.id |
Return Order Line Items ReturnOrderLineItem | Amazon Buy with Prime Order Line Id Amazon_bwp_oms__amazonBwpOrderLineID__c | refunds.details.id Order.LineItems.Id or returns.details.id Order.LineItems.Id |
Use your permission sets to manage user access to the custom fields
To help ensure that a user can access the custom fields created by the Salesforce OMS package, you can assign the Amazon Buy with Prime for OMS Setup User permission set to the user, which grants the necessary permissions. The Amazon Buy with Prime for OMS Setup User permission set grants broad permissions and contains administrator functionality. For details about the Amazon Buy with Prime for OMS Setup User permission set, see Understand Permission Sets in the OMS Package for Buy with Prime.
Alternatively, to selectively grant permissions or grant different permissions to different users, you can create a new permission set or modify an existing permission set and grant access to each custom field as needed. You can then assign the permission set to users who don't have Amazon Buy with Prime for OMS Setup User permissions. Creating and modifying permission sets can help you organize your access control, avoid unintended changes to user permissions, and simplify future updates to permissions.
For details about creating a permission set, in the Salesforce documentation see Create Permission Sets.
Modify a permission set to grant access to the custom fields
After you create a permission set, you can modify the permission set to grant access to the custom fields for Buy with Prime. Repeat the following for each custom field that you want to include in the permission set:
- In your Salesforce organization, under Setup, click Users.
- Click Permission Sets.
- Click the permission set that you want to modify.
- Click Object Settings.
- Click an object that has custom fields for Buy with Prime, for example Fulfillment Orders.
- Under Field Permissions, next to the field to which you want to grant access, for example Amazon Buy with Prime Order Id, select the Read and Edit checkboxes.
Make sure to grant both Read and Edit access. Without Edit access, users might encounter issues updating custom fields, which can cause errors or disrupt data synchronization. - Click Save.
Add the custom fields to your page layouts
In addition to granting users access to the custom fields for Buy with Prime, you need to add the custom fields to your page layouts to make the data visible when viewing your records. To add the custom fields to your page layouts, repeat the following for each custom field and your corresponding page layouts:
- In your Salesforce organization, under Setup, click the Object Manager tab.
- Click an object that has custom fields for Buy with Prime, for example Fulfillment Orders.
- Click Page Layouts.
- Click the page layout that you want to modify, for example Fulfillment Order Layout.
- In the palette, click Fields.
- From the palette, click and drag the custom field, for example Amazon Buy with Prime Order Id, to your page layout.
- Click Save.
For details about adding fields to pages, in the Salesforce documentation see Customize Page Layouts with the Enhanced Page Layout Editor.
Related topics
Steps for Installing the Salesforce OMS Package for Buy with Prime
Updated 14 days ago