列表项目API v2020-09-01

亚马逊SPAPI

# 概述

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

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

# Version information

版本 : 2020-09-01

# Operations

putListingsItem
deleteListingsItem
patchListingsItem

# 路径

# putListingsItem

PUT /listings/2020-09-01/items/{sellerId}/{sku}

# Description

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

使用计划:

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

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制一些销售伙伴的费率限制将不同于上表显示的默认费率和突发费率 更多信息,请参阅[销售伙伴API中的使用计划和费率限制](https: //spapi.cyou/zh/use-other/usage-plans-and-rate-limits-in-the-sp-api.html).

# Parameters

Type Name Description Schema
Path sellerId
required
<一个销售伙伴的标识符,如商家账户或供应商代码. string
Path sku
required
销售合作伙伴为亚马逊列表提供的标识符. string
*Query *marketplaceIds
required
请求的亚马逊商城标识符的逗号分隔列表. < string > array(csv)
Query issueLocale
optional
问题本地化的语言环境. 当没有提供时,会使用第一个市场的默认语言代码.例子"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/2020-09-01/items/{sellerId}/{sku}

# Description

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

使用计划:

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

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制一些销售伙伴的费率限制将不同于上表显示的默认费率和突发费率 更多信息,请参阅[销售伙伴API中的使用计划和费率限制](https: //spapi.cyou/zh/use-other/usage-plans-and-rate-limits-in-the-sp-api.html).

# Parameters

Type Name Description Schema
Path sellerId
required
<一个销售伙伴的标识符,如商家账户或供应商代码. string
Path sku
required
销售合作伙伴为亚马逊列表提供的标识符. string
*Query *marketplaceIds
required
请求的亚马逊商城标识符的逗号分隔列表. < string > array(csv)
Query issueLocale
optional
问题本地化的语言环境. 当没有提供时,会使用第一个市场的默认语言代码.例子"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/2020-09-01/items/{sellerId}/{sku}

# Description

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

使用计划:

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

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划速率限制一些销售伙伴的费率限制将不同于上表显示的默认费率和突发费率 更多信息,请参阅[销售伙伴API中的使用计划和费率限制](https: //spapi.cyou/zh/use-other/usage-plans-and-rate-limits-in-the-sp-api.html).

# Parameters

Type Name Description Schema
Path sellerId
required
一个销售伙伴的标识符,如商家账户或供应商代码. string
Path sku
required
销售合作伙伴为亚马逊列表提供的标识符. string
*Query *marketplaceIds
required
请求的亚马逊商城标识符的逗号分隔列表. < string > array(csv)
Query issueLocale
optional
问题本地化的语言环境. 当没有提供时,会使用第一个市场的默认语言代码.例子"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
413 请求大小超过了可接受的最大大小.
Headers:
x-amzn-RateLimit-Limit (string):您对此操作的速率限制(每秒请求数).
_Note: _ 对于此状态码,速率限制标头已弃用且不再返回.
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
415 请求的格式不受支持.
Headers:
x-amzn-RateLimit-Limit (string):您对此操作的速率限制(每秒请求数).
_Note: _ 对于此状态码,速率限制标头已弃用且不再返回.
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
429 请求的频率大于允许的频率.
Headers:
x-amzn-RateLimit-Limit (string):您对此操作的速率限制(每秒请求数).
_Note: _ 对于此状态码,速率限制标头已弃用且不再返回.
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
500 发生了一个意外的情况,使服务器无法满足请求.
Headers:
x-amzn-RateLimit-Limit (string):您对此操作的速率限制(每秒请求数).
_Note: _ 对于此状态码,速率限制标头已弃用且不再返回.
x-amzn-RequestId (string):唯一的请求参考 IDentifier.
ErrorList
503 服务器暂时超载或维护.
Headers:
x-amzn-RateLimit-Limit (string):您对此操作的速率限制(每秒请求数).
_Note: _ 对于此状态码,速率限制标头已弃用且不再返回.
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

# Issue

列表项的一个问题.

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

# 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
销售合作伙伴为亚马逊列表提供的标识符. string
status
required
列表项目提交的状态. enum (Status)
submissionId
required
列表项目提交的唯一标识符. string
issues
可选的
与列表项目提交有关的问题. < Issue> 数组

# Status

列表项目提交的状态.

类型 : 枚举

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

# Op

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

类型 : 枚举

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

# Severity

该问题的严重程度.

类型 : 枚举

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

# Requirements

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

类型 : 枚举

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