Fulfillment Outbound API v2020-07-01 reference

Retrieve information on Multi-Channel Fulfillment (MCF) orders in Amazon's fulfillment network.

Selling Partner APIs for Fulfillment Outbound

Overview

The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.

Version information

Version : 2020-07-01

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getFulfillmentPreview
listAllFulfillmentOrders
createFulfillmentOrder
getPackageTrackingDetails
listReturnReasonCodes
createFulfillmentReturn
getFulfillmentOrder
updateFulfillmentOrder
cancelFulfillmentOrder
getFeatures
getFeatureInventory
getFeatureSKU

Paths

POST /fba/outbound/2020-07-01/fulfillmentOrders/preview

Operation: getFulfillmentPreview

Description

Returns a list of fulfillment order previews based on shipping criteria that you specify.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
The request body schema for the getFulfillmentPreview operation.GetFulfillmentPreviewRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFulfillmentPreviewResponse
400Request 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.
GetFulfillmentPreviewResponse
401The 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.
GetFulfillmentPreviewResponse
403Indicates 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.
GetFulfillmentPreviewResponse
404The specified resource 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.
GetFulfillmentPreviewResponse
429The 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.
GetFulfillmentPreviewResponse
500An 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.
GetFulfillmentPreviewResponse
503Temporary 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.
GetFulfillmentPreviewResponse

GET /fba/outbound/2020-07-01/fulfillmentOrders

Operation: listAllFulfillmentOrders

Description

Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the next token parameter.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QueryqueryStartDate
optional
A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.string (date-time)
QuerynextToken
optional
A string token returned in the response to your previous request.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ListAllFulfillmentOrdersResponse
400Request 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.
ListAllFulfillmentOrdersResponse
401The 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.
ListAllFulfillmentOrdersResponse
403Indicates 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.
ListAllFulfillmentOrdersResponse
404The specified resource 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.
ListAllFulfillmentOrdersResponse
429The 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.
ListAllFulfillmentOrdersResponse
500An 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.
ListAllFulfillmentOrdersResponse
503Temporary 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.
ListAllFulfillmentOrdersResponse

POST /fba/outbound/2020-07-01/fulfillmentOrders

Operation: createFulfillmentOrder

Description

Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
The request body schema for the createFulfillmentOrder operation.CreateFulfillmentOrderRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateFulfillmentOrderResponse
400Request 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.
CreateFulfillmentOrderResponse
401The 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.
CreateFulfillmentOrderResponse
403Indicates 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.
CreateFulfillmentOrderResponse
404The specified resource 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.
CreateFulfillmentOrderResponse
429The 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.
CreateFulfillmentOrderResponse
500An 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.
CreateFulfillmentOrderResponse
503Temporary 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.
CreateFulfillmentOrderResponse

GET /fba/outbound/2020-07-01/tracking

Operation: getPackageTrackingDetails

Description

Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QuerypackageNumber
required
The unencrypted package identifier returned by the getFulfillmentOrder operation.integer (int32)

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPackageTrackingDetailsResponse
400Request 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.
GetPackageTrackingDetailsResponse
401The 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.
GetPackageTrackingDetailsResponse
403Indicates 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.
GetPackageTrackingDetailsResponse
404The specified resource 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.
GetPackageTrackingDetailsResponse
429The 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.
GetPackageTrackingDetailsResponse
500An 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.
GetPackageTrackingDetailsResponse
503Temporary 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.
GetPackageTrackingDetailsResponse

GET /fba/outbound/2020-07-01/returnReasonCodes

Operation: listReturnReasonCodes

Description

Returns a list of return reason codes for a seller SKU in a given marketplace.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QuerysellerSku
required
The seller SKU for which return reason codes are required.string
QuerymarketplaceId
optional
The marketplace for which the seller wants return reason codes.string
QuerysellerFulfillmentOrderId
optional
The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.string
Querylanguage
required
The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ListReturnReasonCodesResponse
400Request 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.
ListReturnReasonCodesResponse
401The 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.
ListReturnReasonCodesResponse
403Indicates 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.
ListReturnReasonCodesResponse
404The specified resource 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.
ListReturnReasonCodesResponse
429The 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.
ListReturnReasonCodesResponse
500An 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.
ListReturnReasonCodesResponse
503Temporary 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.
ListReturnReasonCodesResponse

PUT /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/return

Operation: createFulfillmentReturn

Description

Creates a fulfillment return.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
The createFulfillmentReturn operation creates a fulfillment return for items that were fulfilled using the createFulfillmentOrder operation. For calls to createFulfillmentReturn, you must include ReturnReasonCode values returned by a previous call to the listReturnReasonCodes operation.CreateFulfillmentReturnRequest
PathsellerFulfillmentOrderId
required
An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateFulfillmentReturnResponse
400Request 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.
CreateFulfillmentReturnResponse
401The 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.
CreateFulfillmentReturnResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
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.
CreateFulfillmentReturnResponse
404The specified resource 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.
CreateFulfillmentReturnResponse
429The 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.
CreateFulfillmentReturnResponse
500An 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.
CreateFulfillmentReturnResponse
503Temporary 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.
CreateFulfillmentReturnResponse

GET /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}

Operation: getFulfillmentOrder

Description

Returns the fulfillment order indicated by the specified order identifier.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathsellerFulfillmentOrderId
required
The identifier assigned to the item by the seller when the fulfillment order was created.
maxLength : 40
string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFulfillmentOrderResponse
400Request 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.
GetFulfillmentOrderResponse
401The 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.
GetFulfillmentOrderResponse
403Indicates 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.
GetFulfillmentOrderResponse
404The specified resource 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.
GetFulfillmentOrderResponse
429The 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.
GetFulfillmentOrderResponse
500An 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.
GetFulfillmentOrderResponse
503Temporary 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.
GetFulfillmentOrderResponse

PUT /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}

Operation: updateFulfillmentOrder

Description

Updates and/or requests shipment for a fulfillment order with an order hold on it.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
Bodybody
required
-UpdateFulfillmentOrderRequest
PathsellerFulfillmentOrderId
required
The identifier assigned to the item by the seller when the fulfillment order was created.
maxLength : 40
string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateFulfillmentOrderResponse
400Request 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.
UpdateFulfillmentOrderResponse
401The 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.
UpdateFulfillmentOrderResponse
403Indicates 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.
UpdateFulfillmentOrderResponse
404The specified resource 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.
UpdateFulfillmentOrderResponse
429The 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.
UpdateFulfillmentOrderResponse
500An 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.
UpdateFulfillmentOrderResponse
503Temporary 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.
UpdateFulfillmentOrderResponse

PUT /fba/outbound/2020-07-01/fulfillmentOrders/{sellerFulfillmentOrderId}/cancel

Operation: cancelFulfillmentOrder

Description

Requests that Amazon stop attempting to fulfill the fulfillment order indicated by the specified order identifier.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathsellerFulfillmentOrderId
required
The identifier assigned to the item by the seller when the fulfillment order was created.
maxLength : 40
string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelFulfillmentOrderResponse
400Request 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.
CancelFulfillmentOrderResponse
401The 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.
CancelFulfillmentOrderResponse
403Indicates 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.
CancelFulfillmentOrderResponse
404The specified resource 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.
CancelFulfillmentOrderResponse
429The 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.
CancelFulfillmentOrderResponse
500An 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.
CancelFulfillmentOrderResponse
503Temporary 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.
CancelFulfillmentOrderResponse

GET /fba/outbound/2020-07-01/features

Operation: getFeatures

Description

Returns a list of features available for Multi-Channel Fulfillment orders in the marketplace you specify, and whether the seller for which you made the call is enrolled for each feature.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QuerymarketplaceId
required
The marketplace for which to return the list of features.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFeaturesResponse
400Request 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.
GetFeaturesResponse
401The 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.
GetFeaturesResponse
403Indicates 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.
GetFeaturesResponse
404The specified resource 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.
GetFeaturesResponse
429The 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.
GetFeaturesResponse
500An 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.
GetFeaturesResponse
503Temporary 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.
GetFeaturesResponse

GET /fba/outbound/2020-07-01/features/inventory/{featureName}

Operation: getFeatureInventory

Description

Returns a list of inventory items that are eligible for the fulfillment feature you specify.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QuerymarketplaceId
required
The marketplace for which to return a list of the inventory that is eligible for the specified feature.string
PathfeatureName
required
The name of the feature for which to return a list of eligible inventory.string
QuerynextToken
optional
A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFeatureInventoryResponse
400Request 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.
GetFeatureInventoryResponse
401The 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.
GetFeatureInventoryResponse
403Indicates 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.
GetFeatureInventoryResponse
404The specified resource 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.
GetFeatureInventoryResponse
429The 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.
GetFeatureInventoryResponse
500An 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.
GetFeatureInventoryResponse
503Temporary 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.
GetFeatureInventoryResponse

GET /fba/outbound/2020-07-01/features/inventory/{featureName}/{sellerSku}

Operation: getFeatureSKU

Description

Returns the number of items with the sellerSKU you specify that can have orders fulfilled using the specified feature. Note that if the sellerSKU isn't eligible, the response will contain an empty skuInfo object.

Usage Plan:

Rate (requests per second)Burst
230

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QuerymarketplaceId
required
The marketplace for which to return the count.string
PathfeatureName
required
The name of the feature.string
PathsellerSku
required
Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFeatureSkuResponse
400Request 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.
GetFeatureSkuResponse
401The 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.
GetFeatureSkuResponse
403Indicates 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.
GetFeatureSkuResponse
404The specified resource 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.
GetFeatureSkuResponse
429The 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.
GetFeatureSkuResponse
500An 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.
GetFeatureSkuResponse
503Temporary 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.
GetFeatureSkuResponse

Definitions

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.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

ErrorList

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

Type : < Error > array

Address

A physical address.

NameDescriptionSchema
name
required
The name of the person, business or institution at the address.string
addressLine1
required
The first line of the address.string
addressLine2
optional
Additional address information, if required.string
addressLine3
optional
Additional address information, if required.string
city
optional
The city where the person, business, or institution is located.string
districtOrCounty
optional
The district or county where the person, business, or institution is located.string
stateOrRegion
required
The state or region where the person, business or institution is located.string
postalCode
optional
The postal code of the address.string
countryCode
required
The two digit country code. In ISO 3166-1 alpha-2 format.string
phone
optional
The phone number of the person, business, or institution located at the address.string

CODSettings

The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.

NameDescriptionSchema
isCodRequired
required
When true, this fulfillment order requires a COD (Cash On Delivery) payment.boolean
codCharge
optional
The amount of the COD charge to be collected from the recipient for a COD order.Money
codChargeTax
optional
The amount of the tax on the COD charge to be collected from the recipient for a COD order.Money
shippingCharge
optional
The amount of the tax on the COD charge to be collected from the recipient for a COD order.Money
shippingChargeTax
optional
The amount of the tax on the shipping charge to be collected from the recipient for a COD order.Money

CreateFulfillmentOrderItem

Item information for creating a fulfillment order.

NameDescriptionSchema
sellerSku
required
The seller SKU of the item.
maxLength : 50
string
sellerFulfillmentOrderItemId
required
A fulfillment order item identifier that the seller creates to track fulfillment order items. Used to disambiguate multiple fulfillment items that have the same SellerSKU. For example, the seller might assign different SellerFulfillmentOrderItemId values to two items in a fulfillment order that share the same SellerSKU but have different GiftMessage values.
maxLength : 50
string
quantity
required
The item quantity.Quantity
giftMessage
optional
A message to the gift recipient, if applicable.
maxLength : 512
string
displayableComment
optional
Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.
maxLength : 250
string
fulfillmentNetworkSku
optional
Amazon's fulfillment network SKU of the item.string
perUnitDeclaredValue
optional
The monetary value assigned by the seller to this item.Money
perUnitPrice
optional
The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.Money
perUnitTax
optional
The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.Money

CreateFulfillmentOrderItemList

An array of item information for creating a fulfillment order.

Type : < CreateFulfillmentOrderItem > array

FulfillmentPolicy

The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.

Type : enum

ValueDescription
FillOrKillIf an item in a fulfillment order is determined to be unfulfillable before any shipment in the order has acquired the status of Pending (the process of picking units from inventory has begun), then the entire order is considered unfulfillable. However, if an item in a fulfillment order is determined to be unfulfillable after a shipment in the order has acquired the status of Pending, Amazon cancels as much of the fulfillment order as possible. See the FulfillmentShipment object for shipment status definitions.
FillAllAll fulfillable items in the fulfillment order are shipped. The fulfillment order remains in a processing state until all items are either shipped by Amazon or cancelled by the seller.
FillAllAvailableAll fulfillable items in the fulfillment order are shipped. All unfulfillable items in the order are cancelled.

FulfillmentOrderStatus

The current status of the fulfillment order.

Type : enum

ValueDescription
NewThe fulfillment order was received but not yet validated.
ReceivedThe fulfillment order was received and validated. Validation includes determining that the destination address is valid and that Amazon's records indicate that the seller has enough sellable (undamaged) inventory to fulfill the order. The seller can cancel a fulfillment order that has a status of Received.
PlanningThe fulfillment order has been sent to Amazon's fulfillment network to begin shipment planning, but no unit in any shipment has been picked from inventory yet. The seller can cancel a fulfillment order that has a status of Planning.
ProcessingThe process of picking units from inventory has begun on at least one shipment in the fulfillment order. The seller cannot cancel a fulfillment order that has a status of Processing.
CancelledThe fulfillment order has been cancelled by the seller.
CompleteAll item quantities in the fulfillment order have been fulfilled.
CompletePartialledSome item quantities in the fulfillment order were fulfilled; the rest were either cancelled or unfulfillable.
UnfulfillableNo item quantities in the fulfillment order could be fulfilled because the Amazon fulfillment center workers found no inventory for those items or found no inventory that was in sellable (undamaged) condition.
InvalidThe fulfillment order was received but could not be validated. The reasons for this include an invalid destination address or Amazon's records indicating that the seller does not have enough sellable inventory to fulfill the order. When this happens, the fulfillment order is invalid and no items in the order will ship.

CreateFulfillmentOrderRequest

The request body schema for the createFulfillmentOrder operation.

NameDescriptionSchema
marketplaceId
optional
The marketplace the fulfillment order is placed against.string
sellerFulfillmentOrderId
required
A fulfillment order identifier that the seller creates to track their fulfillment order. The SellerFulfillmentOrderId must be unique for each fulfillment order that a seller creates. If the seller's system already creates unique order identifiers, then these might be good values for them to use.
maxLength : 40
string
displayableOrderId
required
A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.

The value must be an alpha-numeric or ISO 8859-1 compliant string from one to 40 characters in length. Cannot contain two spaces in a row. Leading and trailing white space is removed.
maxLength : 40
string
displayableOrderDate
required
The date and time of the fulfillment order. Displays as the order date in recipient-facing materials such as the outbound shipment packing slip.Timestamp
displayableOrderComment
required
Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.
maxLength : 1000
string
shippingSpeedCategory
required
The shipping method for the fulfillment order.ShippingSpeedCategory
deliveryWindow
optional
The time range within which a Scheduled Delivery fulfillment order should be delivered.DeliveryWindow
destinationAddress
required
The destination address for the fulfillment order.Address
fulfillmentAction
optional
Specifies whether the fulfillment order should ship now or have an order hold put on it.FulfillmentAction
fulfillmentPolicy
optional
The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.FulfillmentPolicy
codSettings
optional
The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.CODSettings
shipFromCountryCode
optional
The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.string
notificationEmails
optional
A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.NotificationEmailList
featureConstraints
optional
A list of features and their fulfillment policies to apply to the order.< FeatureSettings > array
items
required
A list of items to include in the fulfillment order preview, including quantity.CreateFulfillmentOrderItemList

CreateFulfillmentReturnRequest

The createFulfillmentReturn operation creates a fulfillment return for items that were fulfilled using the createFulfillmentOrder operation. For calls to createFulfillmentReturn, you must include ReturnReasonCode values returned by a previous call to the listReturnReasonCodes operation.

NameDescriptionSchema
items
required
An array of items to be returned.CreateReturnItemList

CreateFulfillmentReturnResult

NameDescriptionSchema
returnItems
optional
An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.ReturnItemList
invalidReturnItems
optional
An array of invalid return item information.InvalidReturnItemList
returnAuthorizations
optional
An array of return authorization information.ReturnAuthorizationList

CreateFulfillmentReturnResponse

The response schema for the createFulfillmentReturn operation.

NameDescriptionSchema
payload
optional
The payload for the createFulfillmentReturn operation.CreateFulfillmentReturnResult
errors
optional
One or more unexpected errors occurred during the createFulfillmentReturn operation.ErrorList

CreateReturnItem

An item that Amazon accepted for return.

NameDescriptionSchema
sellerReturnItemId
required
An identifier assigned by the seller to the return item.
maxLength : 80
string
sellerFulfillmentOrderItemId
required
The identifier assigned to the item by the seller when the fulfillment order was created.string
amazonShipmentId
required
The identifier for the shipment that is associated with the return item.string
returnReasonCode
required
The return reason code assigned to the return item by the seller.string
returnComment
optional
An optional comment about the return item.
maxLength : 1000
string

CreateReturnItemList

An array of items to be returned.

Type : < CreateReturnItem > array

Money

An amount of money, including units in the form of currency.

NameDescriptionSchema
currencyCode
required
Three digit currency code in ISO 4217 format.string
value
required
A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.Decimal

Decimal

A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.

Type : string

DeliveryWindow

The time range within which a Scheduled Delivery fulfillment order should be delivered.

NameDescriptionSchema
startDate
required
The date and time of the start of the Scheduled Delivery window, in ISO 8601 date time format.Timestamp
endDate
required
The date and time of the end of the Scheduled Delivery window, in ISO 8601 date time format.Timestamp

DeliveryWindowList

An array of delivery windows.

Type : < DeliveryWindow > array

Fee

Fee type and cost.

NameDescriptionSchema
name
required
The type of fee.enum (Name)
amount
required
The amount of the fee.Money

FeeList

An array of fee type and cost pairs.

Type : < Fee > array

FulfillmentAction

Specifies whether the fulfillment order should ship now or have an order hold put on it.

Type : enum

ValueDescription
ShipThe fulfillment order ships now.
HoldAn order hold is put on the fulfillment order.

FulfillmentOrder

General information about a fulfillment order, including its status.

NameDescriptionSchema
sellerFulfillmentOrderId
required
The fulfillment order identifier submitted with the createFulfillmentOrder operation.string
marketplaceId
required
The identifier for the marketplace the fulfillment order is placed against.string
displayableOrderId
required
A fulfillment order identifier submitted with the createFulfillmentOrder operation. Displays as the order identifier in recipient-facing materials such as the packing slip.string
displayableOrderDate
required
A date and time submitted with the createFulfillmentOrder operation. Displays as the order date in recipient-facing materials such as the packing slip.Timestamp
displayableOrderComment
required
A text block submitted with the createFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip.string
shippingSpeedCategory
required
The shipping method used for the fulfillment order.ShippingSpeedCategory
deliveryWindow
optional
The time range within which a Scheduled Delivery fulfillment order should be delivered.DeliveryWindow
destinationAddress
required
The destination address submitted with the createFulfillmentOrder operation.Address
fulfillmentAction
optional
Specifies whether the fulfillment order should ship now or have an order hold put on it.FulfillmentAction
fulfillmentPolicy
optional
The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.FulfillmentPolicy
codSettings
optional
The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.CODSettings
receivedDate
required
The date and time that the fulfillment order was received by an Amazon fulfillment center.Timestamp
fulfillmentOrderStatus
required
The current status of the fulfillment order.FulfillmentOrderStatus
statusUpdatedDate
required
The date and time that the status of the fulfillment order last changed, in ISO 8601 date time format.Timestamp
notificationEmails
optional
A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.NotificationEmailList
featureConstraints
optional
A list of features and their fulfillment policies to apply to the order.< FeatureSettings > array

FulfillmentOrderItem

Item information for a fulfillment order.

NameDescriptionSchema
sellerSku
required
The seller SKU of the item.string
sellerFulfillmentOrderItemId
required
A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation.string
quantity
required
The item quantity.Quantity
giftMessage
optional
A message to the gift recipient, if applicable.string
displayableComment
optional
Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.string
fulfillmentNetworkSku
optional
Amazon's fulfillment network SKU of the item.string
orderItemDisposition
optional
Indicates whether the item is sellable or unsellable.string
cancelledQuantity
required
The item quantity that was cancelled by the seller.Quantity
unfulfillableQuantity
required
The item quantity that is unfulfillable.Quantity
estimatedShipDate
optional
The estimated date and time that the item quantity is scheduled to ship from the fulfillment center. Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, estimatedShipDate is not returned.Timestamp
estimatedArrivalDate
optional
The estimated arrival date and time of the item quantity. Note that this value can change over time. If the shipment that contains the item quantity has been cancelled, estimatedArrivalDate is not returned.Timestamp
perUnitPrice
optional
The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.Money
perUnitTax
optional
The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.Money
perUnitDeclaredValue
optional
The monetary value assigned by the seller to this item.Money

FulfillmentOrderItemList

An array of fulfillment order item information.

Type : < FulfillmentOrderItem > array

FulfillmentPreview

Information about a fulfillment order preview, including delivery and fee information based on shipping method.

NameDescriptionSchema
shippingSpeedCategory
required
The shipping method used for the fulfillment order.ShippingSpeedCategory
scheduledDeliveryInfo
optional
Delivery information for a scheduled delivery.ScheduledDeliveryInfo
isFulfillable
required
When true, this fulfillment order preview is fulfillable.boolean
isCODCapable
required
When true, this fulfillment order preview is for COD (Cash On Delivery).boolean
estimatedShippingWeight
optional
Estimated shipping weight for this fulfillment order preview.Weight
estimatedFees
optional
The estimated fulfillment fees for this fulfillment order preview, if applicable.FeeList
fulfillmentPreviewShipments
optional
An array of fulfillment preview shipment information.FulfillmentPreviewShipmentList
unfulfillablePreviewItems
optional
An array of unfulfillable preview item information.UnfulfillablePreviewItemList
orderUnfulfillableReasons
optional
Error codes associated with the fulfillment order preview that indicate why the order is not fulfillable.

Error code examples:

DeliverySLAUnavailable
InvalidDestinationAddress
StringList
marketplaceId
required
The marketplace the fulfillment order is placed against.string
featureConstraints
optional
A list of features and their fulfillment policies to apply to the order.< FeatureSettings > array

FulfillmentPreviewItem

Item information for a shipment in a fulfillment order preview.

NameDescriptionSchema
sellerSku
required
The seller SKU of the item.string
quantity
required
The item quantity.Quantity
sellerFulfillmentOrderItemId
required
A fulfillment order item identifier that the seller created with a call to the createFulfillmentOrder operation.string
estimatedShippingWeight
optional
The estimated shipping weight of the item quantity for a single item, as identified by sellerSku, in a shipment.Weight
shippingWeightCalculationMethod
optional
The method used to calculate the estimated shipping weight.enum (ShippingWeightCalculationMethod)

FulfillmentPreviewItemList

An array of fulfillment preview item information.

Type : < FulfillmentPreviewItem > array

FulfillmentPreviewList

An array of fulfillment preview information.

Type : < FulfillmentPreview > array

FulfillmentPreviewShipment

Delivery and item information for a shipment in a fulfillment order preview.

NameDescriptionSchema
earliestShipDate
optional
The earliest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format.Timestamp
latestShipDate
optional
The latest date that the shipment is expected to be sent from the fulfillment center, in ISO 8601 date time format.Timestamp
earliestArrivalDate
optional
The earliest date that the shipment is expected to arrive at its destination.Timestamp
latestArrivalDate
optional
The latest date that the shipment is expected to arrive at its destination, in ISO 8601 date time format.Timestamp
shippingNotes
optional
Provides additional insight into the shipment timeline when exact delivery dates are not able to be precomputed.< string > array
fulfillmentPreviewItems
required
Information about the items in the shipment.FulfillmentPreviewItemList

FulfillmentPreviewShipmentList

An array of fulfillment preview shipment information.

Type : < FulfillmentPreviewShipment > array

FulfillmentReturnItemStatus

Indicates if the return item has been processed by a fulfillment center.

Type : enum

ValueDescription
NewThe return item has not yet been processed by a fulfillment center.
ProcessedThe return item has been processed by a fulfillment center.

FulfillmentShipment

Delivery and item information for a shipment in a fulfillment order.

NameDescriptionSchema
amazonShipmentId
required
A shipment identifier assigned by Amazon.string
fulfillmentCenterId
required
An identifier for the fulfillment center that the shipment will be sent from.string
fulfillmentShipmentStatus
required
The current status of the shipment.enum (FulfillmentShipmentStatus)
shippingDate
optional
The meaning of the shippingDate value depends on the current status of the shipment. If the current value of FulfillmentShipmentStatus is:

  • Pending - shippingDate represents the estimated time that the shipment will leave the Amazon fulfillment center.

  • Shipped - shippingDate represents the date that the shipment left the Amazon fulfillment center.

  • If a shipment includes more than one package, shippingDate applies to all of the packages in the shipment. If the value of FulfillmentShipmentStatus is CancelledByFulfiller or CancelledBySeller, shippingDate is not returned. The value must be in ISO 8601 date time format.
    Timestamp
    estimatedArrivalDate
    optional
    The estimated arrival date and time of the shipment, in ISO 8601 date time format. Note that this value can change over time. If a shipment includes more than one package, estimatedArrivalDate applies to all of the packages in the shipment. If the shipment has been cancelled, estimatedArrivalDate is not returned.Timestamp
    shippingNotes
    optional
    Provides additional insight into shipment timeline. Primairly used to communicate that actual delivery dates aren't available.< string > array
    fulfillmentShipmentItem
    required
    An array of fulfillment shipment item information.FulfillmentShipmentItemList
    fulfillmentShipmentPackage
    optional
    An array of fulfillment shipment package information.FulfillmentShipmentPackageList

    FulfillmentShipmentItem

    Item information for a shipment in a fulfillment order.

    NameDescriptionSchema
    sellerSku
    required
    The seller SKU of the item.string
    sellerFulfillmentOrderItemId
    required
    The fulfillment order item identifier that the seller created and submitted with a call to the createFulfillmentOrder operation.string
    quantity
    required
    The item quantity.Quantity
    packageNumber
    optional
    An identifier for the package that contains the item quantity.integer (int32)
    serialNumber
    optional
    The serial number of the shipped item.string

    FulfillmentShipmentItemList

    An array of fulfillment shipment item information.

    Type : < FulfillmentShipmentItem > array

    FulfillmentShipmentList

    An array of fulfillment shipment information.

    Type : < FulfillmentShipment > array

    FulfillmentShipmentPackage

    Package information for a shipment in a fulfillment order.

    NameDescriptionSchema
    packageNumber
    required
    Identifies a package in a shipment.integer (int32)
    carrierCode
    required
    Identifies the carrier who will deliver the shipment to the recipient.string
    trackingNumber
    optional
    The tracking number, if provided, can be used to obtain tracking and delivery information.string
    estimatedArrivalDate
    optional
    The estimated arrival date and time of the package, in ISO 8601 date time format.Timestamp

    FulfillmentShipmentPackageList

    An array of fulfillment shipment package information.

    Type : < FulfillmentShipmentPackage > array

    GetFulfillmentOrderResult

    NameDescriptionSchema
    fulfillmentOrder
    required
    General information about a fulfillment order, including its status.FulfillmentOrder
    fulfillmentOrderItems
    required
    An array of fulfillment order item information.FulfillmentOrderItemList
    fulfillmentShipments
    optional
    An array of fulfillment shipment information.FulfillmentShipmentList
    returnItems
    required
    An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.ReturnItemList
    returnAuthorizations
    required
    An array of return authorization information.ReturnAuthorizationList

    GetFulfillmentOrderResponse

    The response schema for the getFulfillmentOrder operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getFulfillmentOrder operation.GetFulfillmentOrderResult
    errors
    optional
    One or more unexpected errors occurred during the getFulfillmentOrder operation.ErrorList

    GetFulfillmentPreviewItem

    Item information for a fulfillment order preview.

    NameDescriptionSchema
    sellerSku
    required
    The seller SKU of the item.
    maxLength : 50
    string
    quantity
    required
    The item quantity.Quantity
    perUnitDeclaredValue
    optional
    The monetary value assigned by the seller to this item. This is a required field if this order is an export order.Money
    sellerFulfillmentOrderItemId
    required
    A fulfillment order item identifier that the seller creates to track items in the fulfillment preview.
    maxLength : 50
    string

    GetFulfillmentPreviewItemList

    An array of fulfillment preview item information.

    Type : < GetFulfillmentPreviewItem > array

    GetFulfillmentPreviewRequest

    The request body schema for the getFulfillmentPreview operation.

    NameDescriptionSchema
    marketplaceId
    optional
    The marketplace the fulfillment order is placed against.string
    address
    required
    The destination address for the fulfillment order preview.Address
    items
    required
    Identifying information and quantity information for the items in the fulfillment order preview.GetFulfillmentPreviewItemList
    shippingSpeedCategories
    optional
    A list of shipping methods used for creating fulfillment order previews.

    Possible values:

  • Standard - Standard shipping method.

  • Expedited - Expedited shipping method.

  • Priority - Priority shipping method.

  • ScheduledDelivery - Scheduled Delivery shipping method.

  • Note: Shipping method service level agreements vary by marketplace. Sellers should see the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.
    ShippingSpeedCategoryList
    includeCODFulfillmentPreview
    optional
    Specifies whether to return fulfillment order previews that are for COD (Cash On Delivery).

    Possible values:

  • true - Returns all fulfillment order previews (both for COD and not for COD).

  • false - Returns only fulfillment order previews that are not for COD.
  • boolean
    includeDeliveryWindows
    optional
    Specifies whether to return the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery.boolean
    featureConstraints
    optional
    A list of features and their fulfillment policies to apply to the order.< FeatureSettings > array

    GetFulfillmentPreviewResult

    A list of fulfillment order previews, including estimated shipping weights, estimated shipping fees, and estimated ship dates and arrival dates.

    NameDescriptionSchema
    fulfillmentPreviews
    optional
    An array of fulfillment preview information.FulfillmentPreviewList

    GetFulfillmentPreviewResponse

    The response schema for the getFulfillmentPreview operation.

    NameDescriptionSchema
    payload
    optional
    The response payload for the getFulfillmentPreview operation.GetFulfillmentPreviewResult
    errors
    optional
    One or more unexpected errors occurred during the getFulfillmentPreview operation.ErrorList

    InvalidItemReasonCode

    A code for why the item is invalid for return.

    Type : enum

    ValueDescription
    InvalidValuesThe item was not found in a fulfillment order.
    DuplicateRequestA fulfillment return has already been requested for this item.
    NoCompletedShipItemsThe fulfillment order containing this item has not yet shipped.
    NoReturnableQuantityAll item quantity available for return has been allocated to other return items.

    InvalidItemReason

    The reason that the item is invalid for return.

    NameDescriptionSchema
    invalidItemReasonCode
    required
    A code for why the item is invalid for return.InvalidItemReasonCode
    description
    required
    A human readable description of the invalid item reason code.string

    InvalidReturnItem

    An item that is invalid for return.

    NameDescriptionSchema
    sellerReturnItemId
    required
    An identifier assigned by the seller to the return item.string
    sellerFulfillmentOrderItemId
    required
    The identifier assigned to the item by the seller when the fulfillment order was created.string
    invalidItemReason
    required
    The reason that the item is invalid for return.InvalidItemReason

    InvalidReturnItemList

    An array of invalid return item information.

    Type : < InvalidReturnItem > array

    ListAllFulfillmentOrdersResult

    NameDescriptionSchema
    nextToken
    optional
    When present and not empty, pass this string token in the next request to return the next response page.string
    fulfillmentOrders
    optional
    An array of fulfillment order information.< FulfillmentOrder > array

    ListAllFulfillmentOrdersResponse

    The response schema for the listAllFulfillmentOrders operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the listAllFulfillmentOrders operation.ListAllFulfillmentOrdersResult
    errors
    optional
    One or more unexpected errors occurred during the listAllFulfillmentOrders operation.ErrorList

    ListReturnReasonCodesResult

    NameDescriptionSchema
    reasonCodeDetails
    optional
    An array of return reason code details.ReasonCodeDetailsList

    ListReturnReasonCodesResponse

    The response schema for the listReturnReasonCodes operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the listReturnReasonCodes operation.ListReturnReasonCodesResult
    errors
    optional
    One or more unexpected errors occurred during the listReturnReasonCodes operation.ErrorList

    NotificationEmailList

    A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.

    Type : < string > array

    CurrentStatus

    The current delivery status of the package.

    Type : enum

    ValueDescription
    IN_TRANSITIn transit to the destination address.
    DELIVEREDDelivered to the destination address.
    RETURNINGIn the process of being returned to Amazon's fulfillment network.
    RETURNEDReturned to Amazon's fulfillment network.
    UNDELIVERABLEUndeliverable because package was lost or destroyed.
    DELAYEDDelayed.
    AVAILABLE_FOR_PICKUPAvailable for pickup.
    CUSTOMER_ACTIONRequires customer action.
    UNKNOWNUnknown Status Code was returned.
    OUT_FOR_DELIVERYOut for Delivery.
    DELIVERY_ATTEMPTEDDelivery Attempted.
    PICKUP_SUCCESSFULPickup Successful.
    PICKUP_CANCELLEDPickup Cancelled.
    PICKUP_ATTEMPTEDPickup Attempted.
    PICKUP_SCHEDULEDPickup Scheduled.
    RETURN_REQUEST_ACCEPTEDReturn Request Accepted.
    REFUND_ISSUEDRefund Issued.
    RETURN_RECEIVED_IN_FCReturn Received In FC.

    AdditionalLocationInfo

    Additional location information.

    Type : enum

    ValueDescription
    AS_INSTRUCTEDAs instructed.
    CARPORTCarport.
    CUSTOMER_PICKUPPicked up by customer.
    DECKDeck.
    DOOR_PERSONResident.
    FRONT_DESKFront desk.
    FRONT_DOORFront door.
    GARAGEGarage.
    GUARDResidential guard.
    MAIL_ROOMMail room.
    MAIL_SLOTMail slot.
    MAILBOXMailbox.
    MC_BOYDelivered to male child.
    MC_GIRLDelivered to female child.
    MC_MANDelivered to male adult.
    MC_WOMANDelivered to female adult.
    NEIGHBORDelivered to neighbor.
    OFFICEOffice.
    OUTBUILDINGOutbuilding.
    PATIOPatio.
    PORCHPorch.
    REAR_DOORRear door.
    RECEPTIONISTReceptionist.
    RECEIVERResident.
    SECURE_LOCATIONSecure location.
    SIDE_DOORSide door.

    PackageTrackingDetails

    NameDescriptionSchema
    packageNumber
    required
    The package identifier.integer (int32)
    trackingNumber
    optional
    The tracking number for the package.string
    customerTrackingLink
    optional
    Link on swiship.com that allows customers to track the package.string
    carrierCode
    optional
    The name of the carrier.string
    carrierPhoneNumber
    optional
    The phone number of the carrier.string
    carrierURL
    optional
    The URL of the carrier’s website.string
    shipDate
    optional
    The shipping date for the package.Timestamp
    estimatedArrivalDate
    optional
    The estimated arrival date.Timestamp
    shipToAddress
    optional
    The destination city for the package.TrackingAddress
    currentStatus
    optional
    The current delivery status of the package.CurrentStatus
    currentStatusDescription
    optional
    Description corresponding to the CurrentStatus value.string
    signedForBy
    optional
    The name of the person who signed for the package.string
    additionalLocationInfo
    optional
    Additional location information.AdditionalLocationInfo
    trackingEvents
    optional
    An array of tracking event information.TrackingEventList

    GetPackageTrackingDetailsResponse

    The response schema for the getPackageTrackingDetails operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getPackageTrackingDetails operation.PackageTrackingDetails
    errors
    optional
    One or more unexpected errors occurred during the getPackageTrackingDetails operation.ErrorList

    ReasonCodeDetails

    A return reason code, a description, and an optional description translation.

    NameDescriptionSchema
    returnReasonCode
    required
    A code that indicates a valid return reason.string
    description
    required
    A human readable description of the return reason code.string
    translatedDescription
    optional
    A translation of the description. The translation is in the language specified in the Language request parameter.string

    ReasonCodeDetailsList

    An array of return reason code details.

    Type : < ReasonCodeDetails > array

    ReturnAuthorization

    Return authorization information for items accepted for return.

    NameDescriptionSchema
    returnAuthorizationId
    required
    An identifier for the return authorization. This identifier associates return items with the return authorization used to return them.string
    fulfillmentCenterId
    required
    An identifier for the Amazon fulfillment center that the return items should be sent to.string
    returnToAddress
    required
    The address of the Amazon fulfillment center that the return items should be sent to.Address
    amazonRmaId
    required
    The return merchandise authorization (RMA) that Amazon needs to process the return.string
    rmaPageURL
    required
    A URL for a web page that contains the return authorization barcode and the mailing label. This does not include pre-paid shipping.string

    ReturnAuthorizationList

    An array of return authorization information.

    Type : < ReturnAuthorization > array

    ReturnItem

    An item that Amazon accepted for return.

    NameDescriptionSchema
    sellerReturnItemId
    required
    An identifier assigned by the seller to the return item.string
    sellerFulfillmentOrderItemId
    required
    The identifier assigned to the item by the seller when the fulfillment order was created.string
    amazonShipmentId
    required
    The identifier for the shipment that is associated with the return item.string
    sellerReturnReasonCode
    required
    The return reason code assigned to the return item by the seller.string
    returnComment
    optional
    An optional comment about the return item.string
    amazonReturnReasonCode
    optional
    The return reason code that the Amazon fulfillment center assigned to the return item.string
    status
    required
    Indicates if the return item has been processed by an Amazon fulfillment center.FulfillmentReturnItemStatus
    statusChangedDate
    required
    Indicates when the status last changed.Timestamp
    returnAuthorizationId
    optional
    Identifies the return authorization used to return this item. See ReturnAuthorization.string
    returnReceivedCondition
    optional
    The condition of the return item when received by an Amazon fulfillment center.ReturnItemDisposition
    fulfillmentCenterId
    optional
    The identifier for the Amazon fulfillment center that processed the return item.string

    ReturnItemDisposition

    The condition of the return item when received by an Amazon fulfillment center.

    Type : enum

    ValueDescription
    SellableItem is in sellable condition.
    DefectiveItem is defective.
    CustomerDamagedItem was damaged by the buyer or the seller.
    CarrierDamagedItem was damaged by the carrier.
    FulfillerDamagedItem was damaged by Amazon.

    ReturnItemList

    An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.

    Type : < ReturnItem > array

    ScheduledDeliveryInfo

    Delivery information for a scheduled delivery.

    NameDescriptionSchema
    deliveryTimeZone
    required
    The time zone of the destination address for the fulfillment order preview. Must be an IANA time zone name. Example: Asia/Tokyo.string
    deliveryWindows
    required
    An array of time ranges that are available for scheduled delivery.DeliveryWindowList

    ShippingSpeedCategoryList

    Type : < ShippingSpeedCategory > array

    StringList

    Type : < string > array

    Timestamp

    Type : string (date-time)

    TrackingAddress

    Address information for tracking the package.

    NameDescriptionSchema
    city
    required
    The city.
    maxLength : 150
    string
    state
    required
    The state.
    maxLength : 150
    string
    country
    required
    The country.
    maxLength : 6
    string

    EventCode

    The event code for the delivery event.

    Type : enum

    ValueDescription
    EVENT_101Carrier notified to pick up package.
    EVENT_102Shipment picked up from seller's facility.
    EVENT_201Arrival scan.
    EVENT_202Departure scan.
    EVENT_203Arrived at destination country.
    EVENT_204Initiated customs clearance process.
    EVENT_205Completed customs clearance process.
    EVENT_206In transit to pickup location.
    EVENT_301Delivered.
    EVENT_302Out for delivery.
    EVENT_304Delivery attempted.
    EVENT_306Customer contacted to arrange delivery.
    EVENT_307Delivery appointment scheduled.
    EVENT_308Available for pickup.
    EVENT_309Returned to seller.
    EVENT_401Held by carrier - incorrect address.
    EVENT_402Customs clearance delay.
    EVENT_403Customer moved.
    EVENT_404Delay in delivery due to external factors.
    EVENT_405Shipment damaged.
    EVENT_406Held by carrier.
    EVENT_407Customer refused delivery.
    EVENT_408Returning to seller.
    EVENT_409Lost by carrier.
    EVENT_411Paperwork received - did not receive shipment.
    EVENT_412Shipment received - did not receive paperwork.
    EVENT_413Held by carrier - customer refused shipment due to customs charges.
    EVENT_414Missorted by carrier.
    EVENT_415Received from prior carrier.
    EVENT_416Undeliverable.
    EVENT_417Shipment missorted.
    EVENT_418Shipment delayed.
    EVENT_419Address corrected - delivery rescheduled.

    TrackingEvent

    Information for tracking package deliveries.

    NameDescriptionSchema
    eventDate
    required
    The date and time that the delivery event took place, in ISO 8601 date time format.Timestamp
    eventAddress
    required
    The city where the delivery event took place.TrackingAddress
    eventCode
    required
    The event code for the delivery event.EventCode
    eventDescription
    required
    A description for the corresponding event code.string

    TrackingEventList

    An array of tracking event information.

    Type : < TrackingEvent > array

    UnfulfillablePreviewItem

    Information about unfulfillable items in a fulfillment order preview.

    NameDescriptionSchema
    sellerSku
    required
    The seller SKU of the item.
    maxLength : 50
    string
    quantity
    required
    The item quantity.Quantity
    sellerFulfillmentOrderItemId
    required
    A fulfillment order item identifier created with a call to the getFulfillmentPreview operation.
    maxLength : 50
    string
    itemUnfulfillableReasons
    optional
    Error codes associated with the fulfillment order preview that indicate why the item is unfulfillable.StringList

    UnfulfillablePreviewItemList

    An array of unfulfillable preview item information.

    Type : < UnfulfillablePreviewItem > array

    UpdateFulfillmentOrderItem

    Item information for updating a fulfillment order.

    NameDescriptionSchema
    sellerSku
    optional
    The seller SKU of the item.string
    sellerFulfillmentOrderItemId
    required
    Identifies the fulfillment order item to update. Created with a previous call to the createFulfillmentOrder operation.
    maxLength : 50
    string
    quantity
    required
    The item quantity.Quantity
    giftMessage
    optional
    A message to the gift recipient, if applicable.
    maxLength : 512
    string
    displayableComment
    optional
    Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.
    maxLength : 250
    string
    fulfillmentNetworkSku
    optional
    Amazon's fulfillment network SKU of the item.string
    orderItemDisposition
    optional
    Indicates whether the item is sellable or unsellable.string
    perUnitDeclaredValue
    optional
    The monetary value assigned by the seller to this item.Money
    perUnitPrice
    optional
    The amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.Money
    perUnitTax
    optional
    The tax on the amount to be collected from the recipient for this item in a COD (Cash On Delivery) order.Money

    UpdateFulfillmentOrderItemList

    An array of fulfillment order item information for updating a fulfillment order.

    Type : < UpdateFulfillmentOrderItem > array

    UpdateFulfillmentOrderRequest

    NameDescriptionSchema
    marketplaceId
    optional
    The marketplace the fulfillment order is placed against.string
    displayableOrderId
    optional
    A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.
    maxLength : 40
    string
    displayableOrderDate
    optional
    The date and time of the fulfillment order. Displays as the order date in recipient-facing materials such as the outbound shipment packing slip.Timestamp
    displayableOrderComment
    optional
    Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.
    maxLength : 1000
    string
    shippingSpeedCategory
    optional
    The shipping method used for the fulfillment order.ShippingSpeedCategory
    destinationAddress
    optional
    The destination address for the fulfillment order.Address
    fulfillmentAction
    optional
    Specifies whether the fulfillment order should ship now or have an order hold put on it.FulfillmentAction
    fulfillmentPolicy
    optional
    The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.FulfillmentPolicy
    shipFromCountryCode
    optional
    The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.string
    notificationEmails
    optional
    A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.NotificationEmailList
    featureConstraints
    optional
    A list of features and their fulfillment policies to apply to the order.< FeatureSettings > array
    items
    optional
    A list of items to include in the fulfillment order preview, including quantity.UpdateFulfillmentOrderItemList

    UpdateFulfillmentOrderResponse

    The response schema for the updateFulfillmentOrder operation.

    NameDescriptionSchema
    errors
    optional
    One or more unexpected errors occurred during the updateFulfillmentOrder operation.ErrorList

    CreateFulfillmentOrderResponse

    The response schema for the createFulfillmentOrder operation.

    NameDescriptionSchema
    errors
    optional
    One or more unexpected errors occurred during the createFulfillmentOrder operation.ErrorList

    CancelFulfillmentOrderResponse

    The response schema for the cancelFulfillmentOrder operation.

    NameDescriptionSchema
    errors
    optional
    One or more unexpected errors occurred during the cancelFulfillmentOrder operation.ErrorList

    Weight

    The weight.

    NameDescriptionSchema
    unit
    required
    The unit of weight.enum (Unit)
    value
    required
    The weight value.string

    Quantity

    The item quantity.

    Type : integer (int32)

    ShippingSpeedCategory

    The shipping method used for the fulfillment order.

    Type : enum

    ValueDescription
    StandardStandard shipping method.
    ExpeditedExpedited shipping method.
    PriorityPriority shipping method.
    ScheduledDeliveryScheduled Delivery shipping method.

    GetFeatureInventoryResponse

    The breakdown of eligibility inventory by feature.

    NameDescriptionSchema
    payload
    optional
    The payload for the getEligibileInventory operation.GetFeatureInventoryResult
    errors
    optional
    One or more unexpected errors occurred during the getFeatureInventory operation.ErrorList

    GetFeatureInventoryResult

    The payload for the getEligibileInventory operation.

    NameDescriptionSchema
    marketplaceId
    required
    The requested marketplace.string
    featureName
    required
    The name of the feature.string
    nextToken
    optional
    When present and not empty, pass this string token in the next request to return the next response page.string
    featureSkus
    optional
    An array of SKUs eligible for this feature and the quantity available.< FeatureSku > array

    FeatureSku

    Information about an SKU, including the count available, identifiers, and a list of overlapping SKUs that share the same inventory pool.

    NameDescriptionSchema
    sellerSku
    optional
    Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.string
    fnSku
    optional
    The unique SKU used by Amazon's fulfillment network.string
    asin
    optional
    The Amazon Standard Identification Number (ASIN) of the item.string
    skuCount
    optional
    The number of SKUs available for this service.number
    overlappingSkus
    optional
    Other seller SKUs that are shared across the same inventory.< string > array

    GetFeaturesResponse

    The response schema for the getFeatures operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getFeatures operation.GetFeaturesResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GetFeaturesResult

    The payload for the getFeatures operation.

    NameDescriptionSchema
    features
    required
    An array of features.Features

    Features

    An array of features.

    Type : < Feature > array

    Feature

    A Multi-Channel Fulfillment feature.

    NameDescriptionSchema
    featureName
    required
    The feature name.string
    featureDescription
    required
    The feature description.string
    sellerEligible
    optional
    When true, indicates that the seller is eligible to use the feature.boolean

    GetFeatureSkuResponse

    The response schema for the getFeatureSKU operation.

    NameDescriptionSchema
    payload
    optional
    The payload for the getFeatureSKU operation.GetFeatureSkuResult
    errors
    optional
    A list of error responses returned when a request is unsuccessful.ErrorList

    GetFeatureSkuResult

    The payload for the getFeatureSKU operation.

    NameDescriptionSchema
    marketplaceId
    required
    The requested marketplace.string
    featureName
    required
    The name of the feature.string
    isEligible
    required
    When true, the seller SKU is eligible for the requested feature.boolean
    ineligibleReasons
    optional
    A list of one or more reasons that the seller SKU is ineligibile for the feature.

    Possible values:
  • MERCHANT_NOT_ENROLLED - The merchant isn't enrolled for the feature.

  • SKU_NOT_ELIGIBLE - The SKU doesn't reside in a warehouse that supports the feature.

  • INVALID_SKU - There is an issue with the SKU provided.
  • < string > array
    skuInfo
    optional
    Information about the SKU, including the count available, identifiers, and a list of overlapping SKUs that share the same inventory pool.FeatureSku

    FeatureSettings

    FeatureSettings allows users to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, use featureName as BLOCK_AMZL and featureFulfillmentPolicy as Required. Blocking AMZL will incur an additional fee surcharge on your MCF orders and increase the risk of some of your orders being unfulfilled or delivered late if there are no alternative carriers available. Using BLOCK_AMZL in an order request will take precedence over your Seller Central account setting.

    NameDescriptionSchema
    featureName
    optional
    The name of the feature.string
    featureFulfillmentPolicy
    optional
    Specifies the policy to use when fulfilling an order.enum (FeatureFulfillmentPolicy)

    FulfillmentShipmentStatus

    The current status of the shipment.

    Type : enum

    ValueDescription
    PENDINGThe process of picking units from inventory has begun.
    SHIPPEDAll packages in the shipment have left the fulfillment center.
    CANCELLED_BY_FULFILLERThe Amazon fulfillment center could not fulfill the shipment as planned. This might be because the inventory was not at the expected location in the fulfillment center. After cancelling the fulfillment order, Amazon immediately creates a new fulfillment shipment and again attempts to fulfill the order.
    CANCELLED_BY_SELLERThe shipment was cancelled using the CancelFulfillmentOrder request.

    FeatureFulfillmentPolicy

    Specifies the policy to use when fulfilling an order.

    Type : enum

    ValueDescription
    RequiredIf the offer can't be shipped with the selected feature, reject the order.
    NotRequiredThe feature is not required for shipping.

    Unit

    The unit of weight.

    Type : enum

    ValueDescription
    KGKilograms.
    KILOGRAMSKilograms.
    LBPounds.
    POUNDSPounds.

    Name

    The type of fee.

    Type : enum

    ValueDescription
    FBAPerUnitFulfillmentFeeEstimated fee for each unit in the fulfillment order.
    FBAPerOrderFulfillmentFeeEstimated order-level fee.
    FBATransportationFeeEstimated shipping fee.
    FBAFulfillmentCODFeeEstimated COD (Cash On Delivery) fee. This fee applies only to fulfillment order previews for COD.

    ShippingWeightCalculationMethod

    The method used to calculate the estimated shipping weight.

    Type : enum

    ValueDescription
    PackageBased on the actual weight of the items.
    DimensionalBased on the cubic space that the items occupy.

    Did this page help you?