Amazon Selling Partner API - spapi.cyou

Catalog Items API v0 reference

AmazonSPAPI

# Overview

目录项目的销售伙伴 API 可帮助您以编程方式检索目录中项目的项目详细信息.

# Version information

Version : v0

# Operations

listCatalogItems
getCatalogItem
listCatalogCategories

# Paths

# listCatalogItems

GET /catalog/v0/items

# Description

根据您指定的搜索查询或项目标识符，返回项目及其属性的列表。 基于搜索查询时，提供 Query 参数和可选的 QueryContextId 参数。 当基于项目标识符时，根据标识符类型提供单个适当的参数，并指定关联的项目值。

MarketplaceId 始终是必需的。 Query、SellerSKU、UPC、EAN、ISBN、JAN 中的至少一项也是必需的。

此操作最多返回十个产品，并且不返回不可购买的产品。

Usage Plans:

计划类型 速率(每秒恢复的请求) 突发率
Default 6 40
Selling partner specific Variable Variable

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制。一些销售伙伴的费率限制将不同于上表中显示的默认费率和突发率 想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

# Parameters

Type Name Description Schema
Query MarketplaceId
required		 一个市场的标识符。指定调用返回内容的市场。. string
Query Query
optional		 关键字）用于搜索目录中的项目。 示例：“哈利波特书籍”。 string
Query QueryContextId
optional		 将在其中执行给定搜索的上下文的标识符。 市场可能会提供将搜索限制在潜在项目子集的机制。 例如，零售市场允许将查询限制在特定类别。 QueryContextId 参数指定了这样一个子集。 如果省略，将使用市场的默认上下文执行搜索，该上下文通常包含最大的项目集。 string
Query SellerSKU
optional		 用于标识给定市场中的商品。 SellerSKU 由卖家的 SellerId 限定，它包含在您提交的每个操作中. string
Query UPC
optional		 用于零售包装的 12 位条形码. string
Query EAN
optional		 唯一标识目录项、制造商及其属性的欧洲商品编号. string
Query ISBN
optional		 用于在国际上识别图书的唯一商业图书标识符. string
Query JAN
optional		 唯一标识产品、制造商及其属性的日本货号. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse
400 请求参数缺失或无效，无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse
401 请求的 Authorization 标头格式不正确或包含无效令牌.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse
403 表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名.
Headers :
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse
404 请求的资源不存在.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse
429 请求的频率大于允许的频率.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse
500 发生了一个意外的情况，使服务器无法满足请求.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse
503 服务器暂时超载或维护.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogItemsResponse

# getCatalogItem

GET /catalog/v0/items/{asin}

# Description

返回指定的项目及其属性.

Usage Plans:

计划类型 速率(每秒恢复的请求) 突发率
Default 2 20
Selling partner specific Variable Variable

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制。一些销售伙伴的费率限制将不同于上表中显示的默认费率和突发率 想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

# Parameters

Type Name Description Schema
Query MarketplaceId
required		 市场标识符。 指定商品的市场. string
Path asin
required		 亚马逊的商品标准识别码 (ASIN). string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse
400 请求参数缺失或无效，无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse
401 请求的 Authorization 标头格式不正确或包含无效令牌.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse
403 表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名.
Headers :
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse
404 请求的资源不存在.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse
429 请求的频率大于允许的频率.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse
500 发生了一个意外的情况，使服务器无法满足请求.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse
503 服务器暂时超载或维护.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 GetCatalogItemResponse

# listCatalogCategories

GET /catalog/v0/categories

# Description

根据指定的 ASIN 或 SellerSKU 返回商品所属的父类别.

Usage Plans:

计划类型 速率(每秒恢复的请求) 突发率
Default 1 40
Selling partner specific Variable Variable

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制。一些销售伙伴的费率限制将不同于上表中显示的默认费率和突发率 想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

# Parameters

Type Name Description Schema
Query MarketplaceId
required		 市场标识符。 指定商品的市场. string
Query ASIN
optional		 亚马逊的商品标准识别码 (ASIN). string
Query SellerSKU
optional		 用于识别给定市场中的项目。 SellerSKU 由卖家的 SellerId 限定，它包含在您提交的每个操作中. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse
400 请求参数缺失或无效，无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse
401 请求的 Authorization 标头格式不正确或包含无效令牌.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse
403 表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名.
Headers :
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse
404 请求的资源不存在.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse
429 请求的频率大于允许的频率.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse
500 发生了一个意外的情况，使服务器无法满足请求.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse
503 服务器暂时超载或维护.
Headers :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
Note: 对于此状态码，速率限制标头已弃用且不再返回.
x-amzn-RequestId (string) : 唯一的请求参考 ID.		 ListCatalogCategoriesResponse

# Definitions

# ListCatalogItemsResponse

Name Description Schema
payload
optional		 listCatalogItems 操作的有效内容. ListMatchingItemsResponse
errors
optional		 listCatalogItems 操作期间发生一个或多个意外错误. ErrorList

# ListMatchingItemsResponse

Name Description Schema
Items
optional		 A list of items. ItemList

# ItemList

A list of items.

Type : < Item > array

# GetCatalogItemResponse

Name Description Schema
payload
optional		 The payload for the getCatalogItem operation. Item
errors
optional		 One or more unexpected errors occurred during the getCatalogItem operation. ErrorList

# Item

An item in the Amazon catalog.

Name Description Schema
Identifiers
required		 唯一标识项目的标识符. IdentifierType
AttributeSets
optional		 项目的属性列表. AttributeSetList
Relationships
optional		 项目的变体关系信息列表. RelationshipList
SalesRankings
optional		 按类别列出项目的销售排名信息. SalesRankList

# IdentifierType

Name Description Schema
MarketplaceASIN
optional		 表示商品由 MarketPlaceId 和 ASIN 标识. ASINIdentifier
SKUIdentifier
optional		 表示商品由 MarketPlaceId、SellerId 和 SellerSKU 标识. SellerSKUIdentifier

# ASINIdentifier

Name Description Schema
MarketplaceId
required		 市场标识符. string
ASIN
required		 亚马逊的商品标准识别码 (ASIN). string

# SellerSKUIdentifier

Name Description Schema
MarketplaceId
required		 市场标识符. string
SellerId
required		 为操作提交的卖家标识符. string
SellerSKU
required		 商品的卖家库存单位 (SKU). string

# AttributeSetList

项目的属性列表.

Type : < AttributeSetListType > array

# AttributeSetListType

The attributes of the item.

Name Description Schema
Actor
optional		 The actor attributes of the item. < string > array
Artist
optional		 The artist attributes of the item. < string > array
AspectRatio
optional		 The aspect ratio attribute of the item. string
AudienceRating
optional		 The audience rating attribute of the item. string
Author
optional		 The author attributes of the item. < string > array
BackFinding
optional		 The back finding attribute of the item. string
BandMaterialType
optional		 The band material type attribute of the item. string
Binding
optional		 The binding attribute of the item. string
BlurayRegion
optional		 The Bluray region attribute of the item. string
Brand
optional		 The brand attribute of the item. string
CeroAgeRating
optional		 The CERO age rating attribute of the item. string
ChainType
optional		 The chain type attribute of the item. string
ClaspType
optional		 The clasp type attribute of the item. string
Color
optional		 The color attribute of the item. string
CpuManufacturer
optional		 The CPU manufacturer attribute of the item. string
CpuSpeed
optional		 The CPU speed attribute of the item. DecimalWithUnits
CpuType
optional		 The CPU type attribute of the item. string
Creator
optional		 The creator attributes of the item. < CreatorType > array
Department
optional		 The department attribute of the item. string
Director
optional		 The director attributes of the item. < string > array
DisplaySize
optional		 The display size attribute of the item. DecimalWithUnits
Edition
optional		 The edition attribute of the item. string
EpisodeSequence
optional		 The episode sequence attribute of the item. string
EsrbAgeRating
optional		 The ESRB age rating attribute of the item. string
Feature
optional		 The feature attributes of the item < string > array
Flavor
optional		 The flavor attribute of the item. string
Format
optional		 The format attributes of the item. < string > array
GemType
optional		 The gem type attributes of the item. < string > array
Genre
optional		 The genre attribute of the item. string
GolfClubFlex
optional		 The golf club flex attribute of the item. string
GolfClubLoft
optional		 The golf club loft attribute of the item. DecimalWithUnits
HandOrientation
optional		 The hand orientation attribute of the item. string
HardDiskInterface
optional		 The hard disk interface attribute of the item. string
HardDiskSize
optional		 The hard disk size attribute of the item. DecimalWithUnits
HardwarePlatform
optional		 The hardware platform attribute of the item. string
HazardousMaterialType
optional		 The hazardous material type attribute of the item. string
ItemDimensions
optional		 The item dimensions attribute of the item. DimensionType
IsAdultProduct
optional		 The adult product attribute of the item. boolean
IsAutographed
optional		 The autographed attribute of the item. boolean
IsEligibleForTradeIn
optional		 The is eligible for trade in attribute of the item. boolean
IsMemorabilia
optional		 The is memorabilia attribute of the item. boolean
IssuesPerYear
optional		 The issues per year attribute of the item. string
ItemPartNumber
optional		 The item part number attribute of the item. string
Label
optional		 The label attribute of the item. string
Languages
optional		 The languages attribute of the item. < LanguageType > array
LegalDisclaimer
optional		 The legal disclaimer attribute of the item. string
ListPrice
optional		 The list price attribute of the item. Price
Manufacturer
optional		 The manufacturer attribute of the item. string
ManufacturerMaximumAge
optional		 The manufacturer maximum age attribute of the item. DecimalWithUnits
ManufacturerMinimumAge
optional		 The manufacturer minimum age attribute of the item. DecimalWithUnits
ManufacturerPartsWarrantyDescription
optional		 The manufacturer parts warranty description attribute of the item. string
MaterialType
optional		 The material type attributes of the item. < string > array
MaximumResolution
optional		 The maximum resolution attribute of the item. DecimalWithUnits
MediaType
optional		 The media type attributes of the item. < string > array
MetalStamp
optional		 The metal stamp attribute of the item. string
MetalType
optional		 The metal type attribute of the item. string
Model
optional		 The model attribute of the item. string
NumberOfDiscs
optional		 The number of discs attribute of the item. integer
NumberOfIssues
optional		 The number of issues attribute of the item. integer
NumberOfItems
optional		 The number of items attribute of the item. integer
NumberOfPages
optional		 The number of pages attribute of the item. integer
NumberOfTracks
optional		 The number of tracks attribute of the item. integer
OperatingSystem
optional		 The operating system attributes of the item. < string > array
OpticalZoom
optional		 The optical zoom attribute of the item. DecimalWithUnits
PackageDimensions
optional		 The package dimensions attribute of the item. DimensionType
PackageQuantity
optional		 The package quantity attribute of the item. integer
PartNumber
optional		 The part number attribute of the item. string
PegiRating
optional		 The PEGI rating attribute of the item. string
Platform
optional		 The platform attributes of the item. < string > array
ProcessorCount
optional		 The processor count attribute of the item. integer
ProductGroup
optional		 The product group attribute of the item. string
ProductTypeName
optional		 The product type name attribute of the item. string
ProductTypeSubcategory
optional		 The product type subcategory attribute of the item. string
PublicationDate
optional		 The publication date attribute of the item. string
Publisher
optional		 The publisher attribute of the item. string
RegionCode
optional		 The region code attribute of the item. string
ReleaseDate
optional		 The release date attribute of the item. string
RingSize
optional		 The ring size attribute of the item. string
RunningTime
optional		 The running time attribute of the item. DecimalWithUnits
ShaftMaterial
optional		 The shaft material attribute of the item. string
Scent
optional		 The scent attribute of the item. string
SeasonSequence
optional		 The season sequence attribute of the item. string
SeikodoProductCode
optional		 The Seikodo product code attribute of the item. string
Size
optional		 The size attribute of the item. string
SizePerPearl
optional		 The size per pearl attribute of the item. string
SmallImage
optional		 The small image attribute of the item. Image
Studio
optional		 The studio attribute of the item. string
SubscriptionLength
optional		 The subscription length attribute of the item. DecimalWithUnits
SystemMemorySize
optional		 The system memory size attribute of the item. DecimalWithUnits
SystemMemoryType
optional		 The system memory type attribute of the item. string
TheatricalReleaseDate
optional		 The theatrical release date attribute of the item. string
Title
optional		 The title attribute of the item. string
TotalDiamondWeight
optional		 The total diamond weight attribute of the item. DecimalWithUnits
TotalGemWeight
optional		 The total gem weight attribute of the item. DecimalWithUnits
Warranty
optional		 The warranty attribute of the item. string
WeeeTaxValue
optional		 The WEEE tax value attribute of the item. Price

# DecimalWithUnits

The decimal value and unit.

Name Description Schema
value
optional		 The decimal value. number
Units
optional		 The unit of the decimal value. string

# CreatorType

The creator type attribute of an item.

Name Description Schema
value
optional		 The value of the attribute. string
Role
optional		 The role of the value. string

# DimensionType

The dimension type attribute of an item.

Name Description Schema
Height
optional		 The height attribute of the dimension. DecimalWithUnits
Length
optional		 The length attribute of the dimension. DecimalWithUnits
Width
optional		 The width attribute of the dimension. DecimalWithUnits
Weight
optional		 The weight attribute of the dimension. DecimalWithUnits

# LanguageType

The language type attribute of an item.

Name Description Schema
Name
optional		 The name attribute of the item. string
Type
optional		 The type attribute of the item. string
AudioFormat
optional		 The audio format attribute of the item. string

# Image

The image attribute of the item.

Name Description Schema
URL
optional		 The image URL attribute of the item. string
Height
optional		 The image height attribute of the item. DecimalWithUnits
Width
optional		 The image width attribute of the item. DecimalWithUnits

# Price

The price attribute of the item.

Name Description Schema
Amount
optional		 The amount. number
CurrencyCode
optional		 The currency code of the amount. string

# RelationshipList

A list of variation relationship information, if applicable for the item.

Type : < RelationshipType > array

# RelationshipType

Specific variations of the item.

Name Description Schema
Identifiers
optional		 The identifiers that uniquely identify the item that is related. IdentifierType
Color
optional		 The color variation of the item. string
Edition
optional		 The edition variation of the item. string
Flavor
optional		 The flavor variation of the item. string
GemType
optional		 The gem type variations of the item. < string > array
GolfClubFlex
optional		 The golf club flex variation of an item. string
HandOrientation
optional		 The hand orientation variation of an item. string
HardwarePlatform
optional		 The hardware platform variation of an item. string
MaterialType
optional		 The material type variations of an item. < string > array
MetalType
optional		 The metal type variation of an item. string
Model
optional		 The model variation of an item. string
OperatingSystem
optional		 The operating system variations of an item. < string > array
ProductTypeSubcategory
optional		 The product type subcategory variation of an item. string
RingSize
optional		 The ring size variation of an item. string
ShaftMaterial
optional		 The shaft material variation of an item. string
Scent
optional		 The scent variation of an item. string
Size
optional		 The size variation of an item. string
SizePerPearl
optional		 The size per pearl variation of an item. string
GolfClubLoft
optional		 The golf club loft variation of an item. DecimalWithUnits
TotalDiamondWeight
optional		 The total diamond weight variation of an item. DecimalWithUnits
TotalGemWeight
optional		 The total gem weight variation of an item. DecimalWithUnits
PackageQuantity
optional		 The package quantity variation of an item. integer
ItemDimensions
optional		 The item dimensions relationship of an item. DimensionType

# SalesRankList

A list of sales rank information for the item by category.

Type : < SalesRankType > array

# SalesRankType

Name Description Schema
ProductCategoryId
required		 Identifies the item category from which the sales rank is taken. string
Rank
required		 The sales rank of the item within the item category. integer (int32)

# ListCatalogCategoriesResponse

Name Description Schema
payload
optional		 The payload for the listCatalogCategories operation. ListOfCategories
errors
optional		 One or more unexpected errors occurred during the listCatalogCategories operation. ErrorList

# ListOfCategories

Type : < Categories > array

# Categories

Name Description Schema
ProductCategoryId
optional		 The identifier for the product category (or browse node). string
ProductCategoryName
optional		 The name of the product category (or browse node). string
parent
optional		 The parent product category. object

# ErrorList

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

Type : < Error > array

# Error

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

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

Catalog Items API v2020-12-01