Reference

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 reference]

Parameters

Parameter Required Options
Name: MarketplaceIds

Label: 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
Name: Details

Label: Include details

true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value false).
YES
Option Value
true true
false false
Name: GranularityType

Label: Granularity Type

The granularity type for the inventory aggregation level.
YES
Option Value
Marketplace Marketplace
Name: GranularityId

Label: Granularity Id

The granularity ID for the inventory aggregation level (e.g. MarketPlaceId if granularityType is MarketPlace 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
Name: StartDateTime

Label: Start Date

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)
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
Name: SellerSku

Label: SellerSku (Single)

A single seller SKU used for querying the specified seller SKU inventory summaries.
Name: SellerSkus

Label: SellerSkus (Multiple)

A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
Name: PageSize

Label: PageSize

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Asin DT_WSTR nvarchar(500) 500
FnSku DT_WSTR nvarchar(50) 50
ProductName DT_WSTR nvarchar(500) 500
TotalQuantity DT_I4 int
SellerSku DT_WSTR nvarchar(100) 100
Condition DT_WSTR nvarchar(50) 50
LastUpdatedTime DT_DBTIMESTAMP datetime
InventoryDetailsFulfillableQuantity DT_I4 int
InventoryDetailsInboundWorkingQuantity DT_I4 int
InventoryDetailsInboundShippedQuantity DT_I4 int
InventoryDetailsInboundReceivingQuantity DT_I4 int
InventoryDetailsReservedQuantityTotalReservedQuantity DT_I4 int
InventoryDetailsReservedQuantityPendingCustomerOrderQuantity DT_I4 int
InventoryDetailsReservedQuantityPendingTransshipmentQuantity DT_I4 int
InventoryDetailsReservedQuantityFcProcessingQuantity DT_I4 int
InventoryDetailsResearchingQuantityTotalResearchingQuantity DT_I4 int
InventoryDetailsResearchingQuantityResearchingQuantityBreakdown DT_WSTR nvarchar(1000) 1000
InventoryDetailsUnfulfillableQuantityTotalUnfulfillableQuantity DT_I4 int
InventoryDetailsUnfulfillableQuantityCustomerDamagedQuantity DT_I4 int
InventoryDetailsUnfulfillableQuantityWarehouseDamagedQuantity DT_I4 int
InventoryDetailsUnfulfillableQuantityDistributorDamagedQuantity DT_I4 int
InventoryDetailsUnfulfillableQuantityCarrierDamagedQuantity DT_I4 int
InventoryDetailsUnfulfillableQuantityDefectiveQuantity DT_I4 int
InventoryDetailsUnfulfillableQuantityExpiredQuantity DT_I4 int
If the column you are looking for is missing, consider customizing Amazon Selling Partner (SP-API) Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Amazon Selling Partner (SP-API) Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Amazon Selling Partner (SP-API)
Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.
Amazon Selling Partner (SP-API)
Get FBA Inventory Summaries (Fulfilled By Amazon)
Required Parameters
MarketplaceIds Fill-in the parameter...
Include details Fill-in the parameter...
Granularity Type Fill-in the parameter...
Granularity Id Fill-in the parameter...
Optional Parameters
Start Date
SellerSku (Single)
SellerSkus (Multiple)
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Amazon Selling Partner (SP-API)
Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.
Amazon Selling Partner (SP-API)
Get FBA Inventory Summaries (Fulfilled By Amazon)
Required Parameters
MarketplaceIds Fill-in the parameter...
Include details Fill-in the parameter...
Granularity Type Fill-in the parameter...
Granularity Id Fill-in the parameter...
Optional Parameters
Start Date
SellerSku (Single)
SellerSkus (Multiple)
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get fba inventory summaries

SELECT * FROM get_inventory_summaries
WITH
(
    "MarketplaceIds" = 'abcd-1234-marketplaceids',
    "Details" = 'true',
    "GranularityType" = 'Marketplace',
    "GranularityId" = 'abcd-1234-granularityid'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get fba inventory summaries

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_inventory_summaries
WITH
(
    "MarketplaceIds" = ''abcd-1234-marketplaceids'',
    "Details" = ''true'',
    "GranularityType" = ''Marketplace'',
    "GranularityId" = ''abcd-1234-granularityid''
)';

EXEC (@MyQuery) AT [LS_TO_AMAZON_SELLING_PARTNER_SP_API_IN_GATEWAY];