Fulfillment Outbound API v2020-07-01 Reference

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

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
deliveryOffers
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
2	30

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Parameters

Type	Name	Description	Schema
Body	body required	GetFulfillmentPreviewRequest parameter	GetFulfillmentPreviewRequest

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.	GetFulfillmentPreviewResponse
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.	GetFulfillmentPreviewResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFulfillmentPreviewResponse
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.	GetFulfillmentPreviewResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFulfillmentPreviewResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFulfillmentPreviewResponse
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFulfillmentPreviewResponse

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

Operation: deliveryOffers

Description

Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.

Usage Plan:

Rate (requests per second)	Burst
5	30

Parameters

Type	Name	Description	Schema
Body	body required	GetDeliveryOffersRequest parameter	GetDeliveryOffersRequest

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.	GetDeliveryOffersResponse
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.	GetDeliveryOffersResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetDeliveryOffersResponse
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.	GetDeliveryOffersResponse
404	The 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.	GetDeliveryOffersResponse
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetDeliveryOffersResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetDeliveryOffersResponse
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetDeliveryOffersResponse

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
2	30

Parameters

Type	Name	Description	Schema
Query	queryStartDate 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)
Query	nextToken optional	A string token returned in the response to your previous request.	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.	ListAllFulfillmentOrdersResponse
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.	ListAllFulfillmentOrdersResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListAllFulfillmentOrdersResponse
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.	ListAllFulfillmentOrdersResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListAllFulfillmentOrdersResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListAllFulfillmentOrdersResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Body	body required	CreateFulfillmentOrderRequest parameter	CreateFulfillmentOrderRequest

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.	CreateFulfillmentOrderResponse
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.	CreateFulfillmentOrderResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CreateFulfillmentOrderResponse
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.	CreateFulfillmentOrderResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CreateFulfillmentOrderResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CreateFulfillmentOrderResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Query	packageNumber required	The unencrypted package identifier returned by the `getFulfillmentOrder` operation.	integer (int32)

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.	GetPackageTrackingDetailsResponse
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.	GetPackageTrackingDetailsResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetPackageTrackingDetailsResponse
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.	GetPackageTrackingDetailsResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetPackageTrackingDetailsResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetPackageTrackingDetailsResponse
503	Temporary overloading or maintenance of the server. Headers : `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. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.

Usage Plan:

Rate (requests per second)	Burst
2	30

Parameters

Type	Name	Description	Schema
Query	sellerSku required	The seller SKU for which return reason codes are required.	string
Query	marketplaceId optional	The marketplace for which the seller wants return reason codes.	string
Query	sellerFulfillmentOrderId 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
Query	language optional	The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.	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.	ListReturnReasonCodesResponse
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.	ListReturnReasonCodesResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListReturnReasonCodesResponse
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.	ListReturnReasonCodesResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListReturnReasonCodesResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ListReturnReasonCodesResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Body	body required	CreateFulfillmentReturnRequest parameter	CreateFulfillmentReturnRequest
Path	sellerFulfillmentOrderId 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 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.	CreateFulfillmentReturnResponse
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.	CreateFulfillmentReturnResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CreateFulfillmentReturnResponse
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.	CreateFulfillmentReturnResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CreateFulfillmentReturnResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CreateFulfillmentReturnResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Path	sellerFulfillmentOrderId required	The identifier assigned to the item by the seller when the fulfillment order was created. maxLength : 40	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.	GetFulfillmentOrderResponse
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.	GetFulfillmentOrderResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFulfillmentOrderResponse
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.	GetFulfillmentOrderResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFulfillmentOrderResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFulfillmentOrderResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Body	body required	UpdateFulfillmentOrderRequest parameter	UpdateFulfillmentOrderRequest
Path	sellerFulfillmentOrderId required	The identifier assigned to the item by the seller when the fulfillment order was created. maxLength : 40	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.	UpdateFulfillmentOrderResponse
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.	UpdateFulfillmentOrderResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	UpdateFulfillmentOrderResponse
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.	UpdateFulfillmentOrderResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	UpdateFulfillmentOrderResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	UpdateFulfillmentOrderResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Path	sellerFulfillmentOrderId required	The identifier assigned to the item by the seller when the fulfillment order was created. maxLength : 40	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.	CancelFulfillmentOrderResponse
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.	CancelFulfillmentOrderResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CancelFulfillmentOrderResponse
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.	CancelFulfillmentOrderResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CancelFulfillmentOrderResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	CancelFulfillmentOrderResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Query	marketplaceId required	The marketplace for which to return the list of features.	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.	GetFeaturesResponse
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.	GetFeaturesResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeaturesResponse
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.	GetFeaturesResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeaturesResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeaturesResponse
503	Temporary overloading or maintenance of the server. Headers : `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
2	30

Parameters

Type	Name	Description	Schema
Query	marketplaceId required	The marketplace for which to return a list of the inventory that is eligible for the specified feature.	string
Path	featureName required	The name of the feature for which to return a list of eligible inventory.	string
Query	nextToken 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
Query	queryStartDate optional	A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ	string (date-time)

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.	GetFeatureInventoryResponse
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.	GetFeatureInventoryResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeatureInventoryResponse
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.	GetFeatureInventoryResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeatureInventoryResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeatureInventoryResponse
503	Temporary overloading or maintenance of the server. Headers : `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. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.

Usage Plan:

Rate (requests per second)	Burst
2	30

Parameters

Type	Name	Description	Schema
Query	marketplaceId required	The marketplace for which to return the count.	string
Path	featureName required	The name of the feature.	string
Path	sellerSku 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 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.	GetFeatureSkuResponse
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.	GetFeatureSkuResponse
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeatureSkuResponse
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.	GetFeatureSkuResponse
404	The 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
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeatureSkuResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeatureSkuResponse
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	GetFeatureSkuResponse

Definitions

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
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.

Name	Description	Schema
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. This property is required in all countries except Japan. It should not be used in Japan.	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 required	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.

Name	Description	Schema
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.

Name	Description	Schema
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. This is a required field for India MCF orders.	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

Value	Description
FillOrKill	If 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. Refer to the `FulfillmentShipment` object for shipment status definitions.
FillAll	All 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.
FillAllAvailable	All 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

Value	Description
New	The fulfillment order was received but not yet validated.
Received	The 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.
Planning	The 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.
Processing	The 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.
Cancelled	The fulfillment order has been cancelled by the seller.
Complete	All item quantities in the fulfillment order have been fulfilled.
CompletePartialled	Some item quantities in the fulfillment order were fulfilled; the rest were either cancelled or unfulfillable.
Unfulfillable	No 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.
Invalid	The 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.

Name	Description	Schema
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 : 750	string
shippingSpeedCategory required	The shipping method for the fulfillment order. When this value is `ScheduledDelivery`, choose Ship for the `fulfillmentAction`. Hold is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. Note: Shipping method service level agreements vary by marketplace. Sellers can refer to Seller Central for shipping method service-level agreements and multi-channel fulfillment fees.	ShippingSpeedCategory
deliveryWindow optional	The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace.	DeliveryWindow
destinationAddress required	The destination address for the fulfillment order.	Address
deliveryPreferences optional	The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort. For eligible orders, the default delivery preference is to leave the package unattended at the front door. This feature is currently supported only in the JP marketplace and not applicable for other marketplaces. For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.	DeliveryPreferences
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. Maximum of 100 line items with a maximum of 250 units per order.	CreateFulfillmentOrderItemList
paymentInformation optional	An array of various payment attributes related to this fulfillment order. This property is required if the order is placed against the India marketplace.	PaymentInformationList

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.

Name	Description	Schema
items required	An array of items to be returned.	CreateReturnItemList

CreateFulfillmentReturnResult

The result for the createFulfillmentReturn operation.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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. This is only available in the JP marketplace.

Name	Description	Schema
startDate required	The date and time of the start of the Scheduled Delivery window. Must be in ISO 8601 format.	Timestamp
endDate required	The date and time of the end of the Scheduled Delivery window. Must be in ISO 8601 format.	Timestamp

DeliveryWindowList

An array of delivery windows.

Type : < DeliveryWindow > array

DeliveryPreferences

The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort.
This feature is currently supported only in the JP marketplace and not applicable for other marketplaces.
For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.

Name	Description	Schema
deliveryInstructions optional	Additional delivery instructions. For example, this could be instructions on how to enter a building, nearby landmark or navigation instructions, 'Beware of dogs', etc. maxLength : 250	string
dropOffLocation optional	The preferred location to leave packages at the destination address.	DropOffLocation

DropOffLocation

The preferred location to leave packages at the destination address.

Name	Description	Schema
type required	Specifies the preferred location to leave the package at the destination address.	enum (Type)
attributes optional	Additional information about the drop-off location that can vary depending on the type of drop-off location specified in the `type` field. If the `type` is set to `FALLBACK_NEIGHBOR_DELIVERY`, the `attributes` object should include the exact keys `neighborName` and `houseNumber` to provide the name and house number of the designated neighbor.	< string, string > map

Fee

Fee type and cost.

Name	Description	Schema
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

Value	Description
Ship	The fulfillment order ships now.
Hold	An order hold is put on the fulfillment order.

FulfillmentOrder

General information about a fulfillment order, including its status.

Name	Description	Schema
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. When this value is `ScheduledDelivery`, choose `Ship` for the `fulfillmentAction`. `Hold` is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. Note: Shipping method service level agreements vary by marketplace. Sellers should refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.	ShippingSpeedCategory
deliveryWindow optional	The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace.	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. Must be in ISO 8601 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.

Name	Description	Schema
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. This is a required field for India MCF orders.	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.

Name	Description	Schema
shippingSpeedCategory required	The shipping method used for the fulfillment order. When this value is `ScheduledDelivery`, choose `Ship` for the `fulfillmentAction`. `Hold` is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. Note: Shipping method service level agreements vary by marketplace. Sellers should refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.	ShippingSpeedCategory
scheduledDeliveryInfo optional	Delivery information for a scheduled delivery. This is only available in the JP marketplace.	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. The fees data will not be available for IN marketplace orders.	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.

Name	Description	Schema
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.

Name	Description	Schema
earliestShipDate optional	The earliest date that the shipment is expected to be sent from the fulfillment center. Must be in ISO 8601 format.	Timestamp
latestShipDate optional	The latest date that the shipment is expected to be sent from the fulfillment center. Must be in ISO 8601 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. Must be in ISO 8601 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

Value	Description
New	The return item has not yet been processed by a fulfillment center.
Processed	The return item has been processed by a fulfillment center.

FulfillmentShipment

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

Name	Description	Schema
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 format.	Timestamp
estimatedArrivalDate optional	The estimated arrival date and time of the shipment. Must be in ISO 8601 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.

Name	Description	Schema
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
manufacturerLotCodes optional	The manufacturer lot codes of the shipped items.	StringList

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.

Name	Description	Schema
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. Must be in ISO 8601 format.	Timestamp
lockerDetails optional	The locker details, if provided can be used to access locker delivery box.	LockerDetails
deliveryInformation optional	The delivery information for the package. This information is available after the package is delivered.	DeliveryInformation

FulfillmentShipmentPackageList

An array of fulfillment shipment package information.

Type : < FulfillmentShipmentPackage > array

GetFulfillmentOrderResult

The request for the getFulfillmentOrder operation.

Name	Description	Schema
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
paymentInformation optional	An array of various payment attributes related to this fulfillment order.	PaymentInformationList

GetFulfillmentOrderResponse

The response schema for the getFulfillmentOrder operation.

Name	Description	Schema
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.

Name	Description	Schema
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 or an India MCF 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.

Name	Description	Schema
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. Maximum of 100 line items with a maximum of 250 units per order.	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 refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.	ShippingSpeedCategoryList
includeCODFulfillmentPreview optional	When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD.	boolean
includeDeliveryWindows optional	When true, returns 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.

Name	Description	Schema
fulfillmentPreviews optional	An array of fulfillment preview information.	FulfillmentPreviewList

GetFulfillmentPreviewResponse

The response schema for the getFulfillmentPreview operation.

Name	Description	Schema
payload optional	The response payload for the `getFulfillmentPreview` operation.	GetFulfillmentPreviewResult
errors optional	One or more unexpected errors occurred during the `getFulfillmentPreview` operation.	ErrorList

GetDeliveryOffersRequest

The request body schema for the getDeliveryOffers operation.

Name	Description	Schema
product required	The product details for the delivery offer.	GetDeliveryOffersProduct
terms required	The terms for the delivery offer.	GetDeliveryOffersTerms

GetDeliveryOffersResponse

The response schema for the getDeliveryOffers operation.

Name	Description	Schema
payload optional	The response payload for the getDeliveryOffers operation.	GetDeliveryOffersResult
errors optional	One or more unexpected errors occurred during the getDeliveryOffers operation.	ErrorList

GetDeliveryOffersResult

A list of delivery offers, including offer expiration, earliest and latest date and time range, and the delivery offer policy.

Name	Description	Schema
deliveryOffers optional	An array of delivery offers.	DeliveryOffersList

DeliveryOffersList

An array of delivery offer information.

Type : < DeliveryOffer > array

DeliveryOffer

An available offer for delivery of a product.

Name	Description	Schema
expiresAt optional	The timestamp at which a delivery offer expires.	Timestamp
dateRange optional	The range between which delivery is expected.	DateRange
policy optional	The policy for a delivery offer, including localized messaging.	DeliveryPolicy

GetDeliveryOffersProduct

The product details for the delivery offer.

Name	Description	Schema
productIdentifier required	Product identifier input that locates a product for MCF.	ProductIdentifier
amount optional	The amount of the requested product.	Amount

Amount

A quantity based on unit of measure.

Name	Description	Schema
unitOfMeasure required	The unit of measure for the amount.	enum (UnitOfMeasure)
value required	The amount of a product in the associated unit of measure.	Decimal

GetDeliveryOffersTerms

The delivery terms for the delivery offer.

Name	Description	Schema
origin required	The origin for the delivery offer.	Origin
destination required	The destination for the delivery offer.	Destination

IpAddress

An IP Address.

Type : string (ip)

Destination

The destination for the delivery offer.

Name	Description	Schema
deliveryAddress optional	A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone.	VariablePrecisionAddress
ipAddress optional	The IP address of the customer.	IpAddress

ProductIdentifier

Product identifier input that locates a product for MCF.

Name	Description	Schema
merchantSku required	The merchant SKU for the product. maxLength : 50	string

Origin

The origin for the delivery offer.

Name	Description	Schema
countryCode required	The two digit country code the items should ship from. In ISO 3166-1 alpha-2 format. minLength : 2 maxLength : 2	string

VariablePrecisionAddress

A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone.

Name	Description	Schema
addressLine1 optional	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. This property should not be used in Japan.	string
districtOrCounty optional	The district or county where the person, business, or institution is located.	string
stateOrRegion optional	The state or region where the person, business or institution is located.	string
postalCode required	The postal code of the address.	string
countryCode required	The two digit country code. In ISO 3166-1 alpha-2 format. minLength : 2 maxLength : 2	string

DateRange

The time range within which something (for example, a delivery) will occur.

Name	Description	Schema
earliest required	The earliest point in a date range.	Timestamp
latest required	The latest point in a date range.	Timestamp

DeliveryPolicy

The policy for a delivery offering.

Name	Description	Schema
message optional	Localized messaging for a delivery offering.	DeliveryMessage

DeliveryMessage

Localized messaging for a delivery offering.

Name	Description	Schema
text optional	The message content for a delivery offering.	string
locale optional	The locale for the message (for example, en_US).	string

InvalidItemReasonCode

A code for why the item is invalid for return.

Type : enum

Value	Description
InvalidValues	The item was not found in a fulfillment order.
DuplicateRequest	A fulfillment return has already been requested for this item.
NoCompletedShipItems	The fulfillment order containing this item has not yet shipped.
NoReturnableQuantity	All item quantity available for return has been allocated to other return items.

InvalidItemReason

The reason that the item is invalid for return.

Name	Description	Schema
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.

Name	Description	Schema
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

The request for the listAllFulfillmentOrders operation.

Name	Description	Schema
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.

Name	Description	Schema
payload optional	The payload for the `listAllFulfillmentOrders` operation.	ListAllFulfillmentOrdersResult
errors optional	One or more unexpected errors occurred during the `listAllFulfillmentOrders` operation.	ErrorList

ListReturnReasonCodesResult

The request for the listReturnReasonCodes operation.

Name	Description	Schema
reasonCodeDetails optional	An array of return reason code details.	ReasonCodeDetailsList

ListReturnReasonCodesResponse

The response schema for the listReturnReasonCodes operation.

Name	Description	Schema
payload optional	The payload for the `listReturnReasonCodes` operation.	ListReturnReasonCodesResult
errors optional	One or more unexpected errors occurred during the `listReturnReasonCodes` operation.	ErrorList

LockerDetails

The locker details, which you can use to access the locker delivery box.

Name	Description	Schema
lockerNumber optional	Indicates the locker number	string
lockerAccessCode optional	Indicates the locker access code	string

DeliveryInformation

The delivery information for the package. This information is available after the package is delivered.

Name	Description	Schema
deliveryDocumentList optional	All of the delivery documents for a package.	DeliveryDocumentList
dropOffLocation optional	The drop off location for a package.	DropOffLocation

DeliveryDocumentList

A list of delivery documents for a package.

Type : < DeliveryDocument > array

DeliveryDocument

A delivery document for a package.

Name	Description	Schema
documentType required	The delivery document type. Values are `SIGNATURE` and `DELIVERY_IMAGE`.	string
url optional	A URL that you can use to download the document. This URL has a `Content-Type` header. Note that the URL expires after one hour. To get a new URL, you must call the API again.	string

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

Value	Description
IN_TRANSIT	In transit to the destination address.
DELIVERED	Delivered to the destination address.
RETURNING	In the process of being returned to Amazon's fulfillment network.
RETURNED	Returned to Amazon's fulfillment network.
UNDELIVERABLE	Undeliverable because package was lost or destroyed.
DELAYED	Delayed.
AVAILABLE_FOR_PICKUP	Available for pickup.
CUSTOMER_ACTION	Requires customer action.
UNKNOWN	Unknown Status Code was returned.
OUT_FOR_DELIVERY	Out for Delivery.
DELIVERY_ATTEMPTED	Delivery Attempted.
PICKUP_SUCCESSFUL	Pickup Successful.
PICKUP_CANCELLED	Pickup Cancelled.
PICKUP_ATTEMPTED	Pickup Attempted.
PICKUP_SCHEDULED	Pickup Scheduled.
RETURN_REQUEST_ACCEPTED	Return Request Accepted.
REFUND_ISSUED	Refund Issued.
RETURN_RECEIVED_IN_FC	Return Received In FC.

AdditionalLocationInfo

Additional location information.

Type : enum

Value	Description
AS_INSTRUCTED	As instructed.
CARPORT	Carport.
CUSTOMER_PICKUP	Picked up by customer.
DECK	Deck.
DOOR_PERSON	Resident.
FRONT_DESK	Front desk.
FRONT_DOOR	Front door.
GARAGE	Garage.
GUARD	Residential guard.
MAIL_ROOM	Mail room.
MAIL_SLOT	Mail slot.
MAILBOX	Mailbox.
MC_BOY	Delivered to male child.
MC_GIRL	Delivered to female child.
MC_MAN	Delivered to male adult.
MC_WOMAN	Delivered to female adult.
NEIGHBOR	Delivered to neighbor.
OFFICE	Office.
OUTBUILDING	Outbuilding.
PATIO	Patio.
PORCH	Porch.
REAR_DOOR	Rear door.
RECEPTIONIST	Receptionist.
RECEIVER	Resident.
SECURE_LOCATION	Secure location.
SIDE_DOOR	Side door.

PackageTrackingDetails

Tracking details of package

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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

PaymentInformation

The attributes related to the payment made from customer to seller for this order.

Name	Description	Schema
paymentTransactionId required	The transaction identifier of this payment.	string
paymentMode required	The transaction mode of this payment.	string
paymentDate required	The transaction date of this payment.	Timestamp

ReturnAuthorization

Return authorization information for items accepted for return.

Name	Description	Schema
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

PaymentInformationList

An array of various payment attributes related to this fulfillment order.

Type : < PaymentInformation > array

ReturnAuthorizationList

An array of return authorization information.

Type : < ReturnAuthorization > array

ReturnItem

An item that Amazon accepted for return.

Name	Description	Schema
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. Refer to `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

Value	Description
Sellable	Item is in sellable condition.
Defective	Item is defective.
CustomerDamaged	Item was damaged by the buyer or the seller.
CarrierDamaged	Item was damaged by the carrier.
FulfillerDamaged	Item 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. This is only available in the JP marketplace.

Name	Description	Schema
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

ShippingSpeedCategory List

Type : < ShippingSpeedCategory > array

StringList

String list

Type : < string > array

Timestamp

Date timestamp

Type : string (date-time)

TrackingAddress

Address information for tracking the package.

Name	Description	Schema
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

Value	Description
EVENT_101	Carrier notified to pick up package.
EVENT_102	Shipment picked up from seller's facility.
EVENT_201	Arrival scan.
EVENT_202	Departure scan.
EVENT_203	Arrived at destination country.
EVENT_204	Initiated customs clearance process.
EVENT_205	Completed customs clearance process.
EVENT_206	In transit to pickup location.
EVENT_301	Delivered.
EVENT_302	Out for delivery.
EVENT_304	Delivery attempted.
EVENT_306	Customer contacted to arrange delivery.
EVENT_307	Delivery appointment scheduled.
EVENT_308	Available for pickup.
EVENT_309	Returned to seller.
EVENT_401	Held by carrier - incorrect address.
EVENT_402	Customs clearance delay.
EVENT_403	Customer moved.
EVENT_404	Delay in delivery due to external factors.
EVENT_405	Shipment damaged.
EVENT_406	Held by carrier.
EVENT_407	Customer refused delivery.
EVENT_408	Returning to seller.
EVENT_409	Lost by carrier.
EVENT_411	Paperwork received - did not receive shipment.
EVENT_412	Shipment received - did not receive paperwork.
EVENT_413	Held by carrier - customer refused shipment due to customs charges.
EVENT_414	Missorted by carrier.
EVENT_415	Received from prior carrier.
EVENT_416	Undeliverable.
EVENT_417	Shipment missorted.
EVENT_418	Shipment delayed.
EVENT_419	Address corrected - delivery rescheduled.

TrackingEvent

Information for tracking package deliveries.

Name	Description	Schema
eventDate required	The date and time that the delivery event took place. Must be in ISO 8601 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.

Name	Description	Schema
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.

Name	Description	Schema
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. This is a required field for India MCF orders.	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

The request body schema for the updateFulfillmentOrder operation.

Name	Description	Schema
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 : 750	string
shippingSpeedCategory optional	The shipping method used for the fulfillment order. When this value is `ScheduledDelivery`, choose `Ship` for the `fulfillmentAction`. `Hold` is not a valid `fulfillmentAction` value when the `shippingSpeedCategory` value is `ScheduledDelivery`. Note: Shipping method service level agreements vary by marketplace. Sellers should refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.	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.

Name	Description	Schema
errors optional	One or more unexpected errors occurred during the `updateFulfillmentOrder` operation.	ErrorList

CreateFulfillmentOrderResponse

The response schema for the createFulfillmentOrder operation.

Name	Description	Schema
errors optional	One or more unexpected errors occurred during the `createFulfillmentOrder` operation.	ErrorList

CancelFulfillmentOrderResponse

The response schema for the cancelFulfillmentOrder operation.

Name	Description	Schema
errors optional	One or more unexpected errors occurred during the `cancelFulfillmentOrder` operation.	ErrorList

Weight

The weight.

Name	Description	Schema
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. When this value is ScheduledDelivery, choose Ship for the fulfillmentAction. Hold is not a valid fulfillmentAction value when the shippingSpeedCategory value is ScheduledDelivery.
Note: Shipping method service level agreements vary by marketplace. Sellers should refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.

Type : enum

Value	Description
Standard	Standard shipping method.
Expedited	Expedited shipping method.
Priority	Priority shipping method.
ScheduledDelivery	Scheduled Delivery shipping method. This is only available in the JP marketplace.

GetFeatureInventoryResponse

The breakdown of eligibility inventory by feature.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
features required	An array of features.	Features

Features

An array of features.

Type : < Feature > array

Feature

A Multi-Channel Fulfillment feature.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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. To ship in non-Amazon branded packaging (blank boxes), use featureName BLANK_BOX.

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

Type

Specifies the preferred location to leave the package at the destination address.

Type : enum

Value	Description
FRONT_DOOR	Indicates delivery preferred to front door.
DELIVERY_BOX	Indicates delivery preferred to a delivery box.
GAS_METER_BOX	Indicates delivery preferred to a gas meter box.
BICYCLE_BASKET	Indicates delivery preferred to a bicycle basket.
GARAGE	Indicates delivery preferred to a garage.
RECEPTIONIST	Indicates delivery preferred with a receptionist.
FALLBACK_NEIGHBOR_DELIVERY	Indicates delivery preferred with a designated neighbor if the recipient is not available at the destination address.
DO_NOT_LEAVE_UNATTENDED	Indicates delivery preferred as attended.

FulfillmentShipmentStatus

The current status of the shipment.

Type : enum

Value	Description
PENDING	The process of picking units from inventory has begun.
SHIPPED	All packages in the shipment have left the fulfillment center.
CANCELLED_BY_FULFILLER	The 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_SELLER	The shipment was cancelled using the `CancelFulfillmentOrder` request.

UnitOfMeasure

The unit of measure for the amount.

Type : enum

Value	Description
Eaches	Specifies an integer count of units.

FeatureFulfillmentPolicy

Specifies the policy to use when fulfilling an order.

Type : enum

Value	Description
Required	If the offer can't be shipped with the selected feature, reject the order.
NotRequired	The feature is not required for shipping.

Unit

The unit of weight.

Type : enum

Value	Description
KG	Kilograms.
KILOGRAMS	Kilograms.
LB	Pounds.
POUNDS	Pounds.

Name

The type of fee.

Type : enum

Value	Description
FBAPerUnitFulfillmentFee	Estimated fee for each unit in the fulfillment order.
FBAPerOrderFulfillmentFee	Estimated order-level fee.
FBATransportationFee	Estimated shipping fee.
FBAFulfillmentCODFee	Estimated 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

Value	Description
Package	Based on the actual weight of the items.
Dimensional	Based on the cubic space that the items occupy.

Updated about 2 months ago