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,store_pickup_only&brand=YourBrand1|YourBrand2&search=meta key&includeChildren&pageSize=2&pageNum=1
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 products within the PIMS system, 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 endpoints 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
This endpoint is especially useful for those who need quick access to a list of all available products in the system, and is a valuable tool for developers and other users wishing to create applications or analyze product-related data.
Request
Responses
- 200
success