# 概述
产品类型定义的销售伙伴API提供了对亚马逊目录中产品类型的属性和数据要求的编程访问.使用此API返回产品类型的JSON模式,然后您可以与其他销售伙伴API一起使用,例如用于列表项目的销售伙伴API、用于目录项目的销售伙伴API,以及用于基于JSON-的列表馈送的销售伙伴API(
欲了解更多信息,请参见产品类型定义API用例指南 (opens new window).
# Version information
版本 : 2020-09-01
# Operations
searchDefinitionsProductTypes
getDefinitionsProductType
<a name="paths">
# 路径
<a name="searchdefinitionsproducttypes">
# searchDefinitionsProductTypes
GET /definitions/2020-09-01/productTypes
# Description
搜索并返回有可用定义的亚马逊产品类型的列表.
使用计划:
| 计划类型 | 速率(每秒请求数) | 突发 |
|---|---|---|
| Default | 5 | 10 |
| 销售伙伴具体 | 变量 | 变量 |
x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API的使用计划和费率限制 (opens new window).
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | keywords optional | A以逗号分隔的关键词列表,通过. | < string > array(csv) |
| Query | marketplaceIds required | A comma-delimited list of Amazon marketplace identifiers for the request. | < string > array(csv) |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | 成功检索到有定义的亚马逊产品类型列表. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | ProductTypeList |
| 429 | 请求的频率超过允许的范围. 头: x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式,见错误响应和模式.
# Consumes
应用/json
# Produces
应用/json
<a name="getdefinitionsproducttype">
# getDefinitionsProductType
GET /definitions/2020-09-01/productTypes/{productType}
# Description
检索一个亚马逊产品类型定义.
使用计划:
| 计划类型 | 速率(每秒请求数) | 突发 |
|---|---|---|
| Default | 5 | 10 |
| 销售伙伴具体 | 变量 | 变量 |
x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API的使用计划和费率限制 (opens new window).
# Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | productType required | The Amazon product type name. | string | - |
| *Query | *sellerId optional | A selling partner identifier. 当提供时,seller-特定的要求和值将在产品类型定义模式中被填充,例如与销售伙伴相关的品牌名称. | string | - |
| *Query | marketplaceIds required | A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time. | < string > array(csv) | - |
| Query | productTypeVersion optional | 要检索的亚马逊产品类型的版本.默认为 "LATEST" .产品类型定义的预发布版本可以用 "RELEASE_CANDIDATE "来检索.如果目前没有预发布版本,将提供 "LATEST "实时版本. | string | "LATEST" |
| Query | requirements optional | 检索需求集的名称. | enum (Requirements) | "LISTING" |
| Query | requirementsEnforced optional | 确定一个需求集的所需属性是否被产品类型定义模式强制执行.Non-enforced需求使结构验证 单个属性的结构性验证,而不是所有需要的属性都存在(例如部分更新). | enum (RequirementsEnforced) | "ENFORCED" |
| Query | locale optional | Locale用于检索显示标签和其他演示细节.默认为请求中第一个市场的默认语言. | enum (Locale | "DEFAULT" |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | 成功检索到一个亚马逊产品类型定义. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | ProductTypeDefinition |
| 429 | 请求的频率超过了允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式,见错误响应和模式.
# Consumes
应用/json
# Produces
应用/json
<a name="error-responses-and-schemas">
# 错误响应和模式
该表包含HTTP状态代码和错误响应的相关信息.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request有缺失或无效的参数,无法解析. Headers x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. **头信息 x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 404 | 指定的资源不存在. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 413 | 请求的大小超过了可接受的最大大小. **头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 415 | 请求的有效载荷是不支持的格式. 头信息 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 500 | 发生了一个意外情况,使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码,速率限制头已被废弃,不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 503 | 服务器的临时超载或维护. 头信息 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码,速率限制头已经过时,不再返回. x-amzn-RequestId (string):唯一的请求参考标识. | ErrorList |
<a name="definitions">:唯一的请求参考标识符
# Definitions
<a name="错误">
# Error
当请求不成功时返回的错误响应.
| Name | Description | Schema |
|---|---|---|
| code required | 一个错误代码,用于识别所发生的错误类型. | string |
| message required | 一个描述错误情况的信息. | string |
| details optional | 可以帮助呼叫者理解或解决这个问题的额外细节. | string |
<a name="errorlist">
# ErrorList
当一个请求不成功时返回的错误响应列表.
| Name | Schema |
|---|---|
| errors required | < Error > array |
<a name="schemalink">
# SchemaLink
| Name | Description | Schema |
|---|---|---|
| 链接 所需 | 链接来检索模式. | 链接 |
| 校验 required | 模式的校验和散列(Base64 MD5). 可用于验证模式内容,识别模式版本之间的变化,以及用于缓存. | string |
<a name="schemalink-link"> 链接
| Name | Description | Schema |
|---|---|---|
| resource required | URI resource for the link. | string |
| verb required | HTTP method for the link operation. | enum (Verb) |
<a name="producttypedefinition">
# ProductTypeDefinition
产品类型定义代表了亚马逊目录中产品类型的属性和数据要求.产品类型定义在Selling Partner API for Listings Items、Selling Partner API for Catalog Items以及Selling Partner API for Feeds中基于JSON-的listings feeds之间可互换使用.
| Name | Description | Schema |
|---|---|---|
| metaSchema optional | 链接到描述产品类型模式所使用的词汇的meta-schema. | SchemaLink |
| schema required | 链接到描述产品类型的属性和要求的模式. | SchemaLink |
| requirements required | 在这个产品类型定义中代表的需求集的名称. | enum (Requirements |
| requirementsEnforced required | 确定一个需求集的必要属性是否被产品类型定义模式强制执行. Non-enforced需求使结构验证 (例如部分更新). | enum (RequirementsEnforced |
| propertyGroups required | 属性组名称到属性组的映射.属性组代表模式属性的逻辑分组,可用于显示或信息目的. | < string, PropertyGroup > map |
| locale required | 产品类型定义中包含的显示元素的地域. | string |
| marketplaceIds required | 产品类型定义所适用的亚马逊市场标识符. | < string > array |
| productType required | 本产品类型定义所适用的亚马逊产品类型的名称. | string |
| productTypeVersion required | 亚马逊产品类型的版本详细信息. | ProductTypeVersion |
<a name="propertygroup">
# PropertyGroup
一个属性组代表了一个模式属性的逻辑分组,可用于显示或提供信息.
| Name | Description | Schema |
|---|---|---|
| title optional | 属性组的显示标签. | string |
| 描述 可选择 | 属性组的描述. | string |
| propertyNames optional | 该属性组的模式属性名称. | < string > array |
<a name="producttypeversion">
# ProductTypeVersion
一个亚马逊产品类型的版本详情.
| Name | Description | Schema |
|---|---|---|
| version required | Version identifier. | string |
| *latest required | 为真时,版本标识符所指示的版本是亚马逊产品类型的最新版本. | boolean |
| releaseCandidate optional | 当为真时,版本标识符指示的版本是亚马逊产品类型的预发布(release candidate) |
<a name="producttype">
# ProductType
一个亚马逊的产品类型,有一个可用的定义.
| Name | Description | Schema |
|---|---|---|
| name required | 亚马逊产品类型的名称. | string |
| marketplaceIds required | 产品类型定义的亚马逊市场标识. | < string > array |
<a name="producttypelist">
# ProductTypeList
亚马逊产品类型的列表,其中有可用的定义.
| Name | Schema |
|---|---|
| 产品类型 必须的 | < 产品类型 > 数组 |
<a name="locale">
# Locale
用于检索显示标签和其他演示细节的地区语言.默认为请求中第一个市场的默认语言.
类型 : 枚举
| Value | Description |
|---|---|
| DEFAULT | 所请求的亚马逊市场的默认语言. |
| ar | Arabic |
| ar_AE | Arabic (U.A.E.) |
| de | German |
| de_DE | German (Germany) |
| en | English |
| en_AE | English (U.A.E.) |
| en_AU | English (Australia) |
| en_CA | English (Canada) |
| en_GB | English (United Kingdom) |
| en_IN | English (India) |
| en_SG | English (Singapore) |
| en_US | English (United States) |
| es | Spanish |
| es_ES | Spanish (Spain) |
| es_MX | Spanish (Mexico) |
| es_US | Spanish (United States) |
| fr | French |
| fr_CA | French (Canada) |
| fr_FR | French (France) |
| it | Italian |
| it_IT | Italian (Italy) |
| ja | Japanese |
| ja_JP | Japanese (Japan) |
| nl | Dutch |
| nl_NL | Dutch (Netherlands) |
| pl | Polish |
| pl_PL | Polish (Poland) |
| pt | Portuguese |
| pt_BR | Portuguese (Brazil) |
| pt_PT | Portuguese (Portugal) |
| sv | Swedish |
| sv_SE | Swedish (Sweden) |
| tr | Turkish |
| tr_TR | Turkish (Turkey) |
| zh | Chinese |
| zh_CN | Chinese (Simplified) |
| zh_TW | Chinese (Traditional) |
<a name="verb">
# Verb
链接操作的HTTP方法.
类型 : 枚举
| Value | Description |
|---|---|
| GET | 所提供的资源是用HTTP GET方法访问的. |
<a name="requirementsenforced">
# RequirementsEnforced
类型 : 枚举
<a id="requirementsenforced-subgroup-1">用于定义(s)ProductTypeDefinition 识别一个需求集的所需属性是否被产品类型定义模式强制执行.非强制要求使个别属性的结构性验证,而不是所有的所需属性都存在(例如对于部分更新).
| Value | Description |
|---|---|
| ENFORCED | Schema强制要求和有条件要求的属性(用于完整的有效载荷验证). |
| NOT_ENFORCED | Schema不执行必需和有条件的属性(用于部分有效载荷的验证,例如单一属性). |
<a id="requirementsenforced-subgroup-2">用于操作(s)getDefinitionsProductType 确定一个需求集的所需属性是否被产品类型定义模式强制执行.非强制执行的需求可以在没有所有所需属性存在的情况下对单个属性进行结构性验证(例如对于部分更新).
| Value | Description |
|---|---|
| ENFORCED | Request schema with required and conditionally required attributes enforced ( used for full payload validation). |
| NOT_ENFORCED | 请求模式中的必填和有条件必填属性未被执行(用于部分有效载荷的验证,例如单一属性). |
<a name="requirements">
# Requirements
类型 : 枚举
<a id="requirements-subgroup-1">用于定义(s)ProductTypeDefinition 该产品类型定义中所代表的需求集的名称.
| Value | Description |
|---|---|
| LISTING | 表示该模式包含产品事实和销售术语. |
| LISTING_PRODUCT_ONLY | 表示该模式数据只包含产品事实. |
| LISTING_OFFER_ONLY | 表明模式数据只包含销售条款. |
<a id="requirements-subgroup-2">用于操作(s)getDefinitionsProductType 检索需求集的名称.
| Value | Description |
|---|---|
| LISTING | 包含产品事实和销售术语的请求模式. |
| LISTING_PRODUCT_ONLY | 仅包含产品事实的请求模式. |
| LISTING_OFFER_ONLY | Request模式只包含销售条款. |