product

product.count

Count products in store.

get/product.count.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/product.count.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

skustring

Filter by product's sku

product_idsstring

Counts products specified by product ids

since_idstring

Retrieve entities starting from the specified id.

categories_idsstring

Defines product add that is specified by comma-separated categories id

category_idstring

Counts products specified by category id

store_idstring

Counts products specified by store id

vendor_idstring

Counts products specified by vendor id

lang_idstring

Counts products specified by language id

avail_viewboolean

Specifies the set of visible/invisible products

avail_saleboolean

Specifies the set of available/not available products for sale.<br/>On BigCommerce the count checks only whether the product is set as purchasable and ignores stock (pre-order products are counted neither as true nor as false), so it can differ from product.list with the same value, which also checks stock at all inventory locations

is_partial_or_full_out_of_stockboolean

Specifies the set of products that are out of stock completely or partially. Only true is supported: it returns products tracked per product that have no stock, and products tracked per variant that have at least one out-of-stock variant, even while other variants of the same product still have stock. Stock is checked at the default inventory location only, so a product that still has stock at another location can be returned, and a product whose only variant is the base one is not matched. Unlike avail_sale, which answers for the product as a whole, this catches a product that still sells overall because some of its variants do

created_fromstring

Retrieve entities from their creation date

created_tostring

Retrieve entities to their creation date

modified_fromstring

Retrieve entities from their modification date

modified_tostring

Retrieve entities to their modification date

brand_namestring

Retrieves brands specified by brand name

manufacturer_idstring

Defines product's manufacturer by manufacturer_id

product_attributesstring[]

Defines product attributes

statusstring

Defines product's status

typestring

Defines products's type

visiblestring

Filter items by visibility status

find_valuestring

Entity search that is specified by some value

find_wherestring

Counts products that are searched specified by field

report_request_idstring

Report request id

return_globalboolean

Determines the type of products to be returned. If set to 'true', only global products will be returned; if set to 'false', only local products will be returned.

disable_report_cacheboolean

Disable report cache for current request

use_latest_api_versionboolean

Use the latest platform API version

Response

successful operation

return_codeinteger nullable
return_messagestring nullable
additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.