Skip to main content
StoreVersion: v3

Fetch Product Store Stats

GET/products/store/{storeId}/stats

API to fetch the total number of products, included in the store, and excluded from the store and other stats

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:products.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

storeIdstringrequired

Products related to the store

Example:3SwdhCu3svxI8AKsPJt6

Query Parameters

altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
searchstring

The name of the product for searching.

Example:Awesome product
collectionIdsstring

Filter by product collection Ids. Supports comma separated values

Example:65c2789a812e52f9bd6ec577,65c2789a812e52de9a6ec576

Response

Successful response

totalProductsnumberrequired

Total number of products

Example:100
includedInStorenumberrequired

Number of products included in the store

Example:80
excludedFromStorenumberrequired

Number of products excluded from the store

Example:20