Amazon Selling Partner (SP-API) Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » Amazon Selling Partner (SP-API) Connector » EndPoints > Get FBA Inventory Summaries (Fulfilled By Amazon)

EndPoint Get FBA Inventory Summaries (Fulfilled By Amazon)

Name

get_inventory_summaries

Description

Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the startDateTime, sellerSkus and sellerSku parameters. [API Help]

Parameters

Parameter Label Required Options Description
MarketplaceIds MarketplaceIds YES
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Details Include details YES
Option Value
true true
false false
true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value false).
GranularityType Granularity Type YES
Option Value
Marketplace Marketplace
The granularity type for the inventory aggregation level.
GranularityId Granularity Id YES
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
The granularity ID for the inventory aggregation level (e.g. MarketPlaceId if granularityType is MarketPlace ID).
StartDateTime Start Date NO
Option Value
2023-12-31 2023-12-31
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
now-24h now-24h
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
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. You can use static values or date functions. Supported functions are now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
SellerSku SellerSku (Single) NO A single seller SKU used for querying the specified seller SKU inventory summaries.
SellerSkus SellerSkus (Multiple) NO A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
PageSize PageSize NO

Output Columns

Label DataType Length Raw Description
Asin DT_WSTR 500 False
FnSku DT_WSTR 50 False
ProductName DT_WSTR 500 False
TotalQuantity DT_I4 0 False
SellerSku DT_WSTR 100 False
Condition DT_WSTR 50 False
LastUpdatedTime DT_DBTIMESTAMP 0 False
InventoryDetailsFulfillableQuantity DT_I4 0 False
InventoryDetailsInboundWorkingQuantity DT_I4 0 False
InventoryDetailsInboundShippedQuantity DT_I4 0 False
InventoryDetailsInboundReceivingQuantity DT_I4 0 False
InventoryDetailsReservedQuantityTotalReservedQuantity DT_I4 0 False
InventoryDetailsReservedQuantityPendingCustomerOrderQuantity DT_I4 0 False
InventoryDetailsReservedQuantityPendingTransshipmentQuantity DT_I4 0 False
InventoryDetailsReservedQuantityFcProcessingQuantity DT_I4 0 False
InventoryDetailsResearchingQuantityTotalResearchingQuantity DT_I4 0 False
InventoryDetailsResearchingQuantityResearchingQuantityBreakdown DT_WSTR 1000 False
InventoryDetailsUnfulfillableQuantityTotalUnfulfillableQuantity DT_I4 0 False
InventoryDetailsUnfulfillableQuantityCustomerDamagedQuantity DT_I4 0 False
InventoryDetailsUnfulfillableQuantityWarehouseDamagedQuantity DT_I4 0 False
InventoryDetailsUnfulfillableQuantityDistributorDamagedQuantity DT_I4 0 False
InventoryDetailsUnfulfillableQuantityCarrierDamagedQuantity DT_I4 0 False
InventoryDetailsUnfulfillableQuantityDefectiveQuantity DT_I4 0 False
InventoryDetailsUnfulfillableQuantityExpiredQuantity DT_I4 0 False

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.