Listings Restrictions API v2021-08-01 reference

Programmatic access to restrictions on Amazon catalog listings.

Overview

The Selling Partner API for Listings Restrictions provides programmatic access to restrictions on Amazon catalog listings.

For more information, see the Listings Restrictions API Use Case Guide.

Version information

Version : 2021-08-01

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

getListingsRestrictions

Paths

GET /listings/2021-08-01/restrictions

Operation: getListingsRestrictions

Description

Returns listing restrictions for an item in the Amazon Catalog.

Usage Plan:

Rate (requests per second)Burst
510

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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
Queryasin
required
The Amazon Standard Identification Number (ASIN) of the item.string
QueryconditionType
optional
The condition used to filter restrictions.enum (ConditionType)
QuerysellerId
required
A selling partner identifier, such as a merchant account.string
QuerymarketplaceIds
required
A comma-delimited list of Amazon marketplace identifiers for the request.< string > array(csv)
QueryreasonLocale
optional
A locale for reason text localization. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.string

Responses

HTTP CodeDescriptionSchema
200Successfully retrieved the listings restrictions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
RestrictionList

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

Consumes

  • application/json

Produces

  • application/json

Error Responses and Schemas

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

HTTP CodeDescriptionSchema
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.
ErrorList
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.
ErrorList
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.
ErrorList
413The request size exceeded the maximum accepted size.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
415The request payload is in an unsupported format.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
429The frequency of requests was greater than allowed.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
503Temporary overloading or maintenance of the server.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList

Definitions

RestrictionList

A list of restrictions for the specified Amazon catalog item.

NameSchema
restrictions
required
< Restriction > array

Restriction

A listing restriction, optionally qualified by a condition, with a list of reasons for the restriction.

NameDescriptionSchema
marketplaceId
required
A marketplace identifier. Identifies the Amazon marketplace where the restriction is enforced.string
conditionType
optional
The condition that applies to the restriction.enum (ConditionType)
reasons
optional
A list of reasons for the restriction.< Reason > array

Reason

A reason for the restriction, including path forward links that may allow Selling Partners to remove the restriction, if available.

NameDescriptionSchema
message
required
A message describing the reason for the restriction.string
reasonCode
optional
A code indicating why the listing is restricted.enum (ReasonCode)
links
optional
A list of path forward links that may allow Selling Partners to remove the restriction.< Link > array

Link

A link to resources related to a listing restriction.

NameDescriptionSchema
resource
required
The URI of the related resource.string (uri)
verb
required
The HTTP verb used to interact with the related resource.enum (Verb)
title
optional
The title of the related resource.string
type
optional
The media type of the related resource.string

ErrorList

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

Type : < Error > array

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.string
details
optional
Additional details that can help the caller understand or fix the issue.string

Verb

The HTTP verb used to interact with the related resource.

Type : enum

ValueDescription
GETThe provided resource is accessed with the HTTP GET method.

ReasonCode

A code indicating why the listing is restricted.

Type : enum

ValueDescription
APPROVAL_REQUIREDApproval is required to create a listing for the specified ASIN. A path forward link will be provided that may allow Selling Partners to remove the restriction.
ASIN_NOT_FOUNDThe specified ASIN does not exist in the requested marketplace.
NOT_ELIGIBLENot eligible to create a listing for the specified ASIN. No path forward link will be provided to remove the restriction.

ConditionType

Type : enum

For use with the definition(s): Restriction
The condition that applies to the restriction.

ValueDescription
new_newNew
new_open_boxNew - Open Box.
new_oemNew - OEM.
refurbished_refurbishedRefurbished
used_like_newUsed - Like New.
used_very_goodUsed - Very Good.
used_goodUsed - Good.
used_acceptableUsed - Acceptable.
collectible_like_newCollectible - Like New.
collectible_very_goodCollectible - Very Good.
collectible_goodCollectible - Good.
collectible_acceptableCollectible - Acceptable.
club_clubClub

For use with the operation(s): getListingsRestrictions
The condition used to filter restrictions.

ValueDescription
new_newNew
new_open_boxNew - Open Box.
new_oemNew - OEM.
refurbished_refurbishedRefurbished
used_like_newUsed - Like New.
used_very_goodUsed - Very Good.
used_goodUsed - Good.
used_acceptableUsed - Acceptable.
collectible_like_newCollectible - Like New.
collectible_very_goodCollectible - Very Good.
collectible_goodCollectible - Good.
collectible_acceptableCollectible - Acceptable.
club_clubClub

Did this page help you?