Product List
This endpoint fetches a list of products based on specific filters such as store ID and product type. It supports pagination to manage large datasets efficiently.
GET
{{Base_url}}/rest/V1/products/?searchCriteria[filterGroups][0][filters][0][field]=store_id&searchCriteria[filterGroups][0][filters][0][value]=41&searchCriteria[filterGroups][1][filters][0][field]=type_id&searchCriteria[filterGroups][1][filters][0][value]=simple&searchCriteria[pageSize]=10&searchCriteria[currentPage]=1
This API endpoint is used to retrieve detailed product information based on applied filters such as store ID, product type, and other parameters. It supports pagination and filtering, making it suitable for fetching specific subsets of products from the catalog. The response provides detailed attributes of each product, enabling seamless integration with e-commerce applications.
Query Parameters
1. searchCriteria
Defines the filtering and pagination criteria for the product search.
filterGroups
Groups multiple filters. EachfilterGroups
element contains an array offilters
.filters
Specifies individual filtering criteria, including:field
: The field in the product database to filter by.value
: The value to match for the specified field.
Filters Applied in This Endpoint
Filter Group 0
Field:
store_id
Filters products based on the store ID.Value:
41
Only products associated with store ID41
are retrieved.
Filter Group 1
Field:
type_id
Filters products based on their type.Value:
simple
Retrieves only products of typesimple
.
2. Pagination Parameters
Used to control the number of products retrieved per request and the specific page of results.
searchCriteria[pageSize]
Specifies the number of products to retrieve in one API response.Value:
10
(retrieves 10 products per page).
searchCriteria[currentPage]
Indicates which page of results to fetch.Value:
1
(fetches the first page of results).
Functionality
This endpoint retrieves simple products (i.e., single SKUs without variants) that belong to store ID 41, with a maximum of 10 products per request, and returns the first page of results.
curl --location --globoff '{{Base_url}}/rest/V1/products/?searchCriteria[filterGroups][0][filters][0][field]=store_id&searchCriteria[filterGroups][0][filters][0][value]=41&searchCriteria[filterGroups][1][filters][0][field]=type_id&searchCriteria[filterGroups][1][filters][0][value]=simple&searchCriteria[pageSize]=10&searchCriteria[currentPage]=1' \
--header 'Authorization: Bearer eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjU1LCJ1dHlwaWQiOjIsImlhdCI6MTczMzEyMjQwNiwiZXhwIjoxNzMzMTI2MDA2fQ.ev6Faj3zcH-QTW8_rsWgJRNLKMYcn62Jx6D8kX9XOUc' \
--header 'Cookie: PHPSESSID=6t4unirh1unu87ef0stp2sv3kv; PHPSESSID=6t4unirh1unu87ef0stp2sv3kv; private_content_version=5ab80b7def0c212f723edead3c971a19'
Responses
{
"items": [
{
"id": 10,
"sku": "T48300IN",
"name": "Lasko 48\" Xtra Air Tower Fan with Fresh Air Ionizer",
"attribute_set_id": 10,
"price": 11999,
"status": 1,
"visibility": 4,
"type_id": "simple",
"created_at": "2021-01-20 06:56:13",
"updated_at": "2024-12-17 14:10:03",
"weight": 5.18,
"extension_attributes": {
"website_ids": [
1,
2,
3,
4,
5,
16,
17,
18,
19
],
"category_links": [
{
"position": 0,
"category_id": "2"
},
{
"position": 0,
"category_id": "42"
},
{
"position": 0,
"category_id": "230"
},
{
"position": 0,
"category_id": "531"
},
{
"position": 0,
"category_id": "529"
}
],
"discount_percentage": 0.33
},
"product_links": [],
"options": [],
"media_gallery_entries": [
{
"id": 196939,
"media_type": "image",
"label": null,
"position": 5,
"disabled": false,
"types": [
"image",
"small_image",
"thumbnail",
"swatch_image"
],
"file": "/l/a/laskoa.png"
},
{
"id": 196940,
"media_type": "image",
"label": null,
"position": 6,
"disabled": false,
"types": [],
"file": "/l/a/laskob.png"
},
{
"id": 196941,
"media_type": "image",
"label": null,
"position": 7,
"disabled": false,
"types": [],
"file": "/l/a/laskoc.png"
},
{
"id": 196942,
"media_type": "image",
"label": null,
"position": 8,
"disabled": false,
"types": [],
"file": "/l/a/laskod.png"
},
{
"id": 196943,
"media_type": "image",
"label": null,
"position": 9,
"disabled": false,
"types": [],
"file": "/l/a/laskoe.png"
}
],
"tier_prices": [],
"custom_attributes": [
{
"attribute_code": "split_by_brand",
"value": "Lasko"
},
{
"attribute_code": "image",
"value": "/l/a/laskoa.png"
},
{
"attribute_code": "url_key",
"value": "wind-curve-ionizer-with-tower-fan"
},
{
"attribute_code": "special_price",
"value": "7999.000000"
},
{
"attribute_code": "gift_message_available",
"value": "0"
},
{
"attribute_code": "hsncode",
"value": "8414"
},
{
"attribute_code": "productsurcharge_fee",
"value": "0.00"
},
{
"attribute_code": "small_image",
"value": "/l/a/laskoa.png"
},
{
"attribute_code": "special_from_date",
"value": "2023-09-19 00:00:00"
},
{
"attribute_code": "options_container",
"value": "container2"
},
{
"attribute_code": "thumbnail",
"value": "/l/a/laskoa.png"
},
{
"attribute_code": "asn",
"value": "B0847HR78V"
},
{
"attribute_code": "swatch_image",
"value": "/l/a/laskoa.png"
},
{
"attribute_code": "popular_product",
"value": "0"
},
{
"attribute_code": "msrp_display_actual_price_type",
"value": "0"
},
{
"attribute_code": "tax_class_id",
"value": "2"
},
{
"attribute_code": "required_options",
"value": "0"
},
{
"attribute_code": "has_options",
"value": "0"
},
{
"attribute_code": "warranty",
"value": "3 Year Onsite Motor"
},
{
"attribute_code": "category_ids",
"value": [
"2",
"42",
"230",
"531",
"529"
]
},
{
"attribute_code": "sw_featured",
"value": "0"
},
{
"attribute_code": "product_image_size",
"value": "0"
},
{
"attribute_code": "remote_control",
"value": "1"
},
{
"attribute_code": "horizontal_oscillation",
"value": "1"
},
{
"attribute_code": "ionizer",
"value": "1"
},
{
"attribute_code": "easy_carry_handle",
"value": "1"
},
{
"attribute_code": "motor_warranty",
"value": "1"
},
{
"attribute_code": "speed",
"value": "3 speed"
},
{
"attribute_code": "timer",
"value": "7 hours"
},
{
"attribute_code": "dimensions_lxbxh_cms",
"value": "13\"L x 13\"W x 48\"H"
},
{
"attribute_code": "delivery_lead_time",
"value": "Dispatches Within 2 Business Days from Bangalore"
},
{
"attribute_code": "fireboltt_color",
"value": "299"
},
{
"attribute_code": "short_description",
"value": "<ul>\r\n<ul>\r\n<li>High-reaching 48\" tower design for maximum air delivery</li>\r\n<li>Widespread oscillation to cool the entire room</li>\r\n<li>3 quiet speed modes - low, medium, high</li>\r\n<li>Electronic timer which can be programmed for up to 7 hours</li>\r\n<li>The built-in fresh air ionizer option helps to promote a clean, cool environment</li>\r\n<li>Handy and space-saver</li>\r\n<li>On-board remote storage</li>\r\n<li>Simple no-tool assembly</li>\r\n<li>Ideal for family areas, living rooms and bedrooms</li>\r\n</ul>\r\n</ul>\r\n<p> </p>"
},
{
"attribute_code": "description",
"value": "<p><img style=\"display: block; margin-left: auto; margin-right: auto;\" src=\"{{media url="Untitled_design_1.jpg"}}\" alt=\"\" /></p>\r\n<p style=\"text-align: center;\"><strong><span class=\"a-text-bold\">What does an ionizer do?</span></strong></p>\r\n<p style=\"text-align: center;\">Air Ionizers create negative ions using electricity and then discharge them into the air. These negative ions attach to positively charged particles in the room, such as dust, bacteria, pollen, smoke, and other allergens. The positively charged particles and negative ions bond together to create dense dirt particles that cannot float in the air.</p>\r\n<p style=\"text-align: center;\"> </p>\r\n<p style=\"text-align: center;\"><img src=\"{{media url="Untitled_design_2_.jpg"}}\" alt=\"\" /></p>\r\n<p style=\"text-align: center;\"><strong>Sleep Like a Baby</strong></p>\r\n<p style=\"text-align: center;\">Perfectly sized to aim over a high bed and powerful enough to blow across the room.</p>\r\n<p style=\"text-align: center;\"> </p>\r\n<p style=\"text-align: center;\"><img src=\"{{media url="Untitled_design_1__1.jpg"}}\" alt=\"\" /></p>"
},
{
"attribute_code": "height",
"value": "119"
},
{
"attribute_code": "length",
"value": "20"
},
{
"attribute_code": "subcategory",
"value": "Air Purifier"
},
{
"attribute_code": "width",
"value": "18"
},
{
"attribute_code": "rateable",
"value": "1"
},
{
"attribute_code": "cancellable",
"value": "0"
},
{
"attribute_code": "returnable",
"value": "0"
},
{
"attribute_code": "seller_pickup_return",
"value": "0"
},
{
"attribute_code": "name_of_manufacturer",
"value": "Lasko, Lasko Products LLC, USA,"
},
{
"attribute_code": "return_period",
"value": "N/A"
},
{
"attribute_code": "igst",
"value": "0"
},
{
"attribute_code": "cgst",
"value": "9"
},
{
"attribute_code": "sgst",
"value": "9"
},
{
"attribute_code": "number_of_units_in_package",
"value": "1"
},
{
"attribute_code": "month_year_of_manufacturing",
"value": "23-Feb"
},
{
"attribute_code": "measure_of_commodity_in_package",
"value": "2"
},
{
"attribute_code": "package_length",
"value": "22"
},
{
"attribute_code": "package_width",
"value": "20"
},
{
"attribute_code": "package_height",
"value": "122"
},
{
"attribute_code": "package_weight",
"value": "6.98"
},
{
"attribute_code": "manufacturer_address",
"value": "Zeitgeist Retail Private Limited ,42, 15th Cross, 14th A Main Rd, Sector 4, HSR Layout, Bengaluru, Karnataka 560102 "
},
{
"attribute_code": "amazon_title",
"value": "Lasko 48\" Xtra Air Tower Fan w..."
},
{
"attribute_code": "amazon_price",
"value": "₹11,499.00"
},
{
"attribute_code": "amazon_review",
"value": "Customers like the cooling ability of the electric fan. They mention it really cools as compared to ceiling fans. Customers appreciate the noise level and look. However, some customers have reported that the fan stopped working after 10 minutes of usage and the motor burnt within 8 months. They also have issues with the fan speed. Opinions differ on its effectiveness, air flow, and value for money."
},
{
"attribute_code": "amazon_image_url",
"value": "https://m.media-amazon.com/images/I/31eKhId90FL.jpg"
},
{
"attribute_code": "total_reviews",
"value": "0"
},
{
"attribute_code": "amazon_rating",
"value": "3"
},
{
"attribute_code": "amazon_total_ratings",
"value": "107"
}
]
},
{
"id": 12,
"sku": "A504-IN-SPP",
"name": "Lasko Electrostatic Air Purifier, Zero Maintenance, Ideal for College Dorms and Cubicle",
"attribute_set_id": 11,
"price": 11999,
"status": 1,
"visibility": 4,
"type_id": "simple",
"created_at": "2021-01-20 06:56:13",
"updated_at": "2024-11-05 12:17:51",
"weight": 5.65,
"extension_attributes": {
"website_ids": [
1,
2,
3,
4,
5,
13,
19,
22,
38
],
"category_links": [
{
"position": 0,
"category_id": "2"
},
{
"position": 0,
"category_id": "6"
},
{
"position": 0,
"category_id": "57"
},
{
"position": 0,
"category_id": "529"
},
{
"position": 0,
"category_id": "729"
}
],
"discount_percentage": 0.33
},
"product_links": [],
"options": [],
"media_gallery_entries": [
{
"id": 196949,
"media_type": "image",
"label": null,
"position": 1,
"disabled": false,
"types": [
"image",
"small_image",
"thumbnail",
"swatch_image"
],
"file": "/l/a/laskobb_1.png"
},
{
"id": 2164,
"media_type": "external-video",
"label": null,
"position": 2,
"disabled": false,
"types": [],
"file": "/h/q/hqdefault_3_27.jpg",
"extension_attributes": {
"video_content": {
"media_type": "external-video",
"video_provider": "",
"video_url": "https://www.youtube.com/watch?v=SEivYngJ4r0",
"video_title": "Lasko Purifier A504IN",
"video_description": "",
"video_metadata": ""
}
}
},
{
"id": 196950,
"media_type": "image",
"label": null,
"position": 9,
"disabled": false,
"types": [],
"file": "/l/a/laskocc_1.png"
},
{
"id": 196951,
"media_type": "image",
"label": null,
"position": 10,
"disabled": false,
"types": [],
"file": "/l/a/laskoee_1.png"
},
{
"id": 196952,
"media_type": "image",
"label": null,
"position": 11,
"disabled": false,
"types": [],
"file": "/l/a/laskodd_1.png"
},
{
"id": 196953,
"media_type": "image",
"label": null,
"position": 12,
"disabled": false,
"types": [],
"file": "/l/a/laskoff_1.png"
}
],
"tier_prices": [],
"custom_attributes": [
{
"attribute_code": "split_by_brand",
"value": "Lasko"
},
{
"attribute_code": "short_description",
"value": "<ul>\r\n<ul>\r\n<li><strong>COMPACT SIZE</strong><strong>:</strong> The Lasko Air Purifier comes in a compact size and robust capabilities making it ideal for use in dorms and small study room. It measures 45.9 centimetres in height, 18.5 centimetres in width, and 29.4 centimetres in depth. You can easily place this gadget against the wall and enjoy its functionalities without unnecessary clutter around your small room or study table.</li>\r\n<li><strong>ELIMINATES POLLUTANTS</strong>: It can be used in dorms to eradicate odors from the bathroom and food, captures dust and eliminate mold, viruses and bacteria, cooking and tobacco smoke. Can capture particles smaller than 0.3 microns since it uses a strong static field. Allowing college students, a serene environment for studying.</li>\r\n<li><strong>ZERO </strong><strong>MAINTENANCE </strong><strong>COST</strong>: Many college students don’t have time to inspect their air purifiers or even filters. Thankfully, the Lasko Air Purifier comes with an automatic check filter indicator which alerts you when the filter is due for cleaning. Permanent filter can be easily washed clean with soap and water. Patented, high durability Hand Washable and Dishwasher Safe. Lasko Air Purifier comes with a stainless-steel Pre-Filter (10-year lifespan).</li>\r\n<li><strong>ENERGY EFFICIENT AND LESS NOISE</strong>: The Lasko Air Purifier features a motor that is not only efficient but is also silent enough to allow students a conducive reading environment. Quiet Fan Technology 2 fans pull polluted air into the system. Only 15 Watts per Hour. You can run the Lasko Electrostatic Air Purifier 24 hours a day, 7 days a week allowing college students a serene environment for studying.</li>\r\n<li><strong>ADVANCE FILTRATION</strong>: Effectively captures harmful atomic size particles that HEPA filters can leave behind. Lasko’s Electrostatic Air Purifier is constructed of a series of metal plates and an ionizer wire.</li>\r\n<li><strong>TRUSTED FOR GENERATIONS:</strong> Lasko has been making quality household products for over 100 years in the U.S. For queries, For queries, please contact Lasko India customer care: Call or Whatsapp +91-96060-80480</li>\r\n</ul>\r\n</ul>"
},
{
"attribute_code": "image",
"value": "/l/a/laskobb_1.png"
},
{
"attribute_code": "url_key",
"value": "lasko-electrostatic-air-purifier-i"
},
{
"attribute_code": "special_price",
"value": "7999.000000"
},
{
"attribute_code": "gift_message_available",
"value": "0"
},
{
"attribute_code": "hsncode",
"value": "8421"
},
{
"attribute_code": "productsurcharge_fee",
"value": "0.00"
},
{
"attribute_code": "description",
"value": "<p><img style=\"display: block; margin-left: auto; margin-right: auto;\" src=\"{{media url="wysiwyg/Email_Header_600x200_px_2_finalA_1.jpg"}}\" alt=\"\" width=\"970\" height=\"600\" /></p>\r\n<h2 class=\"a-spacing-mini\"><strong>Lasko Air Purifiers Don't Need Filter Replacement</strong></h2>\r\n<p class=\"a-spacing-base\">Most common & traditional air purifiers use HEPA filters, but a recent study has shown that HEPA filters can still leave small particles in the air. <span class=\"a-text-bold\">Lasko’s Electrostatic Air Purifiers</span> have Stainless Steel Filters constructed of a series of metal plates and an ionizer wire.</p>\r\n<p class=\"a-spacing-base\">As the air particles pass through the wire, they become charged and are attracted to the stainless steel collection plates.</p>\r\n<p class=\"a-spacing-base\">The filter captures particles smaller than <strong><span class=\"a-text-bold\">0.3 microns</span></strong> since it uses a strong static field and fights odors without the need for extra filters. Not only do Lasko’s Electrostatic Air Purifiers create no ozone, they also remove any harmful background ozone in the air. The filter delivers permanent effectiveness and customers do not need to purchase replacement filters. The permanent filter can be easily washed clean with soap and water.</p>\r\n<p class=\"a-spacing-base\"> </p>\r\n<p class=\"a-spacing-base\"><img style=\"display: block; margin-left: auto; margin-right: auto;\" src=\"{{media url="wysiwyg/Store_front.jpg"}}\" alt=\"\" width=\"970\" height=\"600\" /></p>\r\n<p class=\"a-spacing-base\"><img style=\"display: block; margin-left: auto; margin-right: auto;\" src=\"{{media url="wysiwyg/A_1.jpg"}}\" alt=\"\" width=\"970\" height=\"600\" /></p>"
},
{
"attribute_code": "small_image",
"value": "/l/a/laskobb_1.png"
},
{
"attribute_code": "meta_title",
"value": "Lasko Electrostatic Air Purifier, Zero Maintenance, Ideal for College Dorms and Cubicles"
},
{
"attribute_code": "special_from_date",
"value": "2023-03-21 00:00:00"
},
{
"attribute_code": "options_container",
"value": "container2"
},
{
"attribute_code": "thumbnail",
"value": "/l/a/laskobb_1.png"
},
{
"attribute_code": "meta_keyword",
"value": "Lasko Electrostatic Air Purifier, Zero Maintenance, Ideal for College Dorms and Cubicles"
},
{
"attribute_code": "asn",
"value": "B08HM28SZ2"
},
{
"attribute_code": "swatch_image",
"value": "/l/a/laskobb_1.png"
},
{
"attribute_code": "meta_description",
"value": "Lasko Electrostatic Air Purifier, Zero Maintenance, Ideal for College Dorms and Cubicles"
},
{
"attribute_code": "popular_product",
"value": "0"
},
{
"attribute_code": "msrp_display_actual_price_type",
"value": "0"
},
{
"attribute_code": "mutiselect_color",
"value": "1878,1879,1880,1881"
},
{
"attribute_code": "tax_class_id",
"value": "2"
},
{
"attribute_code": "required_options",
"value": "0"
},
{
"attribute_code": "has_options",
"value": "0"
},
{
"attribute_code": "category_ids",
"value": [
"2",
"6",
"57",
"529",
"729"
]
},
{
"attribute_code": "sw_featured",
"value": "0"
},
{
"attribute_code": "product_image_size",
"value": "0"
},
{
"attribute_code": "model",
"value": "A504IN"
},
{
"attribute_code": "warranty",
"value": "3 year Onsite Motor"
},
{
"attribute_code": "ionizer",
"value": "1"
},
{
"attribute_code": "easy_carry_handle",
"value": "1"
},
{
"attribute_code": "motor_warranty",
"value": "1"
},
{
"attribute_code": "area_covered",
"value": "300 sq. ft"
},
{
"attribute_code": "power_consumption",
"value": "15 watts"
},
{
"attribute_code": "filter",
"value": "Permanent Stainless Steel"
},
{
"attribute_code": "filter_maintenance",
"value": "Handwasher and dishwasher safe"
},
{
"attribute_code": "product_dimension",
"value": "18.5 cm x 29.4 cm x 45.9 cm"
},
{
"attribute_code": "cadr",
"value": "230 (m3/hr) / high"
},
{
"attribute_code": "dimensions_lxbxh_cms",
"value": "35 x 24.5 x 57"
},
{
"attribute_code": "delivery_lead_time",
"value": "Dispatches Within 2 Business Days from Bangalore"
},
{
"attribute_code": "shopify_color",
"value": "248"
},
{
"attribute_code": "fireboltt_color",
"value": "458"
},
{
"attribute_code": "subcategory",
"value": "Air Purifier"
},
{
"attribute_code": "color_dropdown",
"value": "1746"
},
{
"attribute_code": "width",
"value": "29.4"
},
{
"attribute_code": "height",
"value": "45.9"
},
{
"attribute_code": "length",
"value": "18.5"
},
{
"attribute_code": "rateable",
"value": "0"
},
{
"attribute_code": "cancellable",
"value": "0"
},
{
"attribute_code": "returnable",
"value": "0"
},
{
"attribute_code": "seller_pickup_return",
"value": "0"
},
{
"attribute_code": "amazon_title",
"value": "Lasko Electrostatic Air Purifi..."
},
{
"attribute_code": "amazon_price",
"value": "₹10,999.00"
},
{
"attribute_code": "amazon_review",
"value": "Customers appreciate the value for money, ease of installation, and functionality of the air purifier. They mention it works great and is a one-time investment."
},
{
"attribute_code": "amazon_image_url",
"value": "https://m.media-amazon.com/images/I/31FU0zj4U7L.jpg"
},
{
"attribute_code": "total_reviews",
"value": "0"
},
{
"attribute_code": "amazon_rating",
"value": "3.9"
},
{
"attribute_code": "amazon_total_ratings",
"value": "39"
}
]
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "store_id",
"value": "41",
"condition_type": "eq"
}
]
},
{
"filters": [
{
"field": "type_id",
"value": "simple",
"condition_type": "eq"
}
]
}
],
"page_size": 2,
"current_page": 1
},
"total_count": 515
}
Detailed Response Breakdown
Here is a breakdown of the fields returned in the API response:
Main Product Attributes
id
: The unique identifier for the product. Example:10
sku
: The stock-keeping unit of the product, used for inventory tracking. Example:"T48300IN"
name
: The product name. Example:"Lasko 48\" Xtra Air Tower Fan with Fresh Air Ionizer"
attribute_set_id
: The ID of the attribute set to which the product belongs. Example:10
price
: The base price of the product. Example:11999
status
: The availability status of the product. Example:1
(active)visibility
: The visibility scope of the product (e.g., catalog, search). Example:4
(visible in both catalog and search)type_id
: The type of the product. Example:"simple"
created_at
andupdated_at
: Timestamps for product creation and last update. Example:"2021-01-20 06:56:13"
weight
: The weight of the product. Example:5.18
Extension Attributes
website_ids
: The list of website IDs where the product is available. Example:[1, 2, 3, 4]
category_links
: The categories to which the product belongs, including position and category ID.discount_percentage
: The percentage discount applied to the product. Example:0.33
Media Gallery Entries
media_gallery_entries
: A list of media associated with the product, including images and their types.
Custom Attributes
split_by_brand
: The brand associated with the product. Example:"Lasko"
special_price
: The discounted price of the product. Example:"7999.00"
short_description
: A concise description of the product.description
: A detailed description of the product, including additional details like usage and features.
Additional Information
dimensions_lxbxh_cms
: Product dimensions. Example:"13\"L x 13\"W x 48\"H"
delivery_lead_time
: Time required to dispatch the product. Example:"Dispatches Within 2 Business Days from Bangalore"
amazon_review
: Aggregated customer feedback. Example:"Customers like the cooling ability...However, some customers have reported issues with fan speed and durability."
returnable
andcancellable
: Flags indicating whether the product can be returned or canceled.
Error Responses
{
"message": "The store that was requested wasn't found. Verify the store and try again."
}
Last updated