v1

latestOpenAPI 3.0.02026-07-2480129136.5 KB
Stores

List Product Summary

List Product Summary.

get/stores/{storeKey}/inventory/products

Path parameters

storeKeystring required

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

Query parameters

categoryIdinteger

If specified, only return products from this Category.

categoryNamestring

If specified, only return products from this Category.

groupIdinteger

If specified, only return products from this Group.

groupNamestring

If specified, only return products from this Group.

productNamestring

If specified, only return products with names that contain this string.

skuLimitinteger

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

sortstring

If specified, sort the results by this value. Default is descending by Price.

includeGenericboolean

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

includeCustomboolean

If set to true, custom 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.

offsetinteger

Used for paging. The number of StoreProducts to skip. Default is 0.

limitinteger

Used for paging. The maximum number of StoreProducts to return. Default is 10.

Response

OK

totalItemsinteger
successboolean
errorsstring[]