Skip to main content
GET
List Inventory Groups

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Query Parameters

productIds
string[]

Optional product IDs to scope the inventory summary. Parent product IDs include their variants.

Maximum array length: 50
Minimum string length: 1
query
string

Optional keyword filter for product name or SKU before grouping.

Maximum string length: 200
marketplace
string[]

Optional marketplace filter (e.g. shopee, lazada, tiktok, shopify, zalora, amazon, ebay). When used with storeIds, both must match.

Maximum array length: 10
Required string length: 1 - 80
country
string[]

Optional country filters (ISO code or name, e.g. sg, singapore). Country is not unique per store — use storeIds when multiple shops share a country.

Maximum array length: 20
Required string length: 1 - 80
storeIds
string[]

Optional connected store IDs to scope results. Prefer this when multiple stores exist for the same marketplace/country (e.g. two Lazada shops in SG). Matches product marketplace storeId / order account_id. Omit for all stores.

Maximum array length: 50
Required string length: 1 - 200
unlistedMarketplaces
enum<string>[]

Return only product families with no saved listing identity on ANY of these marketplaces, across every organization store. Checks product/variant identities and exact catalog SKUs across the entire catalog, including disabled and historical listings. This absence check is independent of the source marketplace/country/store filters. Saved-catalog evidence, not fresh live verification; missing-SKU families are reported as unknown, not confirmed absent.

Required array length: 1 - 8 elements
Available options:
shopee,
lazada,
tiktok,
shopify,
whatsapp,
zalora,
amazon,
ebay
groupBy
enum<string>

How to group summary rows. Defaults to product.

Available options:
product,
marketplace,
country
status
enum<string>

Inventory status subset to summarize. in_stock requires positive canonical available stock (on hand minus locked); product groups include all variants when their total is positive. Defaults to all.

Available options:
all,
in_stock,
low_stock,
out_of_stock
offset
integer

Grouped-row offset, default 0. Continue with nextOffset and the same filters until hasMore=false to retrieve the complete list.

Required range: 0 <= x <= 9007199254740991
limit
integer

Maximum grouped inventory rows per page (default: 20, max: 30). Use offset/nextOffset for the complete list.

Required range: 1 <= x <= 30

Response

One inventory page, matching count, continuation and listing evidence.

success
enum<boolean>
required
Available options:
true
groupBy
enum<string>
required
Available options:
product,
marketplace,
country
status
enum<string>
required
Available options:
all,
in_stock,
low_stock,
out_of_stock
stats
object
required
groups
object[]
required
count
integer
required
Required range: 0 <= x <= 9007199254740991
totalGroups
integer
required
Required range: 0 <= x <= 9007199254740991
returnedGroups
integer
required
Required range: 0 <= x <= 9007199254740991
truncated
boolean
required
offset
integer
required
Required range: 0 <= x <= 9007199254740991
hasMore
boolean
required
nextOffset
integer | null
required
Required range: 0 <= x <= 9007199254740991
forecast
object
listingPresence
object