Amazon Selling Partner API - spapi.cyou

列表项目API v2021-08-01

亚马逊SPAPI

# 概述

Listings Items的销售伙伴API(Listings Items API)提供了对亚马逊上销售伙伴列表的编程访问.使用此API时要与产品类型定义的销售伙伴API协作，您可以用它来检索使用Listings Items API所需的亚马逊产品类型信息.

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

# Version information

版本 : 2021-08-01

# Operations

getListingsItem
putListingsItem
deleteListingsItem
patchListingsItem

# 路径

# getListingsItem

GET /listings/2021-08-01/items/{sellerId}/{sku}

# Description

返回一个销售伙伴的列表项目的详细信息.

使用计划：

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

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

# Parameters

Type Name Description Schema
Path sellerId
required		 A selling partner identifier, such as a merchant account or vendor code. string
Path sku
required		 A selling partner provided identifier for an Amazon listing. string
*Query *marketplaceIds
required		 A comma-delimited list of Amazon marketplace identifiers for the request. < string > array(csv)
Query issueLocale
optional		 A locale for localization of issues. 当没有提供时，会使用第一个市场的默认语言代码.例子"en_US", "fr_CA", "fr_FR".当指定地区没有本地化时，本地化的信息默认为 "en_US". string
Query includedData
optional		 A comma-delimited list of data sets to include in the response. Default: summaries. < enum (IncludedData) > array(csv)

# Responses

HTTP Code Description Schema
200 Success.
头:
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) 唯一的请求参考 IDentifier.		 Item

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

# Consumes

  • 应用/json

# Produces

  • 应用/json

# putListingsItem

PUT /listings/2021-08-01/items/{sellerId}/{sku}

# Description

为销售伙伴创建一个新的或完全-更新一个现有的列表项目.

使用计划：

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

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

# Parameters

Type Name Description Schema
Path sellerId
required		 A selling partner identifier, such as a merchant account or vendor code. string
Path sku
required		 A selling partner provided identifier for an Amazon listing. string
*Query *marketplaceIds
required		 A comma-delimited list of Amazon marketplace identifiers for the request. < string > array(csv)
Query issueLocale
optional		 A locale for localization of issues. 当没有提供时，会使用第一个市场的默认语言代码.例子"en_US", "fr_CA", "fr_FR".当指定地区没有本地化时，本地化的信息默认为 "en_US". string
Body body
required		 putListingsItem操作的请求体模式. ListingsItemPutRequest

# Responses

HTTP Code Description Schema
200 成功地理解了创建或完全-更新列表项目的请求.查看响应以确定提交的内容是否被接受.
头:
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) 唯一的请求参考 IDentifier.		 ListingsItemSubmissionResponse

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

# Consumes

  • 应用/json

# Produces

  • 应用/json

# deleteListingsItem

DELETE /listings/2021-08-01/items/{sellerId}/{sku}

# Description

为销售伙伴删除一个列表项目.

使用计划：

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

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

# Parameters

Type Name Description Schema
Path sellerId
required		 A selling partner identifier, such as a merchant account or vendor code. string
Path sku
required		 A selling partner provided identifier for an Amazon listing. string
*Query *marketplaceIds
required		 A comma-delimited list of Amazon marketplace identifiers for the request. < string > array(csv)
Query issueLocale
optional		 A locale for localization of issues. 当没有提供时，会使用第一个市场的默认语言代码.例子"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.		 ListingsItemSubmissionResponse

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

# Consumes

  • 应用/json

# Produces

  • 应用/json

# patchListingsItem

PATCH /listings/2021-08-01/items/{sellerId}/{sku}

# Description

部分更新(patch)一个销售伙伴的列表项目.只有顶级-级别的列表项目属性可以被修补.不支持修补嵌套属性.

使用计划：

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

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

# Parameters

Type Name Description Schema
Path sellerId
required		 A selling partner identifier, such as a merchant account or vendor code. string
Path sku
required		 A selling partner provided identifier for an Amazon listing. string
*Query *marketplaceIds
required		 A comma-delimited list of Amazon marketplace identifiers for the request. < string > array(csv)
Query issueLocale
optional		 A locale for localization of issues. 当没有提供时，会使用第一个市场的默认语言代码.例子"en_US", "fr_CA", "fr_FR".当指定地区没有本地化时，本地化的信息默认为 "en_US". string
Body body
required		 补丁ListingsItem操作的请求体模式. ListingsItemPatchRequest

# Responses

HTTP Code Description Schema
200 成功理解了列表项的补丁请求.查看响应以确定提交是否被接受.
头信息 :
x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）.
x-amzn-RequestId (string) 唯一的请求参考 IDentifier.		 ListingsItemSubmissionResponse

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

# 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

# Error

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

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

# ErrorList

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

Name Schema
errors
required		 < Error > array

# Item

一个列表项.

Name Description Schema
sku
required		 A selling partner provided identifier for an Amazon listing. string
*summaries
optional		 列表项目的摘要细节. ItemSummaries
属性
可选		 JSON对象，包含结构化的列表项目属性数据，以属性名称为关键. ItemAttributes
问题
可选		 与列表项目相关的问题. ItemIssues
offers
optional		 Offer details for the listings item. ItemOffers
fulfillmentAvailability
optional		 Fulfillment availability for the listings item. < FulfillmentAvailability> array
采购
可选		 供应商对列表项的采购信息. ItemProcurement

# ItemSummaries

列表项目的摘要细节.

类型 < ItemSummaryByMarketplace >数组

# ItemSummaryByMarketplace

一个亚马逊市场的列表项目的摘要细节.

Name Description Schema
marketplaceId
required		 市场标识符. 识别列表项目的亚马逊市场. string
asin
required		 亚马逊标准识别码(ASIN)的列表项目. string
productType
required		 亚马逊的产品类型 item. string
conditionType
optional		 标识了列表的条件 item. enum (ConditionType)
status
required		 适用于房源的状态 item. < enum (Status)> array
fnSku
optional		 Fulfillment network stock keeping unit是亚马逊履行中心用来识别每个独特物品的标识符. string
itemName
required		 Name, or title, associated with an Amazon catalog item. string
createdDate
required		 列表项目的创建日期，ISO 8601格式. string (date-time)
lastUpdatedDate
required		 列表项目最后更新的日期，ISO 8601格式. string (date-time)
mainImage
optional		 列表项目的主要图片. ItemImage

# ItemImage

列表中的图片 item.

Name Description Schema
link
required		 Link, or URL, for the image. string
height
required		 图像的高度（像素）. integer
width
required		 Width of the image in pixels. integer

# ItemAttributes

JSON 对象包含结构化的列表项目属性数据，以属性名称为关键.

类型 : 对象

# ItemIssues

与房源相关的问题 item.

类型 < Issue > 数组

# Issue

列表项的一个问题.

Name Description Schema
code
required		 一个标识问题类型的问题代码. string
message
required		 一个描述问题的信息. string
severity
required		 问题的严重程度. enum (Severity)
attributeNames
optional		 与该问题相关的属性名称，如果适用的话. < string > array

# ItemOffers

列表中物品的报价详情.

类型 < ItemOfferByMarketplace > array

# ItemOfferByMarketplace

一个亚马逊市场的清单项目的报价详情.

Name Description Schema
marketplaceId
required		 Amazon marketplace identifier. string
offerType
required		 listings项目的报价类型. enum (OfferType)
price
required		 Purchase price of the listings item Money
points
optional		 购买物品时提供的亚马逊点数，以及它们的货币价值.注意，点数元素只在日本返回(JP). Points

# ItemProcurement

列表中项目的供应商采购信息.

Name Description Schema
costPrice
required		 价格(数值)你希望亚马逊为这个产品支付给你的价格. Money

# FulfillmentAvailability

列表中的项目.的履行可用性详情

Name Description Schema
fulfillmentChannelCode
required		 指定将使用哪个履行网络. string
数量
可选		 你要出售的物品的数量.
最小值0		 integer

# Money

货币类型和金额.

Name Description Schema
currencyCode
required		 三位数的货币代码.在ISO 4217格式中. string
amount
required		 The currency amount. Decimal

# Decimal

一个没有精度损失的十进制数.在不能接受精度损失的情况下很有用，比如货币.遵循RFC7159的数字表示法.

类型：字符串

# Points

购买商品时提供的亚马逊积分的数量，以及它们的货币价值.注意，积分元素只在日本返回(JP).

Name Schema
pointsNumber
required		 integer

# PatchOperation

一个HTTP PATCH请求的单独JSON补丁操作.

Name Description Schema
op
required		 类型的JSON补丁操作.支持的JSON补丁操作包括添加、替换和删除.见https://tools.ietf.org/html/rfc6902 (opens new window). enum (Op)
path
required		 JSON 要修补的元素的指针路径. 见 https://tools.ietf.org/html/rfc6902 (opens new window). string
value
optional		 JSON值来添加、替换或删除. <对象>数组

# ListingsItemPatchRequest

用于修补ListingsItem操作的请求体模式.

Name Description Schema
productType
required		 列表项目的亚马逊产品类型. string
patches
required		 一个或多个JSON补丁操作，对listings item. < PatchOperation> array

# ListingsItemPutRequest

putListingsItem操作的请求体模式.

Name Description Schema
productType
required		 列表项目的亚马逊产品类型. string
requirements
optional		 所提供数据的需求集名称. enum (Requirements)
attributes
required		 JSON对象，包含结构化的列表项目属性数据，以属性名称为关键. object

# ListingsItemSubmissionResponse

响应包含提交给销售伙伴API的列表项目的结果.

Name Description Schema
sku
required		 A selling partner provided identifier for an Amazon listing. string
status
required		 列表项目提交的状态. enum (Status)
submissionId
required		 列表项目提交的唯一标识符. string
issues
optional		 与列表项目提交有关的问题. < Issue> 数组

# IncludedData

类型 : 枚举

Value Description
summaries 列表项目的摘要细节.
属性 JSON对象，包含结构化的清单项目属性数据，以属性名称为关键.
issues 与上市项目相关的问题.
offers 当前对上市项目的报价.
fulfillmentAvailability 列出项目的履行情况.
采购 列出物品的供应商采购细节.

# Op

JSON补丁操作的类型.支持的JSON补丁操作包括添加、替换和删除.见https://tools.ietf.org/html/rfc6902 (opens new window).

类型 : 枚举

Value Description
****添加 "添加 "操作添加或替换目标属性.
replace "替换 "操作添加或替换了目标属性.
delete "删除 "操作删除目标属性.不支持供应商(供应商将收到HTTP状态代码400的响应).

# Severity

该问题的严重程度.

类型 : 枚举

Value Description
ERROR 表示发生了一个问题，阻止了提交的处理，例如验证错误.
WARNING 表示发生了一个应该被审查的问题，但没有阻止提交的处理.
INFO 表示提供了额外的信息，应予审查.

# ConditionType

识别列表项目的条件.

类型 : 枚举

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

# Requirements

所提供的数据的要求集的名称.

类型 : 枚举

Value Description
LISTING 表示提交的数据包含产品事实和销售术语.
LISTING_PRODUCT_ONLY 表示提交的数据只包含产品事实.
LISTING_OFFER_ONLY 表示提交的数据只包含销售条款.不支持供应商(供应商将收到一个HTTP状态代码400的响应).

# OfferType

列表项目的报价类型.

类型 : 枚举

Value Description
B2C 此列表项目的报价可供企业对消费者购买，这意味着它可供亚马逊零售网站的购物者使用.
B2B 此清单上的商品可供企业对企业购买.

# Status

类型 : 枚举

用于定义(s)ItemSummaryByMarketplace

Value Description
可购买 列表中的项目可以被购物者购买.这种状态不适用于供应商的列表.
DISCOVERABLE 该物品对购物者可见.

用于定义(s)ListingsItemSubmissionResponse 列表项目提交的状态.

Value Description
ACCEPTED 房源提交已被接受处理.
INVALID 提交的房源无效，不接受处理.

Listings Restrictions API v2021-08-01