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
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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see 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

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

{
  "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"
    }
  }
}

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}

Operation: getInboundPlan

Description

Fetches the top level information about an inbound plan.

Usage Plan:

Rate (requests per second)	Burst
2	6

Parameters

Type	Name	Description	Schema
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string

Responses

HTTP Code	Description	Schema
200	GetInboundPlan 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.	InboundPlan

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

Example HTTP response

Response 200

{
  "createdAt" : "2024-03-20T12:01:00Z",
  "inboundPlanId" : "wf1234abcd-1234-abcd-5678-1234abcd5678",
  "lastUpdatedAt" : "2024-03-28T13:15:30Z",
  "marketplaceIds" : [ "A2EUQ1WTGCTBG2" ],
  "name" : "FBA (03/20/2024, 12:01 PM)",
  "packingOptions" : [ ],
  "placementOptions" : [ ],
  "shipments" : [ ],
  "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"
  },
  "status" : "ACTIVE"
}

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/boxes

Operation: listInboundPlanBoxes

Description

Provides a paginated list of box packages in an inbound plan.

Usage Plan:

Rate (requests per second)	Burst
2	6

Parameters

Type	Name	Description	Schema	Default
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string	-
Query	pageSize optional	The number of boxes to return in the response matching the given query. Minimum : 1 Maximum : 1000	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	-

Responses

HTTP Code	Description	Schema
200	ListInboundPlanBoxes 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.	ListInboundPlanBoxesResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/cancellation

Operation: cancelInboundPlan

Description

Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments.

Usage Plan:

Rate (requests per second)	Burst
2	2

Parameters

Type	Name	Description	Schema
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string

Responses

HTTP Code	Description	Schema
202	CancelInboundPlan 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.	CancelInboundPlanResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/items

Operation: listInboundPlanItems

Description

Provides a paginated list of item packages in an inbound plan.

Usage Plan:

Rate (requests per second)	Burst
2	6

Parameters

Type	Name	Description	Schema	Default
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string	-
Query	pageSize optional	The number of items to return in the response matching the given query. Minimum : 1 Maximum : 1000	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	-

Responses

HTTP Code	Description	Schema
200	ListInboundPlanItems 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.	ListInboundPlanItemsResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

PUT /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/name

Operation: updateInboundPlanName

Description

Updates the name of an existing inbound plan.

Usage Plan:

Rate (requests per second)	Burst
2	30

Parameters

Type	Name	Description	Schema
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string
Body	body required	The body of the request to `updateInboundPlanName`.	UpdateInboundPlanNameRequest

Responses

HTTP Code	Description	Schema
204	UpdateInboundPlanName 204 response Headers : `x-amzn-RequestId` (string) : Unique request reference identifier. `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation.	No Content

For error status codes, descriptions and schemas, see Error responses and schemas.

Consumes

application/json

Produces

application/json

Example HTTP request

Request body

{
  "body" : {
    "name" : "name"
  }
}

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes

Operation: listPackingGroupBoxes

Description

Retrieves a page of boxes from a given packing group. These boxes were previously provided through the setPackingInformation operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.

Usage Plan:

Rate (requests per second)	Burst
2	30

Parameters

Type	Name	Description	Schema	Default
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string	-
Path	packingGroupId required	Identifier of a packing group. minLength : 38 maxLength : 38	string	-
Query	pageSize optional	The number of packing group boxes to return in the response matching the given query. Minimum : 1 Maximum : 100	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	-

Responses

HTTP Code	Description	Schema
200	ListPackingGroupBoxes 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.	ListPackingGroupBoxesResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items

Operation: listPackingGroupItems

Description

Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.

Usage Plan:

Rate (requests per second)	Burst
2	30

Parameters

Type	Name	Description	Schema	Default
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string	-
Path	packingGroupId required	Identifier of a packing group. minLength : 38 maxLength : 38	string	-
Query	pageSize optional	The number of packing group items to return in the response matching the given query. Minimum : 1 Maximum : 100	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	-

Responses

HTTP Code	Description	Schema
200	ListPackingGroupItems 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.	ListPackingGroupItemsResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingInformation

Operation: setPackingInformation

Description

Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates.

Usage Plan:

Rate (requests per second)	Burst
2	2

Parameters

Type	Name	Description	Schema
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string
Body	body required	The body of the request to `setPackingInformation`.	SetPackingInformationRequest

Responses

HTTP Code	Description	Schema
202	SetPackingInformation 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.	SetPackingInformationResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Consumes

application/json

Produces

application/json

Example HTTP request

Request body

{
  "body" : {
    "packageGroupings" : [ {
      "boxes" : [ {
        "contentInformationSource" : "BOX_CONTENT_PROVIDED",
        "dimensions" : {
          "height" : 5,
          "length" : 3,
          "unitOfMeasurement" : "CM",
          "width" : 4
        },
        "items" : [ {
          "expiration" : "2024-01-01",
          "labelOwner" : "AMAZON",
          "manufacturingLotCode" : "manufacturingLotCode",
          "msku" : "Sunglasses",
          "prepOwner" : "AMAZON",
          "quantity" : 10
        } ],
        "quantity" : 2,
        "weight" : {
          "unit" : "KG",
          "value" : 5.5
        }
      } ],
      "packingGroupId" : "pg1234abcd-1234-abcd-5678-1234abcd5678",
      "shipmentId" : "sh1234abcd-1234-abcd-5678-1234abcd5678"
    } ]
  }
}

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions

Operation: listPackingOptions

Description

Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.

Usage Plan:

Rate (requests per second)	Burst
2	6

Parameters

Type	Name	Description	Schema	Default
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string	-
Query	pageSize optional	The number of packing options to return in the response matching the given query. Minimum : 1 Maximum : 20	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	-

Responses

HTTP Code	Description	Schema
200	ListPackingOptions 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.	ListPackingOptionsResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions

Operation: generatePackingOptions

Description

Generates available packing options for the inbound plan.

Usage Plan:

Rate (requests per second)	Burst
2	2

Parameters

Type	Name	Description	Schema
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string

Responses

HTTP Code	Description	Schema
202	GeneratePackingOptions 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.	GeneratePackingOptionsResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

POST /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/confirmation

Operation: confirmPackingOption

Description

Confirms the packing option for an inbound plan.

Usage Plan:

Rate (requests per second)	Burst
2	2

Parameters

Type	Name	Description	Schema
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string
Path	packingOptionId required	Identifier of a packing option. minLength : 38 maxLength : 38	string

Responses

HTTP Code	Description	Schema
202	ConfirmPackingOption 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.	ConfirmPackingOptionResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Produces

application/json

GET /inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/pallets

Operation: listInboundPlanPallets

Description

Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.

Usage Plan:

Rate (requests per second)	Burst
2	6

Parameters

Type	Name	Description	Schema	Default
Path	inboundPlanId required	Identifier of an inbound plan. minLength : 38 maxLength : 38	string	-
Query	pageSize optional	The number of pallets to return in the response matching the given query. Minimum : 1 Maximum : 1000	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	-

Responses

HTTP Code	Description	Schema
200	ListInboundPlanPallets 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.