v1

latestOpenAPI 3.0.02026-07-2480129136.5 KB
Stores

List Product Summary By Category

List all products based on criteria

post/stores/{storeKey}/inventory/categories/{categoryId}/search

Path parameters

storeKeystring required

Required. A unique key used to identify the caller of the API.

categoryIdinteger required

If specified, only return products from this Category.

Query parameters

skuLimitinteger

The maximum number of SKUs to use in the inventory summary. Default is 3.

includeCustomboolean

If set to true, custom listings will be returned. Default is true.

includeGenericboolean

If set to true, generic listings will be returned. Default is true.

channelIdinteger

The channel to search for results. Defaults to 0, the TCG Marketplace.

includeExcludedCategoriesboolean

If true, will return results for excluded categories. Default is false.

Request body

offsetinteger
limitinteger
sortstring
includeAggregatesboolean

Response

OK

totalItemsinteger
successboolean
errorsstring[]