Integrating the Amazon Selling Partner API

In order to access the data through the Amazon Selling Partner API (SP-API), you must complete the following actions:

1. Register as an SP-API developer

2. Request SP-API roles

3. Register your application

4. Select an authorization model for your application

5. Connect to the SP-API

Register as an SP-API developer

Before you can register your SP-API application, you must create an Amazon developer account and register as an SP-API developer. For a comprehensive overview of the developer registration process, see SP-API Registration Overview in the SP-API documentation.

Request SP-API roles

An SP-API role determines whether a developer or application has access to a specific 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. They limit data access to make sure that developers can access only the data that is required for their application. This helps protect customer data and preserve customer trust.

Accessing the data available in the brand analytics reports requires that you have the Brand Analytics role. For more information about requesting access to a role, see How do I request and qualify for a role in the SP-API documentation.

Register your application

The registration process varies slightly depending on the application type. For the purposes of registration, applications are categorized as one of the following types:

• Public applications and private seller applications – These are applications that are publicly available and are authorized by a seller or vendor, or they are seller applications that are available only to your organization and are self-authorized.

• Private vendor applications – These are vendor applications that are available only to your organization and are self-authorized.

For more information, see Register your application in the SP-API documentation.

Select an authorization model for your application

The authorization model for the Selling Partner API is based on Login with Amazon, an Amazon implementation of OAuth 2.0. Your application is authorized through interactions with pages displayed by Amazon and your website. The web browser is the user-agent that passes parameters between your website and Amazon at each selling partner action. To implement OAuth authorization, you must configure your website to accept and process the parameters that Amazon passes to it. You must also configure your website to redirect the web browser and pass parameters to Amazon. For more information about authorization, see Authorizing Selling Partner API applications in the SP-API documentation.

Understand application authorization

For the purposes of authorization, there are three types of applications:

• Public applications for sellers – These applications are publicly available and are authorized by sellers. You can choose one of the following authorization workflows:

  • Selling Partner Appstore authorization workflow – An OAuth authorization workflow that is initiated from the Selling Partner Appstore detail page.

  • Website authorization workflow – An OAuth authorization workflow that is initiated from your own website.

• Public applications for vendors – These applications are publicly available and are authorized by vendors. You can use the Website authorization workflow. This is an OAuth authorization workflow that is initiated from your own website.

• Private applications for sellers or vendors – These applications are available only to your organization. These can be seller or vendor applications. You can use the Self authorization approach. When you create a private application for your own organization you can self-authorize it to access your account information. You can self-authorize your application in draft status; there is no reason to publish a private application. For information about revoking self-authorization from seller and vendor applications, see Revoke self-authorizations in the SP-API documentation.

Authorize vendor groups for application access

When you authorize your Selling Partner API application to access your data, you are granting access to the vendor group that is associated with the sign-in credentials for your Vendor Central account. By extension, you are granting access to all vendor codes that are present in the vendor group. Therefore, it's important to use the right Vendor Central credentials and vendor group for your Selling Partner API integration.

The vendor group is the account you log in to. Depending on your business agreements, operation models, and other factors, your vendor group can include one or more vendor codes. Each vendor code allows you to list products in a specific category, or it includes the necessary business agreements, such as one vendor code for a particular brand.

You can have multiple authorizations for each vendor group, or you can create a single vendor group that contains all of your vendor codes. The option to use multiple vendor groups that are associated with your profile gives you the ability to use an application with the same vendor code in different vendor groups. With this option, you don't have to submit multiple vendor developer applications for each vendor group.

For more information, see Authorize vendor groups for application access in the SP-API documentation.

Connect to the SP-API

After you have registered and authorized your application, you can start making requests. For more information, see Connecting to the Selling Partner API in the SP-API documentation.