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. Each filterGroups element contains an array of filters.

  • 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

  1. Filter Group 0

    • Field: store_id Filters products based on the store ID.

    • Value: 41 Only products associated with store ID 41 are retrieved.

  2. Filter Group 1

    • Field: type_id Filters products based on their type.

    • Value: simple Retrieves only products of type simple.


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.

Responses

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 and updated_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 and cancellable: Flags indicating whether the product can be returned or canceled.

Error Responses

Last updated