GET a list of products in the specified category, including subcategories, and filter by the specified attributes
GET/v/cpc/:categoryId
- Requires Data Viewer ApiKey permissions.
- Example URI: https://instancename.piminto.com/api/en-us/v/cpc/3/?filters=brand,price&brand=YourBrand1|YourBrand2&price=100.00;;1000.00&search=metakey&includeChildren=true&pageSize=2&pageNum=1
NOTE: This endpoint retrieves a list of active products that are associated with active categories. It is designed specifically for integration with web stores, ensuring that only currently available and relevant products are displayed to end-users.
Ideal for storefronts or catalog pages that need to dynamically load and display products that are currently being sold and belong to categories that are visible/enabled.
This API endpoint allows you to retrieve a list of all available PIMS products in the system or select products within a specific category, including subcategories. You can also filter these products based on attribute values or search phrases within attribute values.
- If you want to retrieve all available products across all active categories, set the category identifier to "0".
- To include subcategories in the displayed list of items, set the includeChildren parameter to true.
- To include all variants sku products in the displayed list of items, set the includeVariants parameter to true.
- For filtering results based on attribute values, provide the attribute name and its corresponding value. You can apply multiple filters simultaneously.
- Use the search parameter to search for products based on a specified search phrase. The search is conducted across all words within the phrase.
Returns
The endpoint returns detailed information about products that belong to the corresponding category and have attributes with specified filter values, along with comprehensive details about the indicated category and structured data of its child categories
Request
Responses
- 200
success