Get Authorization to Manage a Shop Direct merchant's Shop Direct Listings

📘

Note

This page applies to solution providers who integrate with Shop Direct on behalf of Shop Direct merchants.

Before your public application can manage a Shop Direct merchant's Shop Direct listings, the Shop Direct merchant must authorize your application to access their account through an OAuth workflow.

Shop Direct uses the standard SP-API website authorization workflow. Shop Direct merchants start the process from your website by clicking an Authorize button that you configure. Because Shop Direct is available in the US store only, the authorization URI must use the US Seller Central URL (https://sellercentral.amazon.com).

If you already have a registered redirect URI for another SP-API integration, you can reuse the URI for Shop Direct. The response parameters (state, selling_partner_id, spapi_oauth_code) are the same.

If you are a Shop Direct merchant who integrates your own catalog through a private application, you do not need to complete this tutorial. Manage your authorizations through the Solution Provider Portal.

Shop Direct is available in the US store (ATVPDKIKX0DER) only. For an overview of how Shop Direct works, refer to What is Shop Direct?

Prerequisites

To complete this tutorial, you need:

• A registered SP-API public application that has been approved for the Shop Direct role.
• A Shop Direct merchant who has signed up for Shop Direct in the Shop Direct merchant workspace.
• A redirect URI that is registered for your application. You can reuse an existing redirect URI from another SP-API integration.
• Familiarity with the SP-API website authorization workflow, including URI construction, parameter reference, token exchange details, and security best practices.

Step 1: Construct the authorization URI

Construct your authorization URI by using the following base URL and query parameters:

Base URL: https://sellercentral.amazon.com/apps/authorize/consent

Query parameters:

Example authorization URI:

https://sellercentral.amazon.com/apps/authorize/consent?application_id=amzn1.sp.solution.example&redirect_uri=https://example.com/callback&state=example-state-value

You do not need to support multiple regions or Vendor Central URLs for Shop Direct.

For details on URI construction and security best practices, refer to Authorize public applications.

Step 2: Add the Authorize button to your website

Add an Authorize button or link to your website that directs Shop Direct merchants to the authorization URI that you constructed in Step 1. When a Shop Direct merchant clicks the button, your application redirects the Shop Direct merchant to the US Seller Central authorization page.

Step 3: The Shop Direct merchant grants permission in the Shop Direct merchant workspace

After the Shop Direct merchant clicks the Authorize button on your website, the Shop Direct merchant is redirected to the Shop Direct merchant workspace in Seller Central. The Shop Direct merchant signs in and grants your application permission to access their account.

The Shop Direct merchant grants permission in the Shop Direct merchant workspace rather than on the standard Seller Central consent page.

📘

Note

The Shop Direct merchant workspace displays solution provider authorizations only. If a Shop Direct merchant has also created a private application, those authorizations are not displayed in the merchant workspace. Shop Direct merchants with private applications are directed to the Solution Provider Portal to manage those authorizations.

Step 4: Handle the authorization response

After the Shop Direct merchant grants permission, Amazon redirects the Shop Direct merchant to your redirect URI with the following query parameters:

Exchange the spapi_oauth_code for a refresh token by calling the LWA authorization server. For details on the token exchange process, refer to Authorize public applications.

After you receive the refresh token, your application can make SP-API calls on behalf of the Shop Direct merchant to submit and manage their Shop Direct listings.