Fulfillment Inbound API

Learn how to use the Fulfillment Inbound API.

You use the Fulfillment Inbound API to create and update inbound inventory to Amazon's fulfillment network, where Amazon can fulfill your customer's orders. You can also request lists of inbound shipments or inbound shipment items based on criteria you specify. After your inventory has been received in the fulfillment network, Amazon can fulfill your orders regardless of whether you are selling on Amazon's retail website or through other retail channels.

For details about API operations and associated data types and schemas, refer to the Fulfillment Inbound API reference.

Current versionLegacy versionsAvailable to sellersAvailable to vendors
v2024-03-20 (Reference | Model)v0YesNo
Release notes

To learn more about the terms that are used on this page, refer to Terminology.

Use cases

The Fulfillment Inbound API has the following key features:

  • Create an inbound shipment: The Fulfillment Inbound API accepts POST operations to create new inbound plans and select shipping modes and transportation options to determine the shipments.
  • Retrieve details about inbound shipments: The Fulfillment Inbound API accepts GET operations to return detailed information about an existing shipment.
  • Update inbound plans: The Fulfillment Inbound API accepts POST operations to update one or more individual attributes for an existing inbound plan, such as updating the inbound plan name or tracking ID.
  • Delete inbound plans: The Fulfillment Inbound API accepts a PUT operation to delete an existing inbound plan.
  • Interoperability: Plans created with the Fulfillment Inbound API can be accessed and edited on Amazon's UI, Send to Amazon (STA), once placement and transportation options are confirmed. You can also use the API to access plans that were created in STA after you confirm placement and transportation options.

Tip

Use generatePlacementOptions to generate new placement options and generateTransportationOptions to generate new transportation options. If you switch from the API to STA before you confirm your options (with confirmPlacementOption and confirmTransportationOptions), new options are generated in STA and all previous options are discarded.

The following use case examples are available for the Fulfillment Inbound API:

Roles

cancelInboundPlan
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
cancelSelfShipAppointment
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
confirmDeliveryWindowOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
confirmPackingOption
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
confirmPlacementOption
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
confirmShipmentContentUpdatePreview
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
confirmTransportationOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
createInboundPlan
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
createMarketplaceItemLabels
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
generateDeliveryWindowOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
generatePackingOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
generatePlacementOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
generateSelfShipAppointmentSlots
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
generateShipmentContentUpdatePreviews
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
generateTransportationOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
getDeliveryChallanDocument
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
getInboundOperationStatus
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
getInboundPlan
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
getSelfShipAppointmentSlots
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
getShipment
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
getShipmentContentUpdatePreview
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listDeliveryWindowOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listInboundPlanBoxes
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listInboundPlanItems
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listInboundPlanPallets
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listInboundPlans
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listItemComplianceDetails
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listPackingGroupBoxes
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listPackingGroupItems
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listPackingOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listPlacementOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listPrepDetails
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listShipmentBoxes
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listShipmentContentUpdatePreviews
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listShipmentItems
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listShipmentPallets
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
listTransportationOptions
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
scheduleSelfShipAppointment
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
setPackingInformation
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
setPrepDetails
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
updateInboundPlanName
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
updateItemComplianceDetails
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
updateShipmentName
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
updateShipmentSourceAddress
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment
updateShipmentTrackingDetails
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Amazon Fulfillment

Considerations

Creating shipments for the following destination marketplaces is not supported:

  • Brazil
  • Turkey

The following v0 operations are not deprecated:

Of these, getLabels and getBillOfLading are necessary to create shipments, as you use them to print a box label, pallet label, or bill of lading.

Fulfillment Inbound shipping workflow

There are two main processes that a seller can follow to create a shipment:

In most cases, we expect that sellers would know the carton-level information, but there are situations where this information isn't readily available.

The following diagram shows the steps to ship inventory to Amazon's fulfillment network. This is an illustrative example and does not include all of the optional operations.

The Fulfillment Inbound shipping workflow.

Ship inventory in the India marketplace

For details on how to ship inventory in the India marketplace, refer to Ship Inventory to Amazon Fulfillment Centers in India.

More specific ways to create shipments

  1. Small Parcel Delivery (SPD) with an Amazon-partnered carrier (PCP): Sellers can create inbound shipments using Amazon's partnered carriers for small parcel deliveries (that is, individual boxes).
  2. Small Parcel Delivery (SPD) with a non-partnered carrier (nPCP): Sellers can use non-partnered carriers (that is, their own transportation carriers) for small parcel deliveries. Sellers can choose their preferred shipping carriers and still have access to the benefits of FBA.
  3. Pallets (LTL/FTL) with an Amazon-partnered carrier (PCP): For larger shipments, sellers can create pallet deliveries using Amazon's partnered carriers. This method is ideal for bulk shipments that require less-than-truckload (LTL) or full-truckload (FTL) services.
  4. Pallets (LTL/FTL) with non-partnered carriers (nPCP): Sellers have greater control over the logistics of larger shipments by using their own non-partnered carriers.
  5. Pallet deliveries with the Pack Later option: Sellers can create pallet deliveries even when carton or box packing information isn’t provided upfront. This “Pack Later” flexibility enables sellers to finalize packing details later.
  6. Retrieve inbound plan details: Sellers can retrieve detailed information about their inbound plans through GET operations, which allows them to track and manage their shipments.

Additional functionality

The Fulfillment Inbound API v2024-03-20 also includes several operations that are not mandatory for every shipment creation. Additional Functionality describes these operations, which offer the following functionality:

The Amazon-Recommended Packing Option

Pack groups are groups of SKUs that can be packed together. SKUs that cannot be packed together are separated into different pack groups. Each pack group should be packed and labeled separately. When you create a new inbound shipment, there are multiple pack groups to choose from in the listPackingOptions response. Sellers can get customized pack groups tailored to their specific inbound shipment and receive a fulfillment discount by following Amazon's packing recommendations. The recommended packing is only available when you pack in small parcel deliveries with each parcel weighing less than 15 KG (LTL/FTL not supported).

If you select Amazon's recommended packing method, you do not need to split the shipment more than usual. You can ship your inventory in as many small parcels as needed, as long as the parcels contain the correct SKUs and the Amazon-recommended quantities for each pack group. If the seller selects a partnered carrier, meaning that destinationType is AMAZON_OPTIMIZED, then the destination fulfillment center address may differ from the actual address, or this field may be empty. Refer to the carton label for the correct address.

Amazon-recommended packing options are available in the following marketplaces:

  • Spain
  • UK
  • France
  • Germany
  • Italy

For more information about the Amazon Recommended Packing options, refer to Help for Amazon Sellers. To learn about how to access these options via API, refer to Determine which SKUs can be packed together.

Sample code application

The Fulfillment Inbound Sample Solution Code App includes detailed code samples and all the necessary resources to deploy a fully functional SP-API application that uses the Fulfillment Inbound API v2024-03-20. You can adjust the code to fit your specific requirements.