FBA Inventory API v1 Reference
Retrieve information about inventory in Amazon's fulfillment network.
The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon's fulfillment network.
Version information
Version : v1
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
getInventorySummaries
createInventoryItem
deleteInventoryItem
addInventory
Paths
GET /fba/inventory/v1/summaries
Operation: getInventorySummaries
Description
Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters:
- All inventory summaries with available details are returned when the startDateTime, sellerSkus and sellerSku parameters are omitted.
- When startDateTime is provided, the operation returns inventory summaries that have had changes after the date and time specified. The sellerSkus and sellerSku parameters are ignored. Important: To avoid errors, use both startDateTime and nextToken to get the next page of inventory summaries that have changed after the date and time specified.
- When the sellerSkus parameter is provided, the operation returns inventory summaries for only the specified sellerSkus. The sellerSku parameter is ignored.
- When the sellerSku parameter is provided, the operation returns inventory summaries for only the specified sellerSku.
Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.
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 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 | details optional | true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value). | boolean | "false" |
| Query | granularityType required | The granularity type for the inventory aggregation level. | enum (GranularityType) | - |
| Query | granularityId required | The granularity ID for the inventory aggregation level. | string | - |
| Query | startDateTime optional | A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected. | string (date-time) | - |
| Query | sellerSkus optional | A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs. Max count : 50 | < string > array | - |
| Query | sellerSku optional | A single seller SKU used for querying the specified seller SKU inventory summaries. | string | - |
| Query | nextToken optional | String token returned in the response of your previous request. The string token will expire 30 seconds after being created. | string | - |
| Query | marketplaceIds required | The marketplace ID for the marketplace for which to return inventory summaries. Max count : 1 | < string > array | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetInventorySummariesResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetInventorySummariesResponse |
| 403 | Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetInventorySummariesResponse |
| 404 | The specified resource does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetInventorySummariesResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetInventorySummariesResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetInventorySummariesResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | GetInventorySummariesResponse |
Produces
application/json
POST /fba/inventory/v1/items
Operation: createInventoryItem
Description
Requests that Amazon create product-details in the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to Selling Partner API sandbox for more information.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | createInventoryItemRequestBody required | CreateInventoryItem Request Body Parameter. | CreateInventoryItemRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateInventoryItemResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateInventoryItemResponse |
| 403 | Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateInventoryItemResponse |
| 404 | The specified resource does not exist. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateInventoryItemResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateInventoryItemResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateInventoryItemResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | CreateInventoryItemResponse |
Produces
application/json
DELETE /fba/inventory/v1/items/{sellerSku}
Operation: deleteInventoryItem
Description
Requests that Amazon Deletes an item from the Sandbox Inventory in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to Selling Partner API sandbox for more information.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | sellerSku required | A single seller SKU used for querying the specified seller SKU inventory summaries. | string |
| Query | marketplaceId required | The marketplace ID for the marketplace for which the sellerSku is to be deleted. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteInventoryItemResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteInventoryItemResponse |
| 403 | Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteInventoryItemResponse |
| 404 | The specified resource does not exist. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteInventoryItemResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteInventoryItemResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteInventoryItemResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | DeleteInventoryItemResponse |
Produces
application/json
POST /fba/inventory/v1/items/inventory
Operation: addInventory
Description
Requests that Amazon add items to the Sandbox Inventory with desired amount of quantity in the sandbox environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to Selling Partner API sandbox for more information.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Header | x-amzn-idempotency-token required | A unique token/requestId provided with each call to ensure idempotency. | string |
| Body | addInventoryRequestBody required | List of items to add to Sandbox inventory. | AddInventoryRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK Headers : x-amzn-RequestId (string) : Unique request reference identifier. | AddInventoryResponse |
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | AddInventoryResponse |
| 403 | Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | AddInventoryResponse |
| 404 | The specified resource does not exist. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | AddInventoryResponse |
| 429 | The frequency of requests was greater than allowed. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | AddInventoryResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | AddInventoryResponse |
| 503 | Temporary overloading or maintenance of the server. Headers : x-amzn-RequestId (string) : Unique request reference identifier. | AddInventoryResponse |
Produces
application/json
Definitions
CreateInventoryItemRequest
An item to be created in the inventory.
| Name | Description | Schema |
|---|---|---|
| sellerSku required | The seller SKU of the item. | string |
| marketplaceId required | The marketplaceId. | string |
| productName required | The name of the item. | string |
AddInventoryRequest
The object with the list of Inventory to be added
| Name | Description | Schema |
|---|---|---|
| inventoryItems optional | List of Inventory to be added | InventoryItems |
InventoryItems
List of Inventory to be added
Type : < InventoryItem > array
InventoryItem
An item in the list of inventory to be added.
| Name | Description | Schema |
|---|---|---|
| sellerSku required | The seller SKU of the item. | string |
| marketplaceId required | The marketplaceId. | string |
| quantity required | The quantity of item to add. | integer |
CreateInventoryItemResponse
The response schema for the CreateInventoryItem operation.
| Name | Description | Schema |
|---|---|---|
| errors optional | One or more unexpected errors occurred during the CreateInventoryItem operation. | ErrorList |
DeleteInventoryItemResponse
The response schema for the DeleteInventoryItem operation.
| Name | Description | Schema |
|---|---|---|
| errors optional | One or more unexpected errors occurred during the DeleteInventoryItem operation. | ErrorList |
AddInventoryResponse
The response schema for the AddInventory operation.
| Name | Description | Schema |
|---|---|---|
| errors optional | One or more unexpected errors occurred during the AddInventory operation. | ErrorList |
Granularity
Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace.
| Name | Description | Schema |
|---|---|---|
| granularityType optional | The granularity type for the inventory aggregation level. | string |
| granularityId optional | The granularity ID for the specified granularity type. When granularityType is Marketplace, specify the marketplaceId. | string |
ReservedQuantity
The quantity of reserved inventory.
| Name | Description | Schema |
|---|---|---|
| totalReservedQuantity optional | The total number of units in Amazon's fulfillment network that are currently being picked, packed, and shipped; or are sidelined for measurement, sampling, or other internal processes. | integer |
| pendingCustomerOrderQuantity optional | The number of units reserved for customer orders. | integer |
| pendingTransshipmentQuantity optional | The number of units being transferred from one fulfillment center to another. | integer |
| fcProcessingQuantity optional | The number of units that have been sidelined at the fulfillment center for additional processing. | integer |
ResearchingQuantityEntry
The misplaced or warehouse damaged inventory that is actively being confirmed at our fulfillment centers.
| Name | Description | Schema |
|---|---|---|
| name required | The duration of the research. | enum (Name) |
| quantity required | The number of units. | integer |
ResearchingQuantity
The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers.
| Name | Description | Schema |
|---|---|---|
| totalResearchingQuantity optional | The total number of units currently being researched in Amazon's fulfillment network. | integer |
| researchingQuantityBreakdown optional | A list of quantity details for items currently being researched. | < ResearchingQuantityEntry > array |
UnfulfillableQuantity
The quantity of unfulfillable inventory.
| Name | Description | Schema |
|---|---|---|
| totalUnfulfillableQuantity optional | The total number of units in Amazon's fulfillment network in unsellable condition. | integer |
| customerDamagedQuantity optional | The number of units in customer damaged disposition. | integer |
| warehouseDamagedQuantity optional | The number of units in warehouse damaged disposition. | integer |
| distributorDamagedQuantity optional | The number of units in distributor damaged disposition. | integer |
| carrierDamagedQuantity optional | The number of units in carrier damaged disposition. | integer |
| defectiveQuantity optional | The number of units in defective disposition. | integer |
| expiredQuantity optional | The number of units in expired disposition. | integer |
InventoryDetails
Summarized inventory details. This object will not appear if the details parameter in the request is false.
| Name | Description | Schema |
|---|---|---|
| fulfillableQuantity optional | The item quantity that can be picked, packed, and shipped. | integer |
| inboundWorkingQuantity optional | The number of units in an inbound shipment for which you have notified Amazon. | integer |
| inboundShippedQuantity optional | The number of units in an inbound shipment that you have notified Amazon about and have provided a tracking number. | integer |
| inboundReceivingQuantity optional | The number of units that have not yet been received at an Amazon fulfillment center for processing, but are part of an inbound shipment with some units that have already been received and processed. | integer |
| reservedQuantity optional | The quantity of reserved inventory. | ReservedQuantity |
| researchingQuantity optional | The number of misplaced or warehouse damaged units that are actively being confirmed at our fulfillment centers. | ResearchingQuantity |
| unfulfillableQuantity optional | The quantity of unfulfillable inventory. | UnfulfillableQuantity |
InventorySummary
Inventory summary for a specific item.
| Name | Description | Schema |
|---|---|---|
| asin optional | The Amazon Standard Identification Number (ASIN) of an item. | string |
| fnSku optional | Amazon's fulfillment network SKU identifier. | string |
| sellerSku optional | The seller SKU of the item. | string |
| condition optional | The condition of the item as described by the seller (for example, New Item). | string |
| inventoryDetails optional | Summarized inventory details. This object will not appear if the details parameter in the request is false. | InventoryDetails |
| lastUpdatedTime optional | The date and time that any quantity was last updated. | string (date-time) |
| productName optional | The localized language product title of the item within the specific marketplace. | string |
| totalQuantity optional | The total number of units in an inbound shipment or in Amazon fulfillment centers. | integer |
| stores optional | A list of seller-enrolled stores that apply to this seller SKU. | < string > array |
InventorySummaries
A list of inventory summaries.
Type : < InventorySummary > array
Pagination
The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.
| Name | Description | Schema |
|---|---|---|
| nextToken optional | A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return. | string |
GetInventorySummariesResult
The payload schema for the getInventorySummaries operation.
| Name | Description | Schema |
|---|---|---|
| granularity required | Describes a granularity at which inventory data can be aggregated. For example, if you use Marketplace granularity, the fulfillable quantity will reflect inventory that could be fulfilled in the given marketplace. | Granularity |
| inventorySummaries required | A list of inventory summaries. | InventorySummaries |
GetInventorySummariesResponse
The Response schema.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getInventorySummaries operation. | GetInventorySummariesResult |
| pagination optional | The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management. | Pagination |
| errors optional | One or more unexpected errors occurred during the getInventorySummaries operation. | ErrorList |
Error
An error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message optional | A message that describes the error condition in a human-readable form. | string |
| details optional | Additional information that can help the caller understand or fix the issue. | string |
ErrorList
A list of error responses returned when a request is unsuccessful.
Type : < Error > array
GranularityType
The granularity type for the inventory aggregation level.
Type : enum
| Value | Description |
|---|---|
| Marketplace | Marketplace |
Name
The duration of the research.
Type : enum
| Value | Description |
|---|---|
| researchingQuantityInShortTerm | Short Term for 1-10 days. |
| researchingQuantityInMidTerm | Mid Term for 11-20 days. |
| researchingQuantityInLongTerm | Long Term for 21 days or longer. |
Updated about 1 month ago