列表限制API v2021-08-01

亚马逊SPAPI

# 概述

列表限制的销售伙伴API提供了对亚马逊目录列表限制的程序化访问.

欲了解更多信息,请参见Listings Restrictions API Use Case Guide (opens new window).

# Version information

版本 : 2021-08-01

# Operations

getListingsRestrictions

# Paths

# getListingsRestrictions

GET /listings/2021-08-01/restrictions

# Description

返回亚马逊目录中某物品的上市限制.

使用计划:

速率(每秒恢复的请求) 突发率
5 10

响应头 "x-amzn-RateLimit-Limit "返回应用于请求操作的使用计划速率限制(如果有的话).上表显示了该操作的默认速率和突发值.业务需求需要更高的吞吐量的销售伙伴可能看到比这里显示的更高的速率和突发值.更多信息,见使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Query asin
required
亚马逊的商品标准识别码 (ASIN). string
*Query *conditionType
optional
用于过滤限制的条件. 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.当没有提供时,会使用第一个市场的默认语言代码.例子"en_US", "fr_CA", "fr_FR".当指定地区没有本地化时,本地化的信息默认为 "en_US". string

# Responses

HTTP Code Description Schema
200 成功地检索到房源限制.
:
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制(每秒请求数).
x-amzn-RequestId (string) 唯一的请求参考 IDentifier.
RestrictionList

有关错误状态代码、描述和架构,请参阅 错误响应和架构.

# Consumes

  • 应用/json

# Produces

  • 应用/json

# 错误响应和模式

此表包含 http 状态代码和错误响应的相关信息.

HTTP Code Description Schema
400 请求参数缺失或无效,无法解析.
Headers:
x-amzn-RateLimit-Limit (string):您对此操作的速率限制(每秒请求数).
x-amzn-RequestId (string): 唯一的请求参考 IDentifier.
ErrorList
403 表示禁止访问资源 可能的原因包括拒绝访问、未授权、过期令牌或无效签名.
Headers:
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
404 请求的资源不存在.
Headers:
x-amzn-RateLimit-Limit (string):您对此操作的速率限制(每秒请求数).
x-amzn-RequestId (string): 唯一的请求参考 IDentifier.
ErrorList
413 请求大小超过了可接受的最大大小.
Headers:
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
415 请求的格式不受支持.
Headers:
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
429 请求的频率大于允许的频率.
Headers:
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
500 发生了一个意外的情况,使服务器无法满足请求.
Headers:
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
503 服务器暂时超载或维护.
Headers:
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList

# Definitions

# RestrictionList

指定的亚马逊目录项目的限制列表.

Name Schema
限制
必须的
< Restriction >数组

# Restriction

一个列表限制,可选择由一个条件限定,并列出限制的原因.

Name Description Schema
marketplaceId
required
市场标识符. 识别实施限制的亚马逊市场. string
conditionType
optional
适用于该限制的条件. enum (ConditionType)
reasons
optional
A 限制的原因列表. < Reason > 数组

# Reason

限制的原因,包括可能允许销售伙伴取消限制的路径转发链接,如果有的话.

Name Description Schema
message
required
A 描述限制的原因的信息. string
reasonCode
可选的
A代码,说明列表被限制的原因. enum (ReasonCode)
链接
可选
A路径前进链接的列表,可能允许销售伙伴取消限制. < Link >数组

一个与列表限制有关的资源链接.

Name Description Schema
resource
required
相关资源的URI. string (uri)
verb
required
用于与相关资源互动的HTTP动词. enum (Verb
title
optional
相关资源的标题. string
type
optional
相关资源的媒体类型. string

# ErrorList

请求不成功时返回的错误响应列表.

类型 : < Error > 数组

# Error

当请求不成功时返回的错误响应.

Name Description Schema
code
required
标识发生的错误类型的错误代码. string
message
required
描述错误情况的信息. string
details
optional
可帮助调用者理解或解决问题的其他详细信息. string

# Verb

用于与相关资源互动的HTTP动词.

类型 : 枚举

Value Description
GET 所提供的资源是用HTTP GET方法访问的.

# ReasonCode

一个表明该列表被限制的代码.

类型 : 枚举

Value Description
APPROVAL_REQUIRED 为指定的ASIN创建列表需要批准.将提供一个路径转发链接,可能允许销售伙伴取消限制.
ASIN_NOT_FOUND 指定的ASIN不存在于请求的市场中.
NOT_ELIGIBLE 没有资格为指定的ASIN创建列表.不提供路径转发链接来移除限制.

# ConditionType

类型 : 枚举

用于与定义(s): Restriction 适用于该限制的条件.

Value Description
new_new New
*新_开箱 新-开箱.
new_oem New - OEM.
refurbished_refurbished Refurbished
使用过的_像新的 使用过的-像新的.
使用过的非常好的 使用过的-非常好的.
使用过的好的 使用过的-好的.
used_acceptable Used - Acceptable.
可回收_像新的一样 可回收 -像新的一样.
可回收_非常好 可回收-非常好.
collectible_good Collectible - Good.
collectible_acceptable Collectible - Acceptable.
club_club Club

供操作(s)使用getListingsRestrictions 用来过滤限制的条件.

Value Description
new_new New
*新_开箱 新-开箱.
new_oem New - OEM.
refurbished_refurbished Refurbished
使用过的_像新的 使用过的-像新的.
使用过的非常好的 使用过的-非常好的.
使用过的好的 使用过的-好的.
used_acceptable Used - Acceptable.
可回收_像新的一样 可回收 -像新的一样.
可回收_非常好 可回收-非常好.
collectible_good Collectible - Good.
collectible_acceptable Collectible - Acceptable.
club_club Club