Sellers API v1 Use Case Guide

API Version: 1

What is the Sellers API?

The Selling Partner API for Sellers (Sellers API) provides information about seller accounts and marketplaces. The returned information includes:

• The marketplaces in which the seller can list items
• The default language and currency of a marketplace
• Whether the seller has suspended listings
• Business information of the seller

For details about the operations, data types, and schemas of the Sellers API, refer to Sellers API v1 Reference.

❗

Warning

The getAccount operation is currently in beta. To avoid errors and unexpected behavior, do not use this operation until it is released for general availability.

Tutorial: Get the account information of a seller

Learn how to retrieve the account information of a seller. The information that you retrieve includes a list of marketplace participations, business information, and selling plan details.

Prerequisites

To complete this tutorial, you must complete the following prerequisites:

• The selling partner must authorize you to call the Selling Partner API (SP-API) on their behalf. For details about how selling partners can authorize an application to call the SP-API on their behalf, refer to Authorizing Selling Partner API Applications.
• Your developer profile must include the Finance and Accounting role. To learn about roles, refer to Roles in the Selling Partner API.
• The app registration page for your application must include the Finance and Accounting role.

Get account information

Call the getAccount operation.

Request parameters

None.

Request example

GET /sellers/v1/account

Response properties

A successful response includes the following properties.

Response example

{
  "businessType": "PRIVATE_LIMITED",
  "marketplaceParticipationList": [
    {
      "marketplace": {
        "id": "ATVPDKIKX0DER",
        "name": "United States",
        "countryCode": "US",
        "domainName": "www.amazon.com"
      },
      "storeName": "BestSellerStore",
      "participation": {
        "isParticipating": true,
        "hasSuspendedListings": false
      }
    }
  ],
  "sellingPlan": "PROFESSIONAL",
  "business": {
    "name": "BestSeller Inc.",
    "nonLatinName": "ベストセラー株式会社",
    "registeredBusinessAddress": {
      "addressLine1": "123 Main St",
      "addressLine2": "Suite 500",
      "city": "Seattle",
      "stateOrProvinceCode": "WA",
      "postalCode": "98101",
      "countryCode": "US"
    },
    "companyRegistrationNumber": "123456789",
    "companyTaxIdentificationNumber": "987654321"
  },
  "primaryContact": {
    "name": "John Doe",
    "nonLatinName": "ジョン・ドゥ",
    "address": {
      "addressLine1": "456 Oak St",
      "addressLine2": "Apt 12",
      "city": "Seattle",
      "stateOrProvinceCode": "WA",
      "postalCode": "98102",
      "countryCode": "US"
    }
  }
}

Tutorial: Get the market participation of a seller

Learn how to get a list of Amazon marketplaces in which the seller can list items. The information that you retrieve includes marketplace information, the seller's store name in the marketplace, whether the seller participates in the marketplace, and whether the seller has suspended listings in the marketplace.

Prerequisites

To complete this tutorial, you must complete the following prerequisites:

• The selling partner must authorize you to call the Selling Partner API (SP-API) on their behalf. For details about how selling partners can authorize an application to call the SP-API on their behalf, refer to Authorizing Selling Partner API Applications.
• Your developer profile must include the Finance and Accounting role. To learn about roles, refer to Roles in the Selling Partner API.
• The app registration page for your application must include the Finance and Accounting role.
• The marketplace identifier of the marketplace for which you want data. For a list of marketplace identifiers, refer to Marketplace IDs.

Get marketplace participation

Call the getMarketplaceParticipations operation.

Request parameters

None.

Request example

GET /sellers/v1/marketplaceParticipations

Response

A successful response includes the following elements.

Response example

[
  {
    "marketplace": {
      "id": "ATVPDKIKX0DER",
      "name": "Amazon.com",
      "countryCode": "US",
      "defaultCurrencyCode": "USD",
      "defaultLanguageCode": "en_US",
      "domainName": "www.amazon.com"
    },
    "storeName": "BestSellerStore",
    "participation": {
      "isParticipating": true,
      "hasSuspendedListings": false
    }
  }
]