API docs by Redocly

Selling Partner APIs for Fulfillment Outbound (2020-07-01)

Download OpenAPI specification:Download

URL: https://sellercentral.amazon.com/gp/mws/contactus.html

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.

fbaOutbound

getFulfillmentPreview

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

Usage Plan:

Rate (requests per second) Burst
2 30

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

Request Body schema: application/json
marketplaceId
string

The marketplace the fulfillment order is placed against.

required
object (Address)

A physical address.

required
Array of objects (GetFulfillmentPreviewItem)

An array of fulfillment preview item information.

shippingSpeedCategories
Array of strings (ShippingSpeedCategory)
Items Enum: "Standard" "Expedited" "Priority" "ScheduledDelivery"
includeCODFulfillmentPreview
boolean

Specifies whether to return fulfillment order previews that are for COD (Cash On Delivery).

Possible values:

  • true - Returns all fulfillment order previews (both for COD and not for COD).
  • false - Returns only fulfillment order previews that are not for COD.
includeDeliveryWindows
boolean

Specifies whether to return the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery.

Array of objects (FeatureSettings)

A list of features and their fulfillment policies to apply to the order.

Responses

Request samples

Content type
application/json
{
  • "marketplaceId": "string",
  • "address": {
    },
  • "items": [
    ],
  • "shippingSpeedCategories": [
    ],
  • "includeCODFulfillmentPreview": true,
  • "includeDeliveryWindows": true,
  • "featureConstraints": [
    ]
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

listAllFulfillmentOrders

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

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

query Parameters
queryStartDate
string <date-time>

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.

nextToken
string

A string token returned in the response to your previous request.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

createFulfillmentOrder

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

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

Request Body schema: application/json
marketplaceId
string

The marketplace the fulfillment order is placed against.

sellerFulfillmentOrderId
required
string <= 40 characters

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.

displayableOrderId
required
string <= 40 characters

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.

displayableOrderDate
required
string <date-time>
displayableOrderComment
required
string <= 1000 characters

Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.

shippingSpeedCategory
required
string (ShippingSpeedCategory)
Enum: "Standard" "Expedited" "Priority" "ScheduledDelivery"

The shipping method used for the fulfillment order.

object (DeliveryWindow)

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

required
object (Address)

A physical address.

fulfillmentAction
string (FulfillmentAction)
Enum: "Ship" "Hold"

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

fulfillmentPolicy
string (FulfillmentPolicy)
Enum: "FillOrKill" "FillAll" "FillAllAvailable"

The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.

object (CODSettings)

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

shipFromCountryCode
string

The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.

notificationEmails
Array of strings <= 64 characters [ items <= 64 characters ]

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.

Array of objects (FeatureSettings)

A list of features and their fulfillment policies to apply to the order.

required
Array of objects (CreateFulfillmentOrderItem)

An array of item information for creating a fulfillment order.

Responses

Request samples

Content type
application/json
{
  • "marketplaceId": "string",
  • "sellerFulfillmentOrderId": "string",
  • "displayableOrderId": "string",
  • "displayableOrderDate": "2019-08-24T14:15:22Z",
  • "displayableOrderComment": "string",
  • "shippingSpeedCategory": "Standard",
  • "deliveryWindow": {
    },
  • "destinationAddress": {
    },
  • "fulfillmentAction": "Ship",
  • "fulfillmentPolicy": "FillOrKill",
  • "codSettings": {
    },
  • "shipFromCountryCode": "string",
  • "notificationEmails": [
    ],
  • "featureConstraints": [
    ],
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getPackageTrackingDetails

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

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

query Parameters
packageNumber
required
integer <int32>

The unencrypted package identifier returned by the getFulfillmentOrder operation.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

listReturnReasonCodes

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

Usage Plan:

Rate (requests per second) Burst
2 30

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

query Parameters
sellerSku
required
string

The seller SKU for which return reason codes are required.

marketplaceId
string

The marketplace for which the seller wants return reason codes.

sellerFulfillmentOrderId
string

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.

language
required
string

The language that the TranslatedDescription property of the ReasonCodeDetails response object should be translated into.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

createFulfillmentReturn

Creates a fulfillment return.

Usage Plan:

Rate (requests per second) Burst
2 30

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

path Parameters
sellerFulfillmentOrderId
required
string

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.

Request Body schema: application/json
required
Array of objects (CreateReturnItem)

An array of items to be returned.

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getFulfillmentOrder

Returns the fulfillment order indicated by the specified order identifier.

Usage Plan:

Rate (requests per second) Burst
2 30

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

path Parameters
sellerFulfillmentOrderId
required
string <= 40 characters

The identifier assigned to the item by the seller when the fulfillment order was created.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

updateFulfillmentOrder

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

Usage Plan:

Rate (requests per second) Burst
2 30

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

path Parameters
sellerFulfillmentOrderId
required
string <= 40 characters

The identifier assigned to the item by the seller when the fulfillment order was created.

Request Body schema: application/json
marketplaceId
string

The marketplace the fulfillment order is placed against.

displayableOrderId
string <= 40 characters

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.

displayableOrderDate
string <date-time>
displayableOrderComment
string <= 1000 characters

Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.

shippingSpeedCategory
string (ShippingSpeedCategory)
Enum: "Standard" "Expedited" "Priority" "ScheduledDelivery"

The shipping method used for the fulfillment order.

object (Address)

A physical address.

fulfillmentAction
string (FulfillmentAction)
Enum: "Ship" "Hold"

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

fulfillmentPolicy
string (FulfillmentPolicy)
Enum: "FillOrKill" "FillAll" "FillAllAvailable"

The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.

shipFromCountryCode
string

The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.

notificationEmails
Array of strings <= 64 characters [ items <= 64 characters ]

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.

Array of objects (FeatureSettings)

A list of features and their fulfillment policies to apply to the order.

Array of objects (UpdateFulfillmentOrderItem)

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

Responses

Request samples

Content type
application/json
{
  • "marketplaceId": "string",
  • "displayableOrderId": "string",
  • "displayableOrderDate": "2019-08-24T14:15:22Z",
  • "displayableOrderComment": "string",
  • "shippingSpeedCategory": "Standard",
  • "destinationAddress": {
    },
  • "fulfillmentAction": "Ship",
  • "fulfillmentPolicy": "FillOrKill",
  • "shipFromCountryCode": "string",
  • "notificationEmails": [
    ],
  • "featureConstraints": [
    ],
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

cancelFulfillmentOrder

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

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

path Parameters
sellerFulfillmentOrderId
required
string <= 40 characters

The identifier assigned to the item by the seller when the fulfillment order was created.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getFeatures

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

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

query Parameters
marketplaceId
required
string

The marketplace for which to return the list of features.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getFeatureInventory

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

Usage Plan:

Rate (requests per second) Burst
2 30

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

path Parameters
featureName
required
string

The name of the feature for which to return a list of eligible inventory.

query Parameters
marketplaceId
required
string

The marketplace for which to return a list of the inventory that is eligible for the specified feature.

nextToken
string

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.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getFeatureSKU

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

Usage Plan:

Rate (requests per second) Burst
2 30

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

path Parameters
featureName
required
string

The name of the feature.

sellerSku
required
string

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.

query Parameters
marketplaceId
required
string

The marketplace for which to return the count.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}