供应商交易状态API v1参考

亚马逊SPAPI

<a name="概述">

# 概述

零售采购交易状态的销售伙伴API提供程序化的访问,以获取供应商特定的异步POST交易的状态信息.

# Version information

版本 : v1

# Operations

getTransaction
<a name="paths">

# 路径

<a name="gettransaction">

# getTransaction

GET /vendor/transactions/v1/transactions/{transactionId}

# Description

返回您指定的交易的状态.

使用计划:

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

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

# Parameters

Type Name Description Schema
Path transactionId
required
亚马逊在 "transactionId "字段中提供的GUID,以响应特定交易的post请求. string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetTransactionResponse

关于错误状态代码、描述和模式,见错误响应和模式.

<a name="error-responses-and-schemas">

# 错误响应和模式

该表包含HTTP状态代码和错误响应的相关信息.

HTTP Code Description Schema
400 Request有缺失或无效的参数,无法解析.
Headers
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetTransactionResponse
401 请求的授权头格式不正确或不包含有效的令牌.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
GetTransactionResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
**头信息
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
404 指定的资源不存在.

x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
415 请求的有效载荷是不支持的格式.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
GetTransactionResponse
429 请求的频率超过了允许的范围.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
GetTransactionResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
GetTransactionResponse
503 服务器的临时超载或维护.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识.
GetTransactionResponse

<a name="definitions">

# Definitions

<a name="gettransactionresponse">

# GetTransactionResponse

getTransaction操作的响应模式.

Name Description Schema
payload
optional
getTransaction操作的响应有效载荷. TransactionStatus
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="transactionstatus">

# TransactionStatus

Name Description Schema
transactionStatus
optional
The transaction status. Transaction

<a name="交易">

# Transaction

交易状态.

Name Description Schema
transactionId
required
响应特定交易的post请求,在'transactionId'字段中返回的唯一标识符. string
status
required
交易的当前处理状态. enum (Status
errors
optional
请求不成功时返回的错误响应列表. ErrorList

<a name="errorlist">

# ErrorList

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

类型 < Error > 数组

<a name="error">

# Error

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

Name Description Schema
code
required
一个错误代码,用于识别所发生的错误类型. string
message
required
一个描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string

<a name="status">

# Status

交易的当前处理状态.

类型 : 枚举

Value Description
失败 交易失败.
处理中 交易正在进行中.
成功 交易已成功完成.
Last Updated: 2022/10/17 下午9:17:02