Sellers API v1 Reference
Retrieve seller account information.
Overview
The Selling Partner API for Sellers (Sellers API) provides essential information about seller accounts, such as:
- The marketplaces a seller can list in
- The default language and currency of a marketplace
- Whether the seller has suspended listings
Refer to the Sellers API reference for details about this API's operations, data types, and schemas.
Version information
Version : v1
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
getMarketplaceParticipations
getAccount
Paths
GET /sellers/v1/marketplaceParticipations
Operation: getMarketplaceParticipations
Description
Returns a list of marketplaces where the seller can list items and information about the seller's participation in those marketplaces.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.016 | 15 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Marketplace participations successfully retrieved. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 403 | 403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 415 | The entity of the request is in a format not supported by the requested resource. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 500 | Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string) : Unique request reference identifier. | GetMarketplaceParticipationsResponse |
GET /sellers/v1/account
Operation: getAccount
Description
Returns information about a seller account and its marketplaces.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 0.016 | 15 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 404 | The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 413 | The request size exceeded the maximum accepted size. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 415 | The request payload is in an unsupported format. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetAccountResponse |
Definitions
Error
Error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition in a human-readable form. | string |
| details optional | Additional details that can help you understand or fix the issue. | string |
ErrorList
A list of error responses returned when a request is unsuccessful.
Type : < Error > array
MarketplaceParticipation
| Name | Description | Schema |
|---|---|---|
| marketplace required | Information about an Amazon marketplace where a seller can list items and customers can view and purchase items. | Marketplace |
| participation required | Information that is specific to a seller in a marketplace. | Participation |
MarketplaceParticipationList
List of marketplace participations.
Type : < MarketplaceParticipation > array
GetMarketplaceParticipationsResponse
The response schema for the getMarketplaceParticipations operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getMarketplaceParticipations operation. | MarketplaceParticipationList |
| errors optional | The errors encountered by the getMarketplaceParticipations operation. | ErrorList |
Marketplace
Information about an Amazon marketplace where a seller can list items and customers can view and purchase items.
| Name | Description | Schema |
|---|---|---|
| id required | The encrypted marketplace value. | string |
| name required | The marketplace name. | string |
| countryCode required | The ISO 3166-1 alpha-2 format country code of the marketplace. Pattern : "^([A-Z]{2})$" | string |
| defaultCurrencyCode required | The ISO 4217 format currency code of the marketplace. | string |
| defaultLanguageCode required | The ISO 639-1 format language code of the marketplace. | string |
| domainName required | The domain name of the marketplace. | string |
Participation
Information that is specific to a seller in a marketplace.
| Name | Description | Schema |
|---|---|---|
| isParticipating required | If true, the seller participates in the marketplace. Otherwise false. | boolean |
| hasSuspendedListings required | Specifies if the seller has suspended listings. true if the seller Listing Status is set to Inactive, otherwise false. | boolean |
GetAccountResponse
The response schema for the getAccount operation.
MarketplaceLevelAttributes
Attributes that define the seller's presence and status within a specific marketplace. These attributes include the marketplace details, store name, listing status, and the selling plan the seller is subscribed to.
| Name | Description | Schema |
|---|---|---|
| marketplace required | Information about an Amazon marketplace where a seller can list items and customers can view and purchase items. | Marketplace |
| storeName required | The name of the seller's store as displayed in the marketplace. | string |
| listingStatus required | The current status of the seller's listings. | enum (ListingStatus) |
| sellingPlan required | The selling plan details. | enum (SellingPlan) |
Account
The response schema for the getAccount operation.
| Name | Description | Schema |
|---|---|---|
| marketplaceLevelAttributes required | A list of details of the marketplaces where the seller account is active. | < MarketplaceLevelAttributes > array |
| businessType required | The type of business registered for the seller account. | enum (BusinessType) |
| business optional | Information about the seller's business. Certain fields may be omitted depending on the seller's businessType. | Business |
| primaryContact optional | Information about the seller's primary contact. | PrimaryContact |
Business
Information about the seller's business. Certain fields may be omitted depending on the seller's businessType.
| Name | Description | Schema |
|---|---|---|
| name required | The registered business name. | string |
| registeredBusinessAddress required | The registered business address. | Address |
| companyRegistrationNumber optional | The seller's company registration number, if applicable. This field will be absent for individual sellers and sole proprietorships. | string |
| companyTaxIdentificationNumber optional | The seller's company tax identification number, if applicable. This field will be present for certain business types only, such as sole proprietorships. | string |
| nonLatinName optional | The non-Latin script version of the registered business name, if applicable. | string |
Address
Represents an address
| Name | Description | Schema |
|---|---|---|
| addressLine1 required | Street address information. | string |
| addressLine2 optional | Additional street address information. | string |
| countryCode required | The country code in two-character ISO 3166-1 alpha-2 format. | string |
| stateOrProvinceCode optional | The state or province code. | string |
| city optional | The city. | string |
| postalCode optional | The postal code. | string |
PrimaryContact
Information about the seller's primary contact.
| Name | Description | Schema |
|---|---|---|
| name required | The full name of the seller's primary contact. | string |
| address required | The primary contact's residential address. | Address |
| nonLatinName optional | The non-Latin script version of the primary contact's name, if applicable. | string |
BusinessType
The type of business registered for the seller account.
Type : enum
| Value | Description |
|---|---|
| CHARITY | The business is registered as a charity. |
| CRAFTSMAN | The business is registered as a craftsman. |
| NATURAL_PERSON_COMPANY | The business is a natural person company. |
| PUBLIC_LISTED | The business is a publicly listed company. |
| PRIVATE_LIMITED | The business is a private limited company. |
| SOLE_PROPRIETORSHIP | The business is a sole proprietorship. |
| STATE_OWNED | The business is state-owned. |
| INDIVIDUAL | The entity is not a business but an individual. |
ListingStatus
The current status of the seller's listings.
Type : enum
| Value | Description |
|---|---|
| ACTIVE | The seller's listings are currently active. |
| INACTIVE | The seller's listings are currently inactive. |
SellingPlan
The selling plan details.
Type : enum
| Value | Description |
|---|---|
| PROFESSIONAL | The seller has a professional selling plan. |
| INDIVIDUAL | The seller has an individual selling plan. |
Updated 2 months ago