Sellers API v1 reference

AmazonSPAPI

# Overview

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

# Operations

getMarketplaceParticipations

# Paths

# getMarketplaceParticipations

GET /sellers/v1/marketplaceParticipations

# 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
.016 15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

# 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 id.
GetMarketplaceParticipationsResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

# Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code Description Schema
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 id.
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 id.
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 id.
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 id.
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 id.
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 id.
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 id.
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 id.
GetMarketplaceParticipationsResponse

# 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 occured. 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

Name Description Schema
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

# 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
Encountered errors for 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.

Name Description Schema
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.

Name Description Schema
isParticipating
required
- boolean
hasSuspendedListings
required
Specifies if the seller has suspended listings. True if the seller Listing Status is set to Inactive, otherwise False. boolean
Last Updated: 10/11/2022, 9:45:34 PM