product.list
Get list of products from your store. Returns 10 products by default.
Request
- Base URL: https://api.api2cart.com/v1.1
- URL: https://api.api2cart.com/v1.1/product.list.json
- Auth: API key in header x-api-key and API key in header x-store-key
Query parameters
This parameter sets the number from which you want to get entities
This parameter sets the entity amount that has to be retrieved. Max allowed count=250
Used to retrieve products via cursor-based pagination (it can't be used with any other filtering parameter)
Retrieves products specified by product ids
Retrieve entities starting from the specified id.
Retrieves products specified by categories ids
Retrieves products specified by category id
Retrieves products specified by store id
Retrieves products specified by vendor id
Retrieves products specified by language id
Currency Id
Specifies the set of visible/invisible products
Specifies the set of available/not available products for sale
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
Retrieve entities from their creation date
Retrieve entities to their creation date
Retrieve entities from their modification date
Retrieve entities to their modification date
Filter by product's sku
Retrieves brands specified by brand name
Defines product attributes
Defines product's manufacturer by manufacturer_id
Defines product's status
Defines products's type
Filter items by visibility status
Entity search that is specified by some value
Product search that is specified by field
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.
Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve
Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.
Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all
Set field to sort by
Set sorting direction
Report request id
Disable cache for current request
Disable report cache for current request
Use the latest platform API version
A categorization for the product
Response
successful operation
Changes
No recorded changes to this operation across all 1 revision of this API.