Vendor Direct Fulfillment Sandbox Test Data API v2021-10-28 reference

AmazonSPAPI

# Overview

The Selling Partner API for Vendor Direct Fulfillment Sandbox Test Data provides programmatic access to vendor direct fulfillment sandbox test data.

# Version information

Version : 2021-10-28

# Operations

generateOrderScenarios
getOrderScenarios

# Paths

# generateOrderScenarios

POST /vendor/directFulfillment/sandbox/2021-10-28/orders

# Description

Submits a request to generate test order data for Vendor Direct Fulfillment API entities.

# Parameters

Type Name Description Schema
Body body
required
The request body for the generateOrderScenarios operation. GenerateOrderScenarioRequest

# Responses

HTTP Code Description Schema
202 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
TransactionReference
415 The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList

For additional error status codes, descriptions and schemas, see Error responses and schemas.

# getOrderScenarios

GET /vendor/directFulfillment/sandbox/2021-10-28/transactions/{transactionId}

# Description

Returns the status of the transaction indicated by the specified transactionId. If the transaction was successful, also returns the requested test order data.

# Parameters

Type Name Description Schema
Path transactionId
required
The transaction identifier returned in the response to the generateOrderScenarios operation. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
TransactionStatus
415 The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList
429 The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList
503 Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
ErrorList

For additional error status codes, descriptions and schemas, see Error responses and schemas.

# Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code Description Schema
400 Request has missing or invalid parameters and cannot be parsed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
403 Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
404 The resource specified does not exist.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
413 The request size exceeded the maximum accepted size.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList

# Definitions

# GenerateOrderScenarioRequest

The request body for the generateOrderScenarios operation.

Name Description Schema
orders
optional
The list of test orders requested as indicated by party identifiers. < OrderScenarioRequest > array

# OrderScenarioRequest

The party identifiers required to generate the test data.

Name Description Schema
sellingParty
required
The identifier of the selling party or vendor. PartyIdentification
shipFromParty
required
The warehouse code of the vendor. PartyIdentification

# PartyIdentification

The identification object for the party information. For example, warehouse code or vendor code. Please refer to specific party for more details.

Name Description Schema
partyId
required
Assigned identification for the party. For example, warehouse code or vendor code. Please refer to specific party for more details. string

# TransactionReference

A GUID assigned by Amazon to identify this transaction.

Name Schema
transactionId
optional
string

# TransactionStatus

The payload for the getOrderScenarios operation.

Name Description Schema
transactionStatus
optional
The transaction details including the status. If the transaction was successful, also includes the requested test order data. Transaction

# Transaction

The transaction details including the status. If the transaction was successful, also includes the requested test order data.

Name Description Schema
transactionId
required
The unique identifier returned in the response to the generateOrderScenarios request. string
status
required
The current processing status of the transaction. enum (Status)
testCaseData
optional
Test case data for the transaction. Only available when the transaction status is SUCCESS. TestCaseData

# TestCaseData

The set of test case data returned in response to the test data request.

Name Description Schema
scenarios
optional
Set of use cases that describes the possible test scenarios. < Scenario > array

# Scenario

A scenario test case response returned when the request is successful.

Name Description Schema
scenarioId
required
An identifier that identifies the type of scenario that user can use for testing. string
orders
required
A list of orders that can be used by the caller to test each life cycle or scenario. < TestOrder > array

# TestOrder

Error response returned when the request is unsuccessful.

Name Description Schema
orderId
required
An error code that identifies the type of error that occurred. string

# ErrorList

A list of error responses returned when a request is unsuccessful.

Name Schema
errors
required
< Error > array

# Error

Error response returned when the request is unsuccessful.

Name Description Schema
code
required
An error code that identifies the type of error that occured. string
message
required
A message that describes the error condition. string
details
optional
Additional details that can help the caller understand or fix the issue. string

# Status

The current processing status of the transaction.

Type : enum

Value Description
FAILURE Transaction has failed.
PROCESSING Transaction is in process.
SUCCESS Transaction has completed successfully.
Last Updated: 10/11/2022, 9:45:34 PM