product

product.list

Get list of products from your store. Returns 10 products by default.

get/product.list.json

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

startinteger

This parameter sets the number from which you want to get entities

countinteger

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

page_cursorstring

Used to retrieve products via cursor-based pagination (it can't be used with any other filtering parameter)

product_idsstring

Retrieves products specified by product ids

since_idstring

Retrieve entities starting from the specified id.

categories_idsstring

Retrieves products specified by categories ids

category_idstring

Retrieves products specified by category id

store_idstring

Retrieves products specified by store id

vendor_idstring

Retrieves products specified by vendor id

lang_idstring

Retrieves products specified by language id

currency_idstring

Currency Id

avail_viewboolean

Specifies the set of visible/invisible products

avail_saleboolean

Specifies the set of available/not available products for sale

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

skustring

Filter by product's sku

brand_namestring

Retrieves brands specified by brand name

product_attributesstring[]

Defines product attributes

manufacturer_idstring

Defines product's manufacturer by manufacturer_id

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

Product search that is specified by field

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.

paramsstring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve

response_fieldsstring

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.

excludestring

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

sort_bystring

Set field to sort by

sort_directionstring

Set sorting direction

report_request_idstring

Report request id

disable_cacheboolean

Disable cache for current request

disable_report_cacheboolean

Disable report cache for current request

use_latest_api_versionboolean

Use the latest platform API version

product_typestring

A categorization for the product

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.