GET /product.list.json

api2cart.com

Summary:
Operation ID: ProductList
Auth: unknown
Description

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

Parameters (28)

avail_sale (boolean, query, optional)

Specifies the set of available/not available products for sale

avail_view (boolean, query, optional)

Specifies the set of visible/invisible products

brand_name (string, query, optional)

Retrieves brands specified by brand name

category_id (string, query, optional)

Retrieves products specified by category id

count (integer, query, optional, default: 10)

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

created_from (string, query, optional)

Retrieve entities from their creation date

created_to (string, query, optional)

Retrieve entities to their creation date

currency_id (string, query, optional)

Currency Id

disable_cache (boolean, query, optional, default: False)

Disable cache for current request

disable_report_cache (boolean, query, optional, default: False)

Disable report cache for current request

exclude (string, query, optional)

Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all

lang_id (string, query, optional)

Retrieves products specified by language id

modified_from (string, query, optional)

Retrieve entities from their modification date

modified_to (string, query, optional)

Retrieve entities to their modification date

page_cursor (string, query, optional)

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

params (string, query, optional, default: id,name,description,price,categories_ids)

Set this parameter in order to choose which entity fields you want to retrieve

product_attributes (array, query, optional)

Defines product attributes

product_ids (string, query, optional)

Retrieves products specified by product ids

report_request_id (string, query, optional)

Report request id

response_fields (string, query, optional)

Set this parameter in order to choose which entity fields you want to retrieve

since_id (integer, query, optional)

Retrieve entities starting from the specified id.

sku (string, query, optional)

Filter by product's sku

sort_by (string, query, optional, default: id)

Set field to sort by

sort_direction (string, query, optional, default: asc)

Set sorting direction

start (integer, query, optional, default: 0)

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

status (string, query, optional)

Defines product's status

store_id (string, query, optional)

Retrieves products specified by store id

type (string, query, optional)

Defines products's type

No probe data for this endpoint yet.