HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
Documentation
Developer HubAPI StatusSupport

Sellers API v1 Reference

Retrieve seller account information.

The Selling Partner API for Sellers lets you retrieve information on behalf of sellers about their seller account, such as the marketplaces they participate in. Along with listing the marketplaces that a seller can sell in, the API also provides additional information about the marketplace such as the default language and the default currency. The API also provides seller-specific information such as whether the seller has suspended listings in that marketplace.

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 that the seller submitting the request can sell in and information about the seller's participation in those marketplaces.

Usage Plan:

Rate (requests per second)Burst
0.01615

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Responses

HTTP CodeDescriptionSchema
200Marketplace 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
400Request 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
403403 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
404The 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
413The 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
415The 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
429The 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
500Encountered 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
503Temporary 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.01615

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAccountResponse
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetAccountResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetAccountResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetAccountResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetAccountResponse
503Temporary 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.

NameDescriptionSchema
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 the caller understand or fix the issue.string

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

MarketplaceParticipation

NameDescriptionSchema
marketplace
required
Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items.Marketplace
participation
required
Detailed information that is specific to a seller in a marketplace.Participation
storeName
required
The name of the seller's store as displayed in the marketplace.string

MarketplaceParticipationList

List of marketplace participations.

Type : < MarketplaceParticipation > array

GetMarketplaceParticipationsResponse

The response schema for the getMarketplaceParticipations operation.

NameDescriptionSchema
payload
optional
The payload for the getMarketplaceParticipations operation.MarketplaceParticipationList
errors
optional
A list of errors that occurred with the getMarketplaceParticipations operation.ErrorList

Marketplace

Detailed information about an Amazon market where a seller can list items for sale and customers can view and purchase items.

NameDescriptionSchema
id
required
The encrypted marketplace value.string
name
required
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

Detailed information that is specific to a seller in a marketplace.

NameDescriptionSchema
isParticipating
required
If true, the seller participates in the marketplace.boolean
hasSuspendedListings
required
If true, the seller has suspended listings.boolean

GetAccountResponse

The response schema for the getAccount operation.

NameDescriptionSchema
payload
optional
The response schema for the getAccount operation.Account
errors
optional
A list of errors that occurred with the getAccount operation.ErrorList

Account

The response schema for the getAccount operation.

NameDescriptionSchema
marketplaceParticipationList
required
List of marketplace participations.MarketplaceParticipationList
businessType
required
The type of business registered for the seller account.enum (BusinessType)
sellingPlan
required
The selling plan details.enum (SellingPlan)
business
optional
Information about the seller's business. These fields may be omitted if the seller is registered as an individual.Business
primaryContact
optional
Information about the seller's primary contact.PrimaryContact

Business

Information about the seller's business. These fields may be omitted if the seller is registered as an individual.

NameDescriptionSchema
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

NameDescriptionSchema
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.

NameDescriptionSchema
name
required
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

ValueDescription
CHARITYThe business is registered as a charity.
CRAFTSMANThe business is registered as a craftsman.
NATURAL_PERSON_COMPANYThe business is a natural person company.
PUBLIC_LISTEDThe business is a publicly listed company.
PRIVATE_LIMITEDThe business is a private limited company.
SOLE_PROPRIETORSHIPThe business is a sole proprietorship.
STATE_OWNEDThe business is state-owned.
INDIVIDUALThe entity is not a business but an individual.

SellingPlan

The selling plan details.

Type : enum

ValueDescription
PROFESSIONALThe seller has a professional selling plan.
INDIVIDUALThe seller has an individual selling plan.