Actions25
- Product Actions
- Category Actions
- Customer Actions
- Order Actions
- Inventory Actions
- Store Actions
Category → List
AI-generatedSummary
List categories with searchCriteria support.
Inputs
- searchCriteria — Build searchCriteria for filtering, sorting, pagination, and optional field selection.
- websiteCode — Store view code for multi-store Magento instances (used in URL like /rest/{code}/V1/...).
- simplifyOutput — When enabled, flattens the response structure, converting custom_attributes to an object and flattening extension_attributes.
Output shape
Magento API response as JSON, typically containing items, total_count, page_size, and current_page.
When simplifyOutput is true, response is processed by flattenResponse which converts custom_attributes arrays to objects, flattens extension_attributes into top-level keys, and simplifies nested structures.
Examples
Example 1: Basic list
Leave searchCriteria empty; returns all categories with pagination defaults (pageSize=20, currentPage=1).
Example 2: Filtered list
Set searchCriteria.filterGroups with a filter on 'name' using condition 'Like' and value 'Electronics'; sets sortOrders to sort by 'position' ASC; sets pageSize to 10.