API docs by Redocly

Selling Partner API for Fulfillment Inbound (v0)

Download OpenAPI specification:Download

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

The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon's fulfillment network.

fbaInbound

getInboundGuidance

Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon's fulfillment network. Sellers may still ship items that are not recommended, at their discretion.

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

A marketplace identifier. Specifies the marketplace where the product would be stored.

SellerSKUList
Array of strings <= 50 items

A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.

ASINList
Array of strings <= 50 items

A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon's fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.

Responses

Response samples

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

createInboundShipmentPlan

Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon's fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory.

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
required
object (Address)
LabelPrepPreference
required
string (LabelPrepPreference)
Enum: "SELLER_LABEL" "AMAZON_LABEL_ONLY" "AMAZON_LABEL_PREFERRED"

The preference for label preparation for an inbound shipment.

ShipToCountryCode
string

The two-character country code for the country where the inbound shipment is to be sent.

Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error.

Values:

ShipToCountryCode values for North America:

  • CA – Canada
  • MX - Mexico
  • US - United States

ShipToCountryCode values for MCI sellers in Europe:

  • DE – Germany
  • ES – Spain
  • FR – France
  • GB – United Kingdom
  • IT – Italy

Default: The country code for the seller's home marketplace.

ShipToCountrySubdivisionCode
string

The two-character country code, followed by a dash and then up to three characters that represent the subdivision of the country where the inbound shipment is to be sent. For example, "IN-MH". In full ISO 3166-2 format.

Note: Not required. Specifying both ShipToCountryCode and ShipToCountrySubdivisionCode returns an error.

required
Array of objects (InboundShipmentPlanRequestItem)

Responses

Request samples

Content type
application/json
{
  • "ShipFromAddress": {
    },
  • "LabelPrepPreference": "SELLER_LABEL",
  • "ShipToCountryCode": "string",
  • "ShipToCountrySubdivisionCode": "string",
  • "InboundShipmentPlanRequestItems": [
    ]
}

Response samples

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

createInboundShipment

Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Request Body schema: application/json
required
object (InboundShipmentHeader)

Inbound shipment information used to create and update inbound shipments.

required
Array of objects (InboundShipmentItem)

A list of inbound shipment item information.

MarketplaceId
required
string

A marketplace identifier. Specifies the marketplace where the product would be stored.

Responses

Request samples

Content type
application/json
{
  • "InboundShipmentHeader": {
    },
  • "InboundShipmentItems": [
    ],
  • "MarketplaceId": "string"
}

Response samples

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

updateInboundShipment

Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Request Body schema: application/json
required
object (InboundShipmentHeader)

Inbound shipment information used to create and update inbound shipments.

required
Array of objects (InboundShipmentItem)

A list of inbound shipment item information.

MarketplaceId
required
string

A marketplace identifier. Specifies the marketplace where the product would be stored.

Responses

Request samples

Content type
application/json
{
  • "InboundShipmentHeader": {
    },
  • "InboundShipmentItems": [
    ],
  • "MarketplaceId": "string"
}

Response samples

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

getPreorderInfo

Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-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.

path Parameters
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

query Parameters
MarketplaceId
required
string

A marketplace identifier. Specifies the marketplace the shipment is tied to.

Responses

Response samples

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

confirmPreorder

Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the shipment.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

query Parameters
NeedByDate
required
string <date>

Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.

MarketplaceId
required
string

A marketplace identifier. Specifies the marketplace the shipment is tied to.

Responses

Response samples

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

getPrepInstructions

Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network.

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
ShipToCountryCode
required
string

The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.

SellerSKUList
Array of strings <= 50 items

A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon's fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API.

Note: Include seller SKUs that you have used to list items on Amazon's retail website. If you include a seller SKU that you have never used to list an item on Amazon's retail website, the seller SKU is returned in the InvalidSKUList property in the response.

ASINList
Array of strings <= 50 items

A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions.

Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.

Responses

Response samples

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

getTransportDetails

Returns current transportation information about an inbound shipment.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Responses

Response samples

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

putTransportDetails

Sends transportation information to Amazon about an inbound shipment.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Request Body schema: application/json
IsPartnered
required
boolean

Indicates whether a putTransportDetails request is for an Amazon-partnered carrier.

ShipmentType
required
string (ShipmentType)
Enum: "SP" "LTL"

Specifies the carrier shipment type in a putTransportDetails request.

required
object (TransportDetailInput)

Information required to create an Amazon-partnered carrier shipping estimate, or to alert the Amazon fulfillment center to the arrival of an inbound shipment by a non-Amazon-partnered carrier.

Responses

Request samples

Content type
application/json
{
  • "IsPartnered": true,
  • "ShipmentType": "SP",
  • "TransportDetails": {
    }
}

Response samples

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

voidTransport

Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier.

To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation.

Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping cost.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Responses

Response samples

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

estimateTransport

Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier.

Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Responses

Response samples

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

confirmTransport

Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment.

Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate.

Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller's account will be charged for the shipping cost.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Responses

Response samples

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

getLabels

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

query Parameters
PageType
required
string
Enum: "PackageLabel_Letter_2" "PackageLabel_Letter_4" "PackageLabel_Letter_6" "PackageLabel_Letter_6_CarrierLeft" "PackageLabel_A4_2" "PackageLabel_A4_4" "PackageLabel_Plain_Paper" "PackageLabel_Plain_Paper_CarrierBottom" "PackageLabel_Thermal" "PackageLabel_Thermal_Unified" "PackageLabel_Thermal_NonPCP" "PackageLabel_Thermal_No_Carrier_Rotation"

The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

LabelType
required
string
Enum: "BARCODE_2D" "UNIQUE" "PALLET"

The type of labels requested.

NumberOfPackages
integer <int32>

The number of packages in the shipment.

PackageLabelsToPrint
Array of strings <= 999 items

A list of identifiers that specify packages for which you want package labels printed.

Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.

NumberOfPallets
integer <int32>

The number of pallets in the shipment. This returns four identical labels for each pallet.

PageSize
integer <int32>

The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.

PageStartIndex
integer <int32>

The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments.

Responses

Response samples

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

getBillOfLading

Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment.

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
shipmentId
required
string

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Responses

Response samples

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

getShipments

Returns a list of inbound shipments based on 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.

query Parameters
ShipmentStatusList
Array of strings
Items Enum: "WORKING" "SHIPPED" "RECEIVING" "CANCELLED" "DELETED" "CLOSED" "ERROR" "IN_TRANSIT" "DELIVERED" "CHECKED_IN"

A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.

ShipmentIdList
Array of strings

A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.

LastUpdatedAfter
string <date-time>

A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

LastUpdatedBefore
string <date-time>

A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

QueryType
required
string
Enum: "SHIPMENT" "DATE_RANGE" "NEXT_TOKEN"

Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.

NextToken
string

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

MarketplaceId
required
string

A marketplace identifier. Specifies the marketplace where the product would be stored.

Responses

Response samples

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

getShipmentItemsByShipmentId

Returns a list of items in a specified inbound shipment.

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
shipmentId
required
string

A shipment identifier used for selecting items in a specific inbound shipment.

query Parameters
MarketplaceId
required
string

A marketplace identifier. Specifies the marketplace where the product would be stored.

Responses

Response samples

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

getShipmentItems

Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame.

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
LastUpdatedAfter
string <date-time>

A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.

LastUpdatedBefore
string <date-time>

A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.

QueryType
required
string
Enum: "DATE_RANGE" "NEXT_TOKEN"

Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.

NextToken
string

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

MarketplaceId
required
string

A marketplace identifier. Specifies the marketplace where the product would be stored.

Responses

Response samples

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