Roles in the Selling Partner API
Learn how to use roles in Selling Partner API.
What is a role?
A role is the mechanism used by Selling Partner APIs to determine whether a developer or application has access to an operation or resource. As a developer, you must request and qualify for a particular role, or you will not be able to access the operations and resources grouped under that role. Roles protect access to personally identifiable information (PII) and other sensitive data, and limit data access to ensure developers only access data that is required for an application. This helps ensure that customers trust Amazon and trust Selling Partner Services businesses that employ the Selling Partner APIs.
Role definitions
In the following table, Restricted means the role requires sensitive information which might include personally identifiable information (PII). You will be required to provide additional information about your use of the data and your security controls.
Role | Description |
---|---|
Brand Analytics | Access reports that contain information about seller and vendor performance on Amazon and consumer
behavior reports that give insight into how customers find and purchase a selling partner's products on
Amazon.
Example operations that require this role assignment:
|
Product Listing | Create and manage product listings.
Generally used for product catalog related reports and feeds, and operations.
Examples of operations that require this role assignment:
|
Pricing | Determine list prices and automate product pricing.
Generally used for pricing related reports, feeds and operations.
Examples of operations that require this role assignment:
|
Amazon Fulfillment | Ship to Amazon, and Amazon ships directly to customers (Fulfillment by Amazon (FBA), Amazon Fulfillment
Network (AFN)).
Generally used for FBA Sales Reports, Order Tracking Reports, and operations related to order
fulfillment.
Examples of operations that require this role assignment:
|
Buyer Communication | Manage messaging to and from Amazon buyers.
Generally used for messaging to Amazon buyers using the Selling Partner API for Messaging.
Examples of operations that require this role assignment:
|
Buyer Solicitation | Solicit Amazon buyers for feedback.
Generally used to solicit Amazon buyers for feedback using the Selling Partner API for Solicitations.
Examples of operations that require this role assignment:
|
Selling Partner Insights | View information about the Amazon Selling Partner account and performance.
Generally used for reports and operations used to return seller insights.
Examples of operations that require this role assignment:
|
Finance and Accounting | Produce accounting and financial statements.
Generally used for creating accounting and financial statements.
Examples of operations that require this role assignment:
|
Inventory and Order Tracking | Analyze and manage inventory.
Generally used for FBA Sales Reports, Order Tracking Reports, and operations related to orders, vendor
orders, sales order metrics and inventory management. Operations that require this role do not use PII
required to ship an order. Rather, this role is required for applications that track order shipments to
manage inventory/manufacturing/purchasing.
Examples of operations that require this role assignment:
|
Amazon Warehousing and Distribution | Analyze and manage Amazon Warehousing and Distribution shipments and inventory. Generally used for interacting with AWD inventory information and shipment details using the Selling Partner API for Amazon Warehousing and Distribution. Examples of operations that require this role assignment:
|
Notifications in Seller Central | Send targeted notifications to sellers within Seller Central. Using the App Integrations API v2024-04-01, you can send notifications that inform the seller about their business or to encourage the seller to take action on your website. Examples of operations that require this role assignment:
|
Direct-to-Consumer Shipping (Restricted) | Ship orders directly to customers using their carrier of choice, including Amazon. Operations that
require this role use PII to enable shipping.
Generally used for Order Reports, Order Tracking Reports, EasyShip, and for operations related to
shipping orders placed on Amazon.
Example operations that require this role assignment:
|
Tax Invoicing (Restricted) | Generate tax invoices to comply with tax regulation. Operations that require this role require PII to
enable tax invoice generation.
Generally used for Tax Reports and Order Reports, and operations that return information about orders.
Examples of operations that require this role assignment:
|
Tax Remittance (Restricted) | Calculate and remit sales taxes. Operations that require this role might use PII to calculate sales taxes.
Generally used for FBA Sales Reports and Order Reports and operations that return information about
orders.
Examples of operations that require this role assignment:
|
Professional Services (Restricted) | Provides add-on services such as Room of Choice Delivery, Assembly and Installation to Amazon buyers. Generally used to provide add-on services to Amazon buyers using the Selling Partner API for Services. Examples of operations that require this role assignment:
|
Frequently Asked Questions
How do I request and qualify for a role?
You request and qualify for Selling Partner API roles by populating your Developer Profile. The specific information requested depends on whether you are an already existing Amazon Marketplace Web Service (MWS) developer or not, and whether you have previously registered.
After your profile is submitted, Amazon evaluates the information provided and approves or denies your request. If denied, you can address the reason for the denial and then resubmit your profile.
How do I choose the roles for my application?
When you create your Selling Partner API application on the application client creation page, you can choose roles from among those that were requested and approved in your developer profile. If the role you need is missing, you must update the roles in your developer profile to include it, and then resubmit your profile for evaluation by Amazon. After approval, the added role will be available to select for your application.
Note: If you have a published hybrid SP-API application you must relist your application before reauthorization.
How do I determine what roles to request?
Review the role descriptions in this document to understand the purpose of each role, and to get examples of the resources and operations governed by each role. For each role, use the link provided to navigate to documentation that provides a complete list of the operations and the feed, report, and notification types that require the role.
What happens when I call an operation for which I do not have the required role(s)?
The response to the request will have an HTTP status code of 403 and error information in the response body.
How do I add a new role after my app has been published?
To add a new role after your app has been published, follow these steps:
- Go to your developer profile and submit a role to be added.
- After your developer profile is approved, go to your application configuration and apply the newly approved role to your application. Save the changes and re-list the application.
- After the application is approved, get new authorizations to generate a new refresh token that will grant access to the API operations, reports, feeds and notifications the new role will provide.
Updated 2 months ago