征求意见的API v1参考

亚马逊SPAPI

# 概述

通过Solicitations API,您可以建立向买方发送非-关键性邀约的应用程序. 您可以获得您指定的订单可用的邀约类型列表,然后调用一个操作,为该订单向买方发送邀约. 买方不能响应由该API发送的邀约,而且这些邀约不会出现在卖方中心的消息传递部分或收件人的消息中心. Solicitations API返回根据<a href=https: //tools.ietf.org/html/draft-kelly-json-hal-08>JSON超文本应用语言 (HAL)标准.

# Version information

版本 : v1

# Operations

getSolicitationActionsForOrder
createProductReviewAndSellerFeedbackSolicitation
<a name="paths">

# 路径

<a name="getolicitationactionsfororder">

# getSolicitationActionsForOrder

GET /solicitations/v1/orders/{amazonOrderId}

# Description

返回您指定的订单可用的邀约类型列表.一个邀约类型由一个行动对象表示,其中包含一个路径和查询参数(s).您可以使用路径和参数(s)来调用一个发送邀约的操作.目前只有productReviewAndSellerFeedbackSolicitation类型可用.

使用计划:

速率(每秒的请求) 突发
1 5

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which you want a list of available solicitation types. string
Query marketplaceIds
required
A marketplace identifier. 这指定了订单所在的市场.只能指定一个市场.
Max count : 1
<字符串>数组

# Responses

HTTP Code Description Schema
200 Returns hypermedia links under _links.actions key that specify which solicitation actions are allowed for the order.
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse
400 Request有缺失或无效的参数,不能被解析.
头信息:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
GetSolicitationActionsForOrderResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
GetSolicitationActionsForOrderResponse

<a name="createproductreviewandsellerfeedbacksolicitation">

# createProductReviewAndSellerFeedbackSolicitation

POST /solicitations/v1/orders/{amazonOrderId}/solicitations/productReviewAndSellerFeedback

# Description

向买方发送征求卖方反馈意见和指定订单的产品评论的邀约.每个订单只能发送一条productReviewAndSellerFeedback或自由形式的主动信息.

使用计划:

速率(每秒的请求) 突发
1 5

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path amazonOrderId
required
An Amazon order identifier. This specifies the order for which a solicitation is sent. string
Query marketplaceIds
required
A marketplace identifier. 这指定了订单所在的市场.只能指定一个市场.
Max count : 1
<字符串>数组

# Responses

HTTP Code Description Schema
201 该信息是为该订单创建的.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
CreateProductReviewAndSellerFeedbackSolicitationResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)对于这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意:_对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateProductReviewAndSellerFeedbackSolicitationResponse

<a name="definitions">

# Definitions

<a name="linkobject">

# LinkObject

一个链接对象.

Name Description Schema
href
required
A 此对象的URI. string
name
optional
这个对象的标识符. string

<a name="solicitationsaction">

# SolicitationsAction

一个包含模板名称的简单对象.

Name Schema
name
required
string

<a name="schema">

# Schema

一个JSON模式文件,描述了行动的预期有效载荷.这个对象可以通过<a href=http://json-schema.org/draft-04/schema>http://json-schema.org/draft-04/schema. 来验证

类型 : 对象

<a name="getolicitationactionsfororderresponse">

# GetSolicitationActionsForOrderResponse

getSolicitationActionsForOrder操作的响应模式.

Name Description Schema
links
optional
- _links
embedded
optional
- _embedded
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="getolicitationactionsfororderresponse-links"> 链接

Name Description Schema
self
required
- LinkObject
actions
required
Eligible actions for the specified amazonOrderId. < LinkObject> array

<a name="getolicitationactionsfororderresponse-embedded"> embedded

Name Schema
actions
required
< GetSolicitationActionResponse > array

<a name="getsolicitationactionresponse">

# GetSolicitationActionResponse

描述可对订单采取的招标行动. 提供一个JSON超文本应用语言(HAL)链接到JSON模式文件,描述预期的输入.

Name Description Schema
links
optional
- _links
embedded
optional
- _embedded
payload
optional
A simple object containing the name of the template. SolicitationsAction
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="getolicitationactionresponse-links"> 链接

Name Schema
self
required
LinkObject
schema
required
LinkObject

<a name="getolicitationactionresponse-embedded"> embedded

Name Schema
schema
optional
GetSchemaResponse

<a name="getschemaresponse">

# GetSchemaResponse

Name Description Schema
links
optional
- _links
payload
optional
A JSON模式文档,描述行动的预期有效载荷.这个对象可以通过<a href=http://json-schema.org/draft-04/schema>http://json-schema.org/draft-04/schema. Schema
errors
optional
当请求不成功时返回的错误响应列表. ErrorList

<a name="getschemaresponse-links"> 链接

Name Schema
self
required
LinkObject

<a name="createproductreviewandsfeedbacksolicitationresponse">

# CreateProductReviewAndSellerFeedbackSolicitationResponse

createProductReviewAndSellerFeedbackSolicitation操作的响应模式.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="errorlist">

# ErrorList

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

类型 < Error > 数组

<a name="error">

# Error

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

Name Description Schema
code
required
一个错误代码,用于识别所发生的错误类型. string
message
required
一个以人类可读的形式描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string
Last Updated: 2022/10/17 下午9:17:02