Amazon Selling Partner API - spapi.cyou

目录项目API v2022-04-01

亚马逊SPAPI

# 概述

目录物品的销售伙伴API提供了对亚马逊目录中物品信息的程序化访问.

更多信息请参考Catalog Items API Use Case Guide (opens new window).

# Version information

版本 : 2022-04-01

# Operations

searchCatalogItems
getCatalogItem

# 路径

# searchCatalogItems

GET /catalog/2022-04-01/items

# Description

通过标识符或关键词搜索并返回亚马逊目录项目和相关信息的列表.

使用计划：

速率(每秒请求数) 突发
5 5

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

# Parameters

Type Name Description Schema Default
Query identifiers
optional		 A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.
Max count : 20		 < string > array(csv) -
*Query identifiersType
optional		 Type of product identifiers to search the Amazon catalog for. Note: Required when identifiers are provided. enum (IdentifiersType -
Query marketplaceIds
required		 A comma-delimited list of Amazon marketplace identifiers for the request.
Max count : 1		 < string > array(csv) -
Query includedData
optional		 A comma-delimited list of data sets to include in the response. Default: summaries. < enum (IncludedData) > array(csv) "[\"summaries\"]"
Query locale
optional		 Locale用于检索本地化的摘要.默认为市场的主要地区语言. string -
Query sellerId
optional		 A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU. string -
Query keywords
optional		 A comma-delimited list of words to search the Amazon catalog for. 注意: Cannot be used with identifiers.
Max count : 20		 < string > array(csv) -
*Query *brandNames
optional		 A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers. < string > array(csv) -
*Query *classificationIds
optional		 A comma-delimited list of classification identifiers to limit the search for keywords-based queries. **注意：**不能与identifiers. < string > array(csv) -
Query pageSize
optional		 Number of results to be returned each page.
Maximum : 20		 integer 10
*Query *pageToken
optional		 A token，当有多页的结果时，可以获取某个页面. string -
Query keywordsLocale
optional		 为基于keywords-的查询提供的关键词语言.默认为市场的主要语言. **注意：**不能与identifiers一起使用. string -

# Responses

HTTP Code Description Schema
200 Success.
头:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.		 ItemSearchResults

关于错误状态代码、描述和模式，见错误响应和模式.

# Consumes

  • 应用/json

# Produces

  • 应用/json

# getCatalogItem

GET /catalog/2022-04-01/items/{asin}

# Description

检索亚马逊目录中某物品的详细信息.

使用计划：

Rate (requests per second) Burst
5 5

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

# Parameters

Type Name Description Schema Default
路径 asin
必须的		 亚马逊标准识别码(ASIN)的商品. string -
*Query *marketplaceIds
required		 A comma-delimited list of Amazon marketplace identifiers.响应中的数据集只包含指定市场的数据. < string > array(csv) -
Query includedData
optional		 A comma-delimited list of data sets to include in the response. Default: summaries. < enum (IncludedData) > array(csv) "[\"summaries\"]"
Query locale
optional		 Locale用于检索本地化的摘要.默认为市场上的主要地区语言. string -

# Responses

HTTP Code Description Schema
200 Success.
头:
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : 唯一的请求参考标识符.		 Item

关于错误状态代码、描述和模式，见错误响应和模式.

# Consumes

  • 应用/json

# Produces

  • 应用/json

# 错误响应和模式

该表包含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-RequestId (string):Unique request reference identifier.		 ErrorList
415 请求的有效载荷是不支持的格式.
头信息
x-amzn-RequestId (string):Unique request reference identifier.		 ErrorList
429 请求的频率超过了允许的范围.
标题
x-amzn-RequestId (string):Unique request reference identifier.		 ErrorList
500 发生了一个意外情况，使服务器无法完成请求.
头信息
x-amzn-RequestId (string):Unique request reference identifier.		 ErrorList
503 服务器的临时超载或维护.
头信息
x-amzn-RequestId (string):Unique request reference identifier.		 ErrorList

:唯一的请求参考标识符

# Definitions

# Error

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

Name Description Schema
code
required		 一个错误代码，用于识别所发生的错误类型. string
message
required		 一个描述错误情况的信息. string
details
optional		 可以帮助呼叫者理解或解决这个问题的额外细节. string

# ErrorList

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

Name Schema
errors
required		 < Error > array

# Item

亚马逊目录中的一个项目.

Name Description Schema
asin
required		 Amazon Standard Identification Number (ASIN)是商品在Amazon目录中的唯一标识符. ItemAsin
attributes
optional		 A JSON对象，包含结构化的物品属性数据，以属性名称为键.目录物品属性符合Selling Partner API中产品类型定义的相关产品类型定义. ItemAttributes
dimensions
optional		 与亚马逊市场目录中的商品相关的尺寸阵列. ItemDimensions
identifiers
optional		 与亚马逊目录中的商品相关的标识符，如UPC和EAN标识符. ItemIdentifiers
图片
可选		 亚马逊目录中某一物品的图片. ItemImages
productTypes
optional		 与亚马逊目录项目相关的产品类型. ItemProductTypes
关系
可选		 亚马逊目录商品的市场关系(例如，变化). ItemRelationships
salesRanks
optional		 亚马逊目录商品的销售排名. ItemSalesRanks
summaries
optional		 亚马逊目录商品的摘要详情. ItemSummaries
vendorDetails
optional		 与亚马逊目录物品相关的供应商细节.供应商细节只对供应商可用. ItemVendorDetails

# ItemAsin

亚马逊标准识别码(ASIN)是亚马逊目录中物品的唯一识别码.

类型：字符串

# ItemAttributes

一个JSON对象，包含结构化的物品属性数据，以属性名称为键.目录中的物品属性符合产品类型定义的销售伙伴API中的相关产品类型定义.

类型 : 对象

# ItemBrowseClassification

分类(浏览节点)与亚马逊目录中的物品有关.

Name Description Schema
displayName
required		 Display name for the classification. string
classificationId
required		 分类的标识符 (浏览节点标识符). string

# Dimension

亚马逊目录商品或商品包装的单个尺寸值.

Name Description Schema
单元
可选		 尺寸值的测量单位. string
value
optional		 数字尺寸值. number

# Dimensions

亚马逊目录商品或商品包装的尺寸.

Name Description Schema
height
optional		 Height of an item or item package. Dimension
length
optional		 Length of an item or item package. Dimension
重量
可选		 物品或物品包装的重量. 维度
宽度
可选		 物品或物品包装的宽度. 尺寸

# ItemDimensions

与亚马逊目录中的物品相关的尺寸数组，由亚马逊市场.

类型: < ItemDimensionsByMarketplace > 数组

# ItemDimensionsByMarketplace

在亚马逊目录中与该物品相关的尺寸，用于指定的亚马逊市场.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
item
可选的		 亚马逊目录物品的尺寸. Dimensions
包装
optional		 亚马逊目录商品的包装尺寸. Dimensions

# ItemIdentifiers

与亚马逊目录中的物品相关的标识符，如UPC和EAN标识符.

类型: < ItemIdentifiersByMarketplace > array

# ItemIdentifiersByMarketplace

在亚马逊目录中与该物品相关的标识符，用于指定的亚马逊市场.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
identifiers
required		 与亚马逊目录中指定的亚马逊市场的物品相关的标识符. < ItemIdentifier >数组

# ItemIdentifier

与亚马逊目录中的物品相关的标识符，如UPC或EAN标识符.

Name Description Schema
identifierType
required		 标识符的类型，如UPC、EAN或ISBN. string
identifier
required		 Identifier. string

# ItemImages

亚马逊目录中某一物品的图片.

类型 < ItemImagesByMarketplace >阵列

# ItemImagesByMarketplace

指明的亚马逊市场的亚马逊目录中的一个项目的图片.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
images
required		 亚马逊目录中指定的亚马逊市场的物品图片. < ItemImage > array

# ItemImage

亚马逊目录中某一物品的图像.

Name Description Schema
变量
要求的		 图像的变量，如MAIN或PT01.
例子"MAIN"		 enum (Variant)
link
required		 Link, or URL, for the image. string
height
required		 图像的高度（像素）. integer
width
required		 Width of the image in pixels. integer

# ItemProductTypes

与亚马逊目录相关的产品类型 item.

类型 < ItemProductTypeByMarketplace > array

# ItemProductTypeByMarketplace

与指定的亚马逊市场的亚马逊目录物品相关的产品类型.

Name Description Schema
marketplaceId
optional		 Amazon marketplace identifier. string
productType
optional		 与亚马逊目录项目相关的产品类型名称.
Example : "LUGGAGE"		 string

# ItemSalesRanks

亚马逊目录物品的销售排名.

类型 < ItemSalesRanksByMarketplace >数组

# ItemSalesRanksByMarketplace

一个亚马逊目录物品在指定的亚马逊市场上的销售排名.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
classificationRanks
optional		 亚马逊目录商品在亚马逊市场的分类销售排名. < ItemClassificationSalesRank > array
displayGroupRanks
optional		 一个亚马逊市场的亚马逊目录商品按网站显示组的销售排名. < ItemDisplayGroupSalesRank > array

# ItemClassificationSalesRank

亚马逊目录商品按分类的销售排名.

Name Description Schema
classificationId
required		 与销售等级相关的分类的标识符. string
title
required		 Title, or name, of the sales rank. string
link
optional		 对应的亚马逊零售网站链接，或URL，为销售排名. string
rank
required		 销售排名值. integer

# ItemDisplayGroupSalesRank

亚马逊目录商品按网站展示组的销售排名.

Name Description Schema
websiteDisplayGroup
required		 与销售排名相关的网站显示组的名称 string
title
required		 Title, or name, of the sales rank. string
link
optional		 对应的亚马逊零售网站链接，或URL，为销售排名. string
rank
required		 销售排名值. integer

# ItemSummaries

亚马逊目录物品的摘要细节.

类型 < ItemSummaryByMarketplace >数组

# ItemSummaryByMarketplace

指明的亚马逊市场的亚马逊目录物品的摘要细节.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
brand
可选的		 与亚马逊目录商品相关的品牌名称. string
browseClassification
optional		 Classification (browse node)与亚马逊目录物品相关的. ItemBrowseClassification
color
optional		 与亚马逊目录项目相关的颜色名称. string
itemClassification
optional		 与亚马逊目录物品相关的分类类型. enum (ItemClassification)
itemName
optional		 名称，或标题，与亚马逊目录项目相关. string
manufacturer
optional		 与亚马逊目录商品相关的制造商名称. string
modelNumber
optional		 与亚马逊目录商品相关的型号. string
包装数量
可选		 一个亚马逊目录商品在一个包装中的数量. integer
partNumber
optional		 与一个亚马逊目录商品相关的零件编号. string
size
optional		 与亚马逊目录项目相关的尺寸名称. string
style
optional		 与亚马逊目录商品相关的样式名称. string
websiteDisplayGroup
optional		 与亚马逊目录项目相关的网站显示组的标识符. string
websiteDisplayGroupName
optional		 与亚马逊目录项目相关的网站显示组的显示名称. string

# ItemVariationTheme

变体主题，表示定义变体系列的亚马逊物品目录属性的组合.

Name Description Schema
attributes
optional		 与变体主题相关的亚马逊目录项目属性名称. < string > array
theme
optional		 变体主题，表示定义变体系列的亚马逊商品目录属性组合.
Example : "COLOR_NAME/STYLE_NAME"		 string

# ItemRelationships

亚马逊目录商品按市场划分的关系(例如，变化).

类型: < ItemRelationshipsByMarketplace >数组

# ItemRelationshipsByMarketplace

指明的亚马逊市场的亚马逊目录项目的关系细节.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
relationships
required		 Relationships for the item. < ItemRelationship> array

# ItemRelationship

一个亚马逊目录物品的关系细节.

Name Description Schema
childAsins
optional		 Identifiers (ASINs)属于此项目子女的相关项目. < string > array
parentAsins
optional		 Identifiers (ASINs)是这个项目的父项目的相关项目. < string > array
variationTheme
optional		 对于 "VARIATION "关系，变体主题表示定义变体家族的亚马逊商品目录属性组合. ItemVariationTheme
类型
要求		 关系类型.
例子: "VARIATION"		 enum (Type)

# ItemVendorDetailsCategory

与亚马逊目录物品相关的产品类别或子类别.

Name Description Schema
displayName
optional		 产品类别或子类别的显示名称 string
value
optional		 Value (code)产品类别或子类别. string

# ItemVendorDetails

与亚马逊目录物品相关的供应商细节.供应商细节仅对供应商可用.

类型 : < ItemVendorDetailsByMarketplace > array

# ItemVendorDetailsByMarketplace

与指定的亚马逊市场的亚马逊目录项目相关的供应商详情.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
brandCode
可选的		 与亚马逊目录物品相关的品牌代码. string
manufacturerCode
optional		 Manufacturer code associated with an Amazon catalog item. string
manufacturerCodeParent
optional		 制造商代码的上级供应商代码. string
productCategory
optional		 与亚马逊目录项目相关的产品类别. ItemVendorDetailsCategory
productGroup
optional		 与亚马逊目录项目相关的产品组. string
产品子类别
可选		 与亚马逊目录项目相关的产品子类别. ItemVendorDetailsCategory
replenishmentCategory
optional		 relenishment category associated with an Amazon catalog item. enum (ReplenishmentCategory

# ItemSearchResults

亚马逊目录中的物品和搜索相关元数据.

Name Description Schema
numberOfResults
required		 对于基于identifiers-的搜索，找到的亚马逊目录项目的总数.对于基于keywords-的搜索，搜索查询所匹配的亚马逊目录项目的估计总数(每次请求只返回页面数限制以内的结果，无论找到多少).

注可以返回和翻阅的最大项目数(ASINs)是1000.		 integer
pagination
required		 如果可用，返回分页结果所需的nextToken和/或previousToken值. Pagination
refinements
required		 Search refinements for keywords-based searches. Refinements
items
required		 A list of items from the Amazon catalog. < Item> array

# Pagination

当一个请求产生的响应超过 "pageSize "时，就会发生分页.这意味着响应被分成独立的页面.要检索下一页或上一页，必须在下一个请求中传递 "nextToken "值或 "previousToken "值作为 "pageToken "参数.当你收到最后一页，分页对象中就没有 "nextToken "键.

Name Description Schema
nextToken
optional		 A token，可用于获取下一页. string
previousToken
optional		 A token，可用于获取上一页. string

# Refinements

搜索细化.

Name Description Schema
品牌
required		 品牌搜索细化. < 品牌细化 >阵列
classifications
required		 Classification search refinements. < ClassificationRefinement > array

# BrandRefinement

品牌的描述，可用于获得更精细的-细化搜索结果.

Name Description Schema
numberOfResults
required		 如果应用细化键，估计仍会返回的结果数量. integer
brandName
required		 Brand name. 用于显示，可以作为搜索精炼. string

# ClassificationRefinement

描述一个分类，可用于获得更精细的-粒度的搜索结果.

Name Description Schema
numberOfResults
required		 如果应用细化键，估计仍会返回的结果数量. integer
displayName
required		 Display name for the classification. string
classificationId
required		 分类的标识符，可用于搜索细化目的. string

# Variant

图像的变体，如MAIN或PT01.

类型 : 枚举

Value Description
MAIN 项目的主要形象.
PT01 其他图片#1的项目.
PT02 其他图片#2的项目.
*PT03 其他图像#3的项目.
*PT04 其他图片#4为该项目.
*PT05 其他图片#5为该项目.
*PT06 其他图片#6为该项目.
PT07 其他图片#7的项目.
PT08 其他图片#8的项目.
SWCH 手表的图片.

# IdentifiersType

在亚马逊目录中搜索产品标识符的类型. **注意：**提供 "标识符 "时必须提供.

类型 : 枚举

Value Description
*ASIN 亚马逊标准识别码.
*EAN 欧洲商品编号.
*GTIN 全球贸易项目编号.
ISBN 国际标准书号.
*JAN 日本物品编号.
MINSAN Minsan Code.
SKU Stock Keeping Unit，一个卖家-指定的亚马逊清单的标识符. **注意：**必须伴有sellerId.
UPC 通用产品代码.

# ItemClassification

与亚马逊目录物品相关的分类类型.

类型 : 枚举

Value Description
BASE_PRODUCT 代表亚马逊目录中的标准独立产品或变体子项目.
OTHER 代表亚马逊目录中不是 "BASE_PRODUCT"、"PRODUCT_BUNDLE "或 "VARIATION_PARENT "的商品
PRODUCT_BUNDLE 代表一个父级亚马逊目录项目，代表一个捆绑的项目.
VARIATION_PARENT 代表一个亚马逊目录的父项，将子项组合成一个变体系列.

# Type

关系的类型.

类型 : 枚举

Value Description
VARIATION 请求中的亚马逊目录商品是由ASIN.
PACKAGE_HIERARCHY 请求中的亚马逊目录物品是一个包装容器或被ASIN.

# ReplenishmentCategory

与亚马逊目录商品相关的补货类别.

类型 : 枚举

Value Description
ALLOCATED 表示非-自动采购的库存已由供应商分配给亚马逊.
BASIC_REPLENISHMENT 表示非-自动采购的库存.
IN_SEASON 表示对季节性物品的库存进行非-自动采购.
LIMITED_REPLENISHMENT 在商品成为 "新产品 "之前，保持排队补货状态.
MANUFACTURER_OUT_OF_STOCK 表示供应商在较长时间内没有库存，不能回购.
新产品 表示亚马逊库存中还没有库存的新产品.
NON_REPLENISHABLE 表示用于详细页面显示的分类父类，而不是实际物品.
NON_STOCKUPABLE 表示亚马逊在履行中心没有库存的代发货库存.
OBSOLETE 表示商品已经过时，不应订购.
PLANNED_REPLENISHMENT 表示应该自动订购的活跃物品.

# IncludedData

类型 : 枚举

用于操作(s)getCatalogItem

Value Description
attributes A JSON对象，包含以属性名称为键的结构化物品属性数据.目录物品属性符合Selling Partner API中产品类型定义的相关亚马逊产品类型定义.
dimensions 亚马逊目录中物品的尺寸.
identifiers 与亚马逊目录中的商品相关的标识符，如UPC和EAN标识符.
图片 亚马逊目录中的物品的图片.
productTypes 与亚马逊目录项目相关的产品类型.
关系 亚马逊目录商品的关系细节(例如，变化).
salesRanks 一个亚马逊目录商品的销售排名.
summaries 亚马逊目录商品的摘要细节.参考亚马逊目录商品的 "属性 "了解更多细节.
vendorDetails 与亚马逊目录物品相关的供应商细节.供应商细节仅对供应商可用.

用于操作(s)searchCatalogItems

Value Description
attributes A JSON对象，包含以属性名称为键的结构化物品属性数据.目录物品属性符合Selling Partner API中的相关亚马逊产品类型定义.
dimensions 亚马逊目录中物品的尺寸.
identifiers 与亚马逊目录中的商品相关的标识符，如UPC和EAN标识符.
图片 亚马逊目录中的物品的图片.
productTypes 与亚马逊目录项目相关的产品类型.
关系 亚马逊目录商品的关系细节(例如，变化).
salesRanks 一个亚马逊目录商品的销售排名.
summaries 亚马逊目录商品的摘要细节.更多细节请参考亚马逊目录商品的属性.
vendorDetails 与亚马逊目录项目相关的供应商细节.供应商细节仅对供应商可用.

Easy Ship API v2022-03-23