目录项目API v2020-12-01

亚马逊SPAPI

# 概述

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

欲了解更多信息,请参见目录物品API用例指南 (opens new window).

# Version information

版本 : 2020-12-01

# Operations

searchCatalogItems
getCatalogItem

# 路径

# searchCatalogItems

GET /catalog/2020-12-01/items

# Description

搜索并返回一个亚马逊目录项目和相关信息的列表.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 5 5
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API的使用计划和费率限制 (opens new window).

# Parameters

Type Name Description Schema Default
Query keywords
required
A comma-delimited list of words or item identifiers to search the Amazon catalog for. < string > array(csv) -
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) -
*Query *brandNames
optional
A comma-delimited list of brand names to limit the search to. < string > array(csv) -
*Query *classificationIds
optional
A comma-delimited list of classification identifiers to limit the search to. < 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
关键词所提供的语言.默认为市场的主要语言. string -
Query locale
optional
Locale用于检索本地化的摘要.默认为市场的主要语言. 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/2020-12-01/items/{asin}

# Description

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

使用计划:

计划类型 速率(每秒请求数) 突发
Default 5 5
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API的使用计划和费率限制 (opens new window).

# Parameters

Type Name Description Schema
Path asin
required
The Amazon Standard Identification Number (ASIN) of the item. 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)
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-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
415 请求的有效载荷是不支持的格式.
头信息
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
429 请求的频率超过了允许的范围.
标题
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

:唯一的请求参考标识符

# 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
identifiers
optional
与亚马逊目录中商品相关的标识符,如UPC和EAN标识符. ItemIdentifiers
images
optional
亚马逊目录中某个商品的图片.所有的图片变体都提供给品牌所有者.否则,将提供 "MAIN "图片变体的缩略图. ItemImages
productTypes
optional
与亚马逊目录项目相关的产品类型. ItemProductTypes
salesRanks
optional
亚马逊目录物品的销售排名. ItemSalesRanks
summaries
optional
亚马逊目录商品的摘要详情. ItemSummaries
变量
optional
按市场划分的亚马逊目录商品的变量细节(变量关系). ItemVariations
vendorDetails
optional
与亚马逊目录物品相关的供应商细节.供应商细节只对供应商可用. ItemVendorDetails

# ItemAsin

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

类型:字符串

# ItemAttributes

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

类型 : 对象

# 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
ranks
required
亚马逊市场商品的销售排名. < ItemSalesRank > array

# ItemSalesRank

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

Name Description Schema
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
brandName
可选的
与亚马逊目录商品相关的品牌名称. string
browseNode
optional
与亚马逊目录商品相关的浏览节点的标识符. string
colorName
optional
与亚马逊目录商品相关的颜色名称. string
itemName
optional
与亚马逊目录商品相关的名称或标题. string
manufacturer
optional
与亚马逊目录商品相关的制造商名称. string
modelNumber
optional
与亚马逊目录商品相关的型号. string
sizeName
optional
与亚马逊目录商品相关的尺寸名称. string
styleName
optional
与亚马逊目录商品相关的样式名称. string

# ItemVariations

一个亚马逊目录物品按市场划分的变体细节(变体关系).

类型 : < ItemVariationsByMarketplace >数组

# ItemVariationsByMarketplace

指明的亚马逊市场的亚马逊目录项目的变体细节.

Name Description Schema
marketplaceId
required
Amazon marketplace identifier. string
asins
required
相关物品的标识符(ASINs). < string > array
variationType
required
请求中的亚马逊目录商品与相关商品的变化关系类型(s)"PARENT "或 "CHILD".
Example : "PARENT"
enum (VariationType)

# ItemVendorDetails

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

类型 : < ItemVendorDetailsByMarketplace > array

# ItemVendorDetailsByMarketplace

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

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

# ItemSearchResults

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

Name Description Schema
numberOfResults
required
搜索查询所匹配的产品的估计总数(每次请求只返回不超过页数限制的结果,无论找到多少).

注:可返回和翻阅的最大项目数(ASINs)是1000.
integer
分页
required
如果可用,返回分页结果所需的nextToken和/或previousToken值. 分页
refinements
required
Search refinements. Refinements
items
required
A list of items from 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 手表的图片.

# VariationType

请求中的亚马逊目录物品与相关物品的变化关系类型(s)"PARENT "或 "CHILD".

类型 : 枚举

Value Description
PARENT 请求中的亚马逊目录商品是由ASIN.
CHILD 请求中的亚马逊目录物品是由ASIN.

# ReplenishmentCategory

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

类型 : 枚举

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

# IncludedData

类型 : 枚举

用于操作(s)searchCatalogItems

Value Description
标识符 与亚马逊目录中的商品相关的标识符,如UPC和EAN标识符.
图像 亚马逊目录中某一物品的图像.所有的图像变体都提供给品牌所有者;否则将提供 "主 "图像变体的缩略图.
productTypes 与亚马逊目录项目相关的产品类型.
salesRanks 亚马逊目录商品的销售排名.
summaries 亚马逊目录商品的摘要细节.
变量 一个亚马逊目录项目的变量详情(变量关系).
vendorDetails 与一个亚马逊目录物品相关的供应商细节.供应商细节仅对供应商可用.

用于操作(s)getCatalogItem

Value Description
attributes A JSON对象,包含以属性名称为键的结构化项目属性数据.目录项目属性仅对品牌所有者可用,并符合产品类型定义的销售伙伴API中提供的相关亚马逊产品类型定义.
identifiers 与亚马逊目录中的商品相关的标识符,如UPC和EAN标识符.
图像 亚马逊目录中某一物品的图像.所有图像变体都提供给品牌所有者.否则,将提供 "主 "图像变体的缩略图.
productTypes 与亚马逊目录项目相关的产品类型.
salesRanks 亚马逊目录商品的销售排名.
summaries 亚马逊目录商品的摘要细节.
变量 一个亚马逊目录项目的变量详情(变量关系).
vendorDetails 与亚马逊目录项目相关的供应商细节.供应商细节仅对供应商可用.
Last Updated: 2022/10/16 下午10:27:34