Listings Restrictions API v2021-08-01 reference

AmazonSPAPI

# 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 (opens new window).

# Version information

Version : 2021-08-01

# Operations

getListingsRestrictions

# Paths

# getListingsRestrictions

GET /listings/2021-08-01/restrictions

# Description

Returns listing restrictions for an item in the Amazon Catalog.

Usage Plan:

Rate (requests per second) Burst
5 10

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 (opens new window).

# Parameters

Type Name Description Schema
Query asin
required
The Amazon Standard Identification Number (ASIN) of the item. string
Query conditionType
optional
The condition used to filter restrictions. enum (ConditionType)
Query sellerId
required
A selling partner identifier, such as a merchant account. string
Query marketplaceIds
required
A comma-delimited list of Amazon marketplace identifiers for the request. < string > array(csv)
Query reasonLocale
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 Code Description Schema
200 Successfully 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 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 identifier.
ErrorList
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.
ErrorList
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.
ErrorList
413 The request size exceeded the maximum accepted size.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
415 The request payload is in an unsupported format.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
429 The frequency of requests was greater than allowed.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
503 Temporary 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.

Name Schema
restrictions
required
< Restriction > array

# Restriction

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

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

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

A link to resources related to a listing restriction.

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

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

Value Description
GET The provided resource is accessed with the HTTP GET method.

# ReasonCode

A code indicating why the listing is restricted.

Type : enum

Value Description
APPROVAL_REQUIRED Approval 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_FOUND The specified ASIN does not exist in the requested marketplace.
NOT_ELIGIBLE Not 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.

Value Description
new_new New
new_open_box New - Open Box.
new_oem New - OEM.
refurbished_refurbished Refurbished
used_like_new Used - Like New.
used_very_good Used - Very Good.
used_good Used - Good.
used_acceptable Used - Acceptable.
collectible_like_new Collectible - Like New.
collectible_very_good Collectible - Very Good.
collectible_good Collectible - Good.
collectible_acceptable Collectible - Acceptable.
club_club Club

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

Value Description
new_new New
new_open_box New - Open Box.
new_oem New - OEM.
refurbished_refurbished Refurbished
used_like_new Used - Like New.
used_very_good Used - Very Good.
used_good Used - Good.
used_acceptable Used - Acceptable.
collectible_like_new Collectible - Like New.
collectible_very_good Collectible - Very Good.
collectible_good Collectible - Good.
collectible_acceptable Collectible - Acceptable.
club_club Club
Last Updated: 10/11/2022, 9:45:34 PM