# 概述
供应商直接履行沙盒测试数据的销售伙伴API提供了对供应商直接履行沙盒测试数据的程序化访问.
# Version information
版本 : 2021-10-28
# Operations
generateOrderScenarios
getOrderScenarios
<a name="paths">
# 路径
<a name="generate orderscenarios">
# generateOrderScenarios
POST /vendor/directFulfillment/sandbox/2021-10-28/orders
# Description
提交一个请求，为供应商直接履行API实体生成测试订单数据.
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | generateOrderScenarios操作的请求体. | GenerateOrderScenarioRequest |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | TransactionReference |
| 415 | 请求的有效载荷是不支持的格式. 头: x-amzn-RequestId (string) : 唯一的请求参考标识符. | ErrorList |
| 429 | 请求的频率超过了允许的范围. Headers: x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
| 503 | 服务器的临时超载或维护. 头信息 x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式. <a name="getorderscenarios">
# getOrderScenarios
GET /vendor/directFulfillment/sandbox/2021-10-28/transactions/{transactionId}
# Description
返回由指定的transactionId指示的交易状态.如果交易成功，也会返回请求的测试订单数据.
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | transactionId required | 在generateOrderScenarios操作的响应中返回的交易标识符. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | TransactionStatus |
| 415 | 请求的有效载荷是不支持的格式. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | ErrorList |
| 429 | 请求的频率超过了允许的范围. Headers: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | ErrorList |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | ErrorList |
| 503 | 服务器的临时超载或维护. 头信息 x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式.
<a name="error-responses-and-schemas">
# 错误响应和模式
该表包含HTTP状态代码和错误响应的相关信息.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request有缺失或无效的参数，无法解析. Headers x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 401 | 请求的授权头格式不正确或不包含有效的令牌. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. **头信息 x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 404 | 指定的资源不存在. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 413 | 请求的大小超过了可接受的最大大小. 头信息 x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
<a name="definitions">:唯一的请求参考标识符
# Definitions
<a name="generate orderscenariorequest">
# GenerateOrderScenarioRequest
generateOrderScenarios操作的请求体.
| Name | Description | Schema |
|---|---|---|
| orders optional | 要求的测试订单的列表，如当事人标识符所示. | < OrderScenarioRequest> 数组 |
<a name="orderscenariorequest">
# OrderScenarioRequest
生成测试数据所需的当事方标识符.
| Name | Description | Schema |
|---|---|---|
| sellingParty required | 销售方或供应商的标识. | PartyIdentification |
| shipFromParty required | 销售方的仓库代码. | PartyIdentification |
<a name="partyidentification">
# PartyIdentification
当事人信息的识别对象.例如，仓库代码或供应商代码.更多细节请参考具体当事人.
| Name | Description | Schema |
|---|---|---|
| partyId required | 为当事人分配的标识.例如，仓库代码或供应商代码.更多细节请参考具体当事人. | string |
<a name="transactionreference">
# TransactionReference
一个由亚马逊分配的GUID，用来识别这个交易.
| Name | Schema |
|---|---|
| transactionId optional | string |
<a name="transactionstatus">
# TransactionStatus
getOrderScenarios操作的有效载荷.
| Name | Description | Schema |
|---|---|---|
| transactionStatus optional | 交易细节，包括状态.如果交易成功，还包括请求的测试订单数据. | Transaction |
<a name="交易">
# Transaction
交易细节包括状态.如果交易成功，还包括要求的测试订单数据.
| Name | Description | Schema |
|---|---|---|
| transactionId required | 在generateOrderScenarios请求的响应中返回的唯一标识符. | string |
| status required | 交易的当前处理状态. | enum (Status) |
| testCaseData optional | 交易的测试案例数据.只在交易状态为SUCCESS时可用. | TestCaseData |
<a name="testcasedata">
# TestCaseData
响应测试数据请求而返回的测试案例数据集.
| Name | Description | Schema |
|---|---|---|
| scenarios optional | 描述可能的测试场景的用例集. | < Scenario> 数组 |
<a name="scenario">
# Scenario
当请求成功时返回的一个场景测试案例响应.
| Name | Description | Schema |
|---|---|---|
| scenarioId required | 一个标识符，用于识别用户可用于测试的场景类型. | string |
| orders required | 一个可以被调用者用来测试每个生命周期或场景的订单列表. | < TestOrder > array |
<a name="testorder">
# TestOrder
当请求不成功时返回的错误响应.
| Name | Description | Schema |
|---|---|---|
| orderId required | 一个错误代码，用于识别发生的错误类型. | string |
<a name="errorlist">
# ErrorList
当一个请求不成功时返回的错误响应列表.
| Name | Schema |
|---|---|
| errors required | < Error > array |
<a name="error">
# Error
当请求不成功时返回的错误响应.
| Name | Description | Schema |
|---|---|---|
| code required | 一个错误代码，用于识别发生的错误类型. | string |
| message required | 一个描述错误情况的信息. | string |
| details optional | 可以帮助呼叫者理解或解决这个问题的额外细节. | string |
<a name="status">
# Status
交易的当前处理状态.
类型 : 枚举
| Value | Description |
|---|---|
| FAILURE | 交易失败. |
| PROCESSING | 交易正在进行中. |
| SUCCESS | 交易已成功完成. |