Products in Category
This API provides the list of products in specific Category.
GET {{Base_url}}/rest/V1/products?searchCriteria[filter_groups][0][filters][0][field]=store_id&searchCriteria[filter_groups][0][filters][0][value]=1&searchCriteria[filter_groups][0][filters][0][condition_type]=eq&searchCriteria[filter_groups][1][filters][0][field]=category_id&searchCriteria[filter_groups][1][filters][0][value]=73&searchCriteria[filter_groups][1][filters][0][condition_type]=eq&searchCriteria[filter_groups][2][filters][0][field]=status&searchCriteria[filter_groups][2][filters][0][value]=1&searchCriteria[filter_groups][2][filters][0][condition_type]=eq&searchCriteria[filter_groups][2][filters][0][field]=type_id&searchCriteria[filter_groups][2][filters][0][value]=configurable&searchCriteria[pageSize]=10&searchCriteria[currentPage]=1&searchCriteria[filter_groups][2][filters][0][condition_type]=eq
This endpoint retrieves a paginated list of products (simple or configurable) from a specific category in a particular store, based on the applied filters such as product type, status, and category ID. It is useful for fetching tailored product listings for category pages or search results.
Query Parameters:
store_id=1: Filters products specific to the store with ID1.category_id=73: Retrieves products that belong to category ID73.status=1: Ensures only enabled products (active and visible) are returned.type_id=configurable: Limits the results to configurable products, which often represent parent products with variations (e.g., sizes, colors).Pagination:
pageSize=10: Limits the result set to 10 products per page.currentPage=1: Fetches the first page of results.
curl --location --globoff '{{Base_url}}/rest/V1/products?searchCriteria[filter_groups][0][filters][0][field]=store_id&searchCriteria[filter_groups][0][filters][0][value]=1&searchCriteria[filter_groups][0][filters][0][condition_type]=eq&searchCriteria[filter_groups][1][filters][0][field]=category_id&searchCriteria[filter_groups][1][filters][0][value]=73&searchCriteria[filter_groups][1][filters][0][condition_type]=eq&searchCriteria[filter_groups][2][filters][0][field]=status&searchCriteria[filter_groups][2][filters][0][value]=2&searchCriteria[filter_groups][2][filters][0][condition_type]=eq&searchCriteria[filter_groups][2][filters][0][field]=type_id&searchCriteria[filter_groups][2][filters][0][value]=simple&searchCriteria[pageSize]=5&searchCriteria[currentPage]=1&searchCriteria[filter_groups][2][filters][0][condition_type]=eq' \
--header 'Authorization: Bearer eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjU1LCJ1dHlwaWQiOjIsImlhdCI6MTcyNjIyMzc4NSwiZXhwIjoxNzI2MjI3Mzg1fQ.9Uey0SefOJMJdPN1u72jMLkxUDxvAo1ySSBME2_qImQ' \
--header 'Cookie: PHPSESSID=6t4unirh1unu87ef0stp2sv3kv; private_content_version=5ab80b7def0c212f723edead3c971a19'Responses
{
"items": [
{
"id": 404,
"sku": "IFPZMB-BL0",
"name": "iFrogz Audio- Ear Pollution Plugz with Mic - Blue",
"attribute_set_id": 15,
"price": 799,
"status": 1,
"visibility": 4,
"type_id": "simple",
"created_at": "2021-03-19 06:58:04",
"updated_at": "2024-12-03 13:22:57",
"weight": 0.04,
"extension_attributes": {
"website_ids": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
25,
29
],
"category_links": [
{
"position": 0,
"category_id": "15"
},
{
"position": 0,
"category_id": "226"
},
{
"position": 0,
"category_id": "319"
},
{
"position": 0,
"category_id": "509"
},
{
"position": 0,
"category_id": "593"
},
{
"position": 0,
"category_id": "580"
},
{
"position": 0,
"category_id": "581"
},
{
"position": 0,
"category_id": "592"
},
{
"position": 0,
"category_id": "73"
},
{
"position": -4,
"category_id": "664"
},
{
"position": -4,
"category_id": "773"
}
],
"discount_percentage": 0.5
},
"product_links": [
{
"sku": "IFPZMB-BL0",
"link_type": "related",
"linked_product_sku": "T42974IN",
"linked_product_type": "simple",
"position": 1
},
{
"sku": "IFPZMB-BL0",
"link_type": "crosssell",
"linked_product_sku": "T42974IN",
"linked_product_type": "simple",
"position": 4
},
{
"sku": "IFPZMB-BL0",
"link_type": "crosssell",
"linked_product_sku": "FIREFLY - WALNUT",
"linked_product_type": "simple",
"position": 2
},
{
"sku": "IFPZMB-BL0",
"link_type": "crosssell",
"linked_product_sku": "20BSWAAY#4",
"linked_product_type": "simple",
"position": 3
},
{
"sku": "IFPZMB-BL0",
"link_type": "upsell",
"linked_product_sku": "T42974IN",
"linked_product_type": "simple",
"position": 1
},
{
"sku": "IFPZMB-BL0",
"link_type": "upsell",
"linked_product_sku": "EGCGBAMZFV003",
"linked_product_type": "virtual",
"position": 2
}
],
"options": [],
"media_gallery_entries": [
{
"id": 4430,
"media_type": "image",
"label": "this",
"position": 0,
"disabled": true,
"types": [],
"file": "/z/a/zagg-ifpzmb-bl0-in-ear-sdl990681149-1-fc65c_1.jpeg"
},
{
"id": 1230,
"media_type": "image",
"label": "final",
"position": 1,
"disabled": false,
"types": [
"image",
"small_image",
"thumbnail",
"swatch_image"
],
"file": "/z/a/zagg-ifpzmb-bl0-in-ear-sdl990681149-1-fc65c_1.jpg"
},
{
"id": 1231,
"media_type": "image",
"label": null,
"position": 2,
"disabled": false,
"types": [],
"file": "/7/1/715pzbmmv9l._sl1500__2.jpg"
},
{
"id": 1232,
"media_type": "image",
"label": null,
"position": 3,
"disabled": false,
"types": [],
"file": "/4/1/41p1rr3_u8l_1_2.jpg"
},
{
"id": 1233,
"media_type": "image",
"label": null,
"position": 4,
"disabled": false,
"types": [],
"file": "/z/a/zagg-ifpzmb-bl0-in-ear-sdl990681149-2-e3b72.jpg"
}
],
"tier_prices": [],
"custom_attributes": [
{
"attribute_code": "split_by_brand",
"value": "Tinder"
},
{
"attribute_code": "special_price",
"value": "399.000000"
},
{
"attribute_code": "image",
"value": "/z/a/zagg-ifpzmb-bl0-in-ear-sdl990681149-1-fc65c_1.jpg"
},
{
"attribute_code": "url_key",
"value": "ifrogz-audio-ear-pollution-plugz-mobile-with-mike-blue"
},
{
"attribute_code": "gift_message_available",
"value": "2"
},
{
"attribute_code": "hsncode",
"value": "8518"
},
{
"attribute_code": "productsurcharge_fee",
"value": "0.00"
},
{
"attribute_code": "meta_title",
"value": "Ifrogz Audio- Ear pollution plugz mobile with mike-Blue"
},
{
"attribute_code": "small_image",
"value": "/z/a/zagg-ifpzmb-bl0-in-ear-sdl990681149-1-fc65c_1.jpg"
},
{
"attribute_code": "options_container",
"value": "container2"
},
{
"attribute_code": "meta_keyword",
"value": "Ifrogz Audio- Ear pollution plugz mobile with mike-Blue"
},
{
"attribute_code": "thumbnail",
"value": "/z/a/zagg-ifpzmb-bl0-in-ear-sdl990681149-1-fc65c_1.jpg"
},
{
"attribute_code": "meta_description",
"value": "Ifrogz Audio- Ear pollution plugz mobile with mike-Blue "
},
{
"attribute_code": "swatch_image",
"value": "/z/a/zagg-ifpzmb-bl0-in-ear-sdl990681149-1-fc65c_1.jpg"
},
{
"attribute_code": "asn",
"value": "B00TBJXX2I"
},
{
"attribute_code": "msrp_display_actual_price_type",
"value": "0"
},
{
"attribute_code": "popular_product",
"value": "0"
},
{
"attribute_code": "tax_class_id",
"value": "2"
},
{
"attribute_code": "required_options",
"value": "0"
},
{
"attribute_code": "has_options",
"value": "0"
},
{
"attribute_code": "image_label",
"value": "final"
},
{
"attribute_code": "category_ids",
"value": [
"15",
"226",
"319",
"509",
"593",
"580",
"581",
"592",
"73",
"664",
"773"
]
},
{
"attribute_code": "small_image_label",
"value": "final"
},
{
"attribute_code": "thumbnail_label",
"value": "final"
},
{
"attribute_code": "sw_featured",
"value": "0"
},
{
"attribute_code": "product_image_size",
"value": "0"
},
{
"attribute_code": "model",
"value": "IFPZMB-BL0"
},
{
"attribute_code": "headphone_factor",
"value": "In Ear"
},
{
"attribute_code": "driver",
"value": "9mm"
},
{
"attribute_code": "impedance",
"value": "16 Ohms"
},
{
"attribute_code": "sensitivity",
"value": "89dB +/- 3dB"
},
{
"attribute_code": "microphone",
"value": "Yes"
},
{
"attribute_code": "compatible_device",
"value": "Mobile, Tablet, PC, Audio Player"
},
{
"attribute_code": "frequency",
"value": "20Hz - 20KHz"
},
{
"attribute_code": "audio_output_mode",
"value": "Stereo"
},
{
"attribute_code": "cable_cord",
"value": "1.2m"
},
{
"attribute_code": "connector_size",
"value": "3.5mm"
},
{
"attribute_code": "dimensions_lxbxh_cms",
"value": "10 x 5 x 19"
},
{
"attribute_code": "delivery_lead_time",
"value": "Dispatches Within 2 Business Days from Bangalore"
},
{
"attribute_code": "fireboltt_color",
"value": "314"
},
{
"attribute_code": "short_description",
"value": "<ul>\r\n<li><strong>High-Quality Audio:</strong> Enjoy clear & crisp sound that enhances your music experience</li>\r\n<li><strong>Built-in Microphone:</strong> Allows hands-free calls on the go</li>\r\n<li><strong>Comfortable Fit:</strong> Ergonomically designed earbuds ensure a secure and comfortable fit</li>\r\n<li><strong>Tangle-Free Cable:</strong> 1.25 metre tangle-resistant cable allows for easy storage</li>\r\n<li><strong>Compatibility:</strong> Works with mobile devices(smartphones and tablets)</li>\r\n<li><span class=\"a-list-item\"><strong>Connectivity Technology:</strong> Wired</span></li>\r\n<li><strong><span class=\"a-list-item\">Includes: </span></strong><span class=\"a-list-item\">Three sizes of ear tips (small, medium, large) for a customized fit</span></li>\r\n</ul>\r\n<p> </p>"
},
{
"attribute_code": "length",
"value": "8"
},
{
"attribute_code": "width",
"value": "3.5"
},
{
"attribute_code": "height",
"value": "8.5"
},
{
"attribute_code": "subcategory",
"value": "Earphone"
},
{
"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": "ZAGG international ,101, shannon industrial estate, Co.cleare,ireland"
},
{
"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": "22-Apr"
},
{
"attribute_code": "measure_of_commodity_in_package",
"value": "1"
},
{
"attribute_code": "package_length",
"value": "8.5"
},
{
"attribute_code": "package_width",
"value": "3.8"
},
{
"attribute_code": "package_height",
"value": "9.5"
},
{
"attribute_code": "package_weight",
"value": "0.06"
},
{
"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": "gtin",
"value": "848467025354"
},
{
"attribute_code": "colour_ondc",
"value": "Blue"
},
{
"attribute_code": "includes",
"value": "Extra Earbuds"
},
{
"attribute_code": "shipping_time",
"value": "2"
},
{
"attribute_code": "amazon_title",
"value": "iFrogz Audio - Ear Pollution I..."
},
{
"attribute_code": "amazon_price",
"value": "₹799.00"
},
{
"attribute_code": "amazon_image_url",
"value": "https://m.media-amazon.com/images/I/31hBypr0IkL.jpg"
},
{
"attribute_code": "total_reviews",
"value": "0"
},
{
"attribute_code": "amazon_rating",
"value": "4.2"
},
{
"attribute_code": "amazon_total_ratings",
"value": "14"
}
]
},
{
"id": 413,
"sku": "IFPZMB-RD0",
"name": "iFrogz Audio- Ear Pollution Plugz with Mic - Red",
"attribute_set_id": 15,
"price": 799,
"status": 1,
"visibility": 4,
"type_id": "simple",
"created_at": "2021-03-19 07:00:51",
"updated_at": "2024-12-26 05:11:26",
"weight": 0.04,
"extension_attributes": {
"website_ids": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
13,
14,
15,
16,
17
],
"category_links": [
{
"position": 0,
"category_id": "15"
},
{
"position": 0,
"category_id": "226"
},
{
"position": 0,
"category_id": "319"
},
{
"position": 0,
"category_id": "509"
},
{
"position": 0,
"category_id": "593"
},
{
"position": 0,
"category_id": "580"
},
{
"position": 0,
"category_id": "581"
},
{
"position": 0,
"category_id": "592"
},
{
"position": 0,
"category_id": "73"
},
{
"position": -2,
"category_id": "664"
},
{
"position": -1,
"category_id": "770"
}
],
"discount_percentage": 0.5
},
"product_links": [],
"options": [],
"media_gallery_entries": [
{
"id": 1344,
"media_type": "image",
"label": null,
"position": 1,
"disabled": false,
"types": [
"image",
"small_image",
"thumbnail",
"swatch_image"
],
"file": "/6/1/61n-ypl2hxl._sl1500__1__2.jpg"
},
{
"id": 1235,
"media_type": "image",
"label": null,
"position": 2,
"disabled": false,
"types": [],
"file": "/z/a/zagg-ifpzmb-rd0-in-ear-sdl988351352-1-27079.jpg"
},
{
"id": 1236,
"media_type": "image",
"label": null,
"position": 3,
"disabled": false,
"types": [],
"file": "/4/1/41p1rr3_u8l_1_3.jpg"
},
{
"id": 1237,
"media_type": "image",
"label": null,
"position": 4,
"disabled": false,
"types": [],
"file": "/7/1/715pzbmmv9l._sl1500__3.jpg"
},
{
"id": 1238,
"media_type": "image",
"label": null,
"position": 5,
"disabled": false,
"types": [],
"file": "/z/a/zagg-ifpzmb-rd0-in-ear-sdl988351352-2-8c05b.jpg"
}
],
"tier_prices": [],
"custom_attributes": [
{
"attribute_code": "split_by_brand",
"value": "Nothing"
},
{
"attribute_code": "special_price",
"value": "399.000000"
},
{
"attribute_code": "image",
"value": "/6/1/61n-ypl2hxl._sl1500__1__2.jpg"
},
{
"attribute_code": "url_key",
"value": "ifrogz-audio-ear-pollution-plugz-mobile-with-mike-red"
},
{
"attribute_code": "gift_message_available",
"value": "2"
},
{
"attribute_code": "hsncode",
"value": "8518"
},
{
"attribute_code": "special_from_date",
"value": "2024-12-05 00:00:00"
},
{
"attribute_code": "meta_title",
"value": "Ifrogz Audio- Ear pollution plugz mobile with mike-Red"
},
{
"attribute_code": "small_image",
"value": "/6/1/61n-ypl2hxl._sl1500__1__2.jpg"
},
{
"attribute_code": "options_container",
"value": "container2"
},
{
"attribute_code": "meta_keyword",
"value": "Ifrogz Audio- Ear pollution plugz mobile with mike-Red"
},
{
"attribute_code": "thumbnail",
"value": "/6/1/61n-ypl2hxl._sl1500__1__2.jpg"
},
{
"attribute_code": "meta_description",
"value": "Ifrogz Audio- Ear pollution plugz mobile with mike-Red "
},
{
"attribute_code": "swatch_image",
"value": "/6/1/61n-ypl2hxl._sl1500__1__2.jpg"
},
{
"attribute_code": "asn",
"value": "B00TBJXXXW"
},
{
"attribute_code": "msrp_display_actual_price_type",
"value": "0"
},
{
"attribute_code": "popular_product",
"value": "0"
},
{
"attribute_code": "tax_class_id",
"value": "2"
},
{
"attribute_code": "required_options",
"value": "0"
},
{
"attribute_code": "has_options",
"value": "0"
},
{
"attribute_code": "category_ids",
"value": [
"15",
"226",
"319",
"509",
"593",
"580",
"581",
"592",
"73",
"664",
"770"
]
},
{
"attribute_code": "sw_featured",
"value": "0"
},
{
"attribute_code": "product_image_size",
"value": "0"
},
{
"attribute_code": "model",
"value": "IFPZMB-RD0"
},
{
"attribute_code": "headphone_factor",
"value": "In Ear"
},
{
"attribute_code": "driver",
"value": "9mm"
},
{
"attribute_code": "impedance",
"value": "16 Ohms"
},
{
"attribute_code": "sensitivity",
"value": "89dB +/- 3dB"
},
{
"attribute_code": "microphone",
"value": "Yes"
},
{
"attribute_code": "compatible_device",
"value": "Mobile, Tablet, PC, Audio Player"
},
{
"attribute_code": "frequency",
"value": "20Hz - 20KHz"
},
{
"attribute_code": "audio_output_mode",
"value": "Stereo"
},
{
"attribute_code": "cable_cord",
"value": "1.2m"
},
{
"attribute_code": "connector_size",
"value": "3.5mm"
},
{
"attribute_code": "dimensions_lxbxh_cms",
"value": "10 x 5 x 19"
},
{
"attribute_code": "delivery_lead_time",
"value": "Dispatches Within 2 Business Days from Bangalore"
},
{
"attribute_code": "short_description",
"value": "<ul>\r\n<li><strong>High-Quality Audio:</strong> Enjoy clear & crisp sound that enhances your music experience</li>\r\n<li><strong>Built-in Microphone:</strong> Allows hands-free calls on the go</li>\r\n<li><strong>Comfortable Fit:</strong> Ergonomically designed earbuds ensure a secure and comfortable fit</li>\r\n<li><strong>Tangle-Free Cable:</strong> 1.25 metre tangle-resistant cable allows for easy storage</li>\r\n<li><strong>Compatibility:</strong> Works with mobile devices(smartphones and tablets)</li>\r\n<li><span class=\"a-list-item\"><strong>Connectivity Technology:</strong> Wired</span></li>\r\n<li><strong><span class=\"a-list-item\">Includes: </span></strong><span class=\"a-list-item\">Three sizes of ear tips (small, medium, large) for a customized fit</span></li>\r\n</ul>"
},
{
"attribute_code": "length",
"value": "17.5"
},
{
"attribute_code": "width",
"value": "6.9"
},
{
"attribute_code": "height",
"value": "8.5"
},
{
"attribute_code": "subcategory",
"value": "Earphone"
},
{
"attribute_code": "rateable",
"value": "0"
},
{
"attribute_code": "cancellable",
"value": "0"
},
{
"attribute_code": "returnable",
"value": "0"
},
{
"attribute_code": "seller_pickup_return",
"value": "0"
},
{
"attribute_code": "name_of_manufacturer",
"value": "ZAGG international"
},
{
"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": "Apr-22"
},
{
"attribute_code": "measure_of_commodity_in_package",
"value": "1"
},
{
"attribute_code": "package_length",
"value": "8.5"
},
{
"attribute_code": "package_width",
"value": "3.8"
},
{
"attribute_code": "package_height",
"value": "9.5"
},
{
"attribute_code": "package_weight",
"value": "0.06"
},
{
"attribute_code": "manufacturer_address",
"value": "ZAGG international ,101, shannon industrial estate, Co.cleare,ireland"
},
{
"attribute_code": "gtin",
"value": "848467025347"
},
{
"attribute_code": "colour_ondc",
"value": "Red"
},
{
"attribute_code": "includes",
"value": "Extra Earbuds"
},
{
"attribute_code": "shipping_time",
"value": "2"
},
{
"attribute_code": "amazon_title",
"value": "iFrogz Audio - Ear Pollution I..."
},
{
"attribute_code": "amazon_price",
"value": "₹799.00"
},
{
"attribute_code": "amazon_image_url",
"value": "https://m.media-amazon.com/images/I/31XsZo29c4L.jpg"
},
{
"attribute_code": "total_reviews",
"value": "0"
},
{
"attribute_code": "amazon_rating",
"value": "4.2"
},
{
"attribute_code": "amazon_total_ratings",
"value": "17"
}
]
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "store_id",
"value": "1",
"condition_type": "eq"
}
]
},
{
"filters": [
{
"field": "category_id",
"value": "73",
"condition_type": "eq"
}
]
},
{
"filters": [
{
"field": "type_id",
"value": "simple",
"condition_type": "eq"
}
]
}
],
"page_size": 2,
"current_page": 1
},
"total_count": 453
}1. Product Overview
id: The unique identifier for the product (e.g.,404).sku: Stock Keeping Unit, a unique code for identifying the product (IFPZMB-BL0).name: The product's name (iFrogz Audio - Ear Pollution Plugz with Mic - Blue).price: The price of the product (e.g.,799).type_id: Indicates the product type (e.g.,"simple"for standalone products).status: Availability status (1 = enabled).visibility: Controls how the product appears on the website (e.g.,4 = catalog and search).
2. Metadata
created_at: Timestamp of when the product was created.updated_at: Timestamp of the last update to the product details.weight: Product weight (0.04).
3. Extension Attributes
website_ids: List of website IDs where the product is available.category_links: Links the product to various categories with positions and category IDs.discount_percentage: Indicates if a discount applies (0.5).
4. Product Relationships
product_links:related: Products related to this product.crosssell: Products suggested during checkout.upsell: Premium versions or higher-priced alternatives.
5. Media Gallery Entries
media_gallery_entries: Contains images for the product.file: Path to the image.types: Image roles (e.g.,thumbnail,small_image).
6. Custom Attributes
Provides additional information about the product:
General Attributes:
split_by_brand: Brand name (Tinder).special_price: Discounted price (399).meta_title,meta_description: SEO metadata for search engines.url_key: URL slug for the product page.category_ids: Categories the product belongs to.
Technical Details:
frequency: Supported frequency range (e.g.,20Hz - 20KHz).sensitivity,impedance: Technical specs for audio quality.connector_size: Connector type (e.g.,3.5mm).
Dimensions and Weight:
length,width,height: Product dimensions.package_length,package_width,package_height: Packaging dimensions.
Additional Details:
gtin: Global Trade Item Number for product identification.microphone: Indicates if a microphone is included (Yes).includes: Additional items in the box (e.g.,Extra Earbuds).
7. Ratings and Reviews
total_reviews: Total number of reviews (0).amazon_rating: Average rating on Amazon (4.2).amazon_total_ratings: Total ratings on Amazon (14).
{
"message": "The \"%1\" attribute name is invalid. Reset the name and try again.",
"parameters": [
null
]
}Last updated