Fulfillment Inbound API v2024-03-20 Reference
Create and update inbound inventory to Amazon's fulfillment network.
Overview
The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon's fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
Version information
Version : 2024-03-20
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
listInboundPlans
createInboundPlan
getInboundPlan
listInboundPlanBoxes
cancelInboundPlan
listInboundPlanItems
updateInboundPlanName
listPackingGroupBoxes
listPackingGroupItems
setPackingInformation
listPackingOptions
generatePackingOptions
confirmPackingOption
listInboundPlanPallets
listPlacementOptions
generatePlacementOptions
confirmPlacementOption
getShipment
listShipmentBoxes
listShipmentContentUpdatePreviews
generateShipmentContentUpdatePreviews
getShipmentContentUpdatePreview
confirmShipmentContentUpdatePreview
getDeliveryChallanDocument
listDeliveryWindowOptions
generateDeliveryWindowOptions
confirmDeliveryWindowOptions
listShipmentItems
updateShipmentName
listShipmentPallets
cancelSelfShipAppointment
getSelfShipAppointmentSlots
generateSelfShipAppointmentSlots
scheduleSelfShipAppointment
updateShipmentSourceAddress
updateShipmentTrackingDetails
listTransportationOptions
generateTransportationOptions
confirmTransportationOptions
listItemComplianceDetails
updateItemComplianceDetails
createMarketplaceItemLabels
listPrepDetails
setPrepDetails
getInboundOperationStatus
Paths
GET /inbound/fba/2024-03-20/inboundPlans
Operation: listInboundPlans
Description
Provides a list of inbound plans with minimal information.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 2 | 6 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains 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 | Default |
|---|---|---|---|---|
| Query | pageSize optional | The number of inbound plans to return in the response matching the given query. Minimum : 1 Maximum : 30 | integer | 10 |
| Query | paginationToken optional | A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.minLength : 0 maxLength : 1024 | string | - |
| Query | status optional | The status of an inbound plan. | enum (Status) | - |
| Query | sortBy optional | Sort by field. | enum (SortBy) | - |
| Query | sortOrder optional | The sort order. | enum (SortOrder) | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | ListInboundPlans 200 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | ListInboundPlansResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
POST /inbound/fba/2024-03-20/inboundPlans
Operation: createInboundPlan
Description
Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon's fufillment network.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 2 | 2 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains 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 | The body of the request to createInboundPlan. | CreateInboundPlanRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | CreateInboundPlan 202 response Headers : x-amzn-RequestId (string) : Unique request reference identifier. x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. | CreateInboundPlanResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Consumes
application/json
Produces
application/json
Example HTTP request
Request body
{
"destinationMarketplaces" : [ "ATVPDKIKX0DER" ],
"items" : [ {
"expiration" : "2024-01-01",
"labelOwner" : "AMAZON",
"manufacturingLotCode" : "manufacturingLotCode",
"msku" : "Sunglasses",
"prepOwner" : "AMAZON",
"quantity" : 10
} ],
"name" : "My inbound plan",
"sourceAddress" : {
"addressLine1" : "123 example street",
"addressLine2" : "Floor 19",
"city" : "Toronto",
"companyName" : "Acme",
"countryCode" : "CA",
"email" : "[email protected]",
"name" : "name",
"phoneNumber" : "1234567890",
"postalCode" : "M1M1M1",
"stateOrProvinceCode" : "ON"
}
}