<a name="概述">
# 概述
直接履行交易状态的销售伙伴API提供对直接履行供应商交易状态的程序化访问.
# Version information
版本 : v1
# Operations
getTransactionStatus
<a name="paths">
# 路径
<a name="gettransactionstatus">
# getTransactionStatus
GET /vendor/directFulfillment/transactions/v1/transactions/{transactionId}
# Description
返回由指定的transactionId指示的交易的状态.
使用计划:
计划类型 | 速率(每秒请求数) | 突发 |
---|---|---|
Default | 10 | 10 |
销售伙伴具体 | 变量 | 变量 |
x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | transactionId required | Previously returned in response to the POST request of a specific transaction. | 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-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. 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
getTransactionStatus操作的响应模式.
Name | Description | Schema |
---|---|---|
payload optional | getTransactionStatus操作的有效载荷. | TransactionStatus |
errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
<a name="transactionstatus">
# TransactionStatus
getTransactionStatus操作的有效载荷.
Name | Description | Schema |
---|---|---|
transactionStatus optional | The transaction status details. | 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 |
---|---|
失败 | 交易失败. |
处理中 | 交易正在进行中. |
成功 | 交易已成功完成. |