Actions25
- Store Actions
- Product Actions
- Category Actions
- Variation Actions
- Brand Actions
- Coupon Actions
- Report Actions
- Engage Profile Actions
- Engage Unsubscribe Actions
- Search Actions
Category → List
AI-generatedSummary
List categories with sales metrics within a specified date range, optionally supporting pagination, sorting, and keyword search.
Inputs
- Start Date (required) — Start date in YYYY-MM-DD format (store timezone) for filtering the categories.
- End Date (required) — End date in YYYY-MM-DD format (store timezone) for filtering the categories.
- Additional Options — Optional parameters including page number for pagination, results per page (max 100), sorting field (order by), sorting direction (ascending or descending), and a search keyword to filter categories by name.
Output shape
a list of category records with sales metrics
The API returns an array of category objects matching the filtered criteria. Pagination and sorting are supported via additional options. If no categories match, an empty array is returned. Errors will cause the node to fail or return an error object if 'continue on fail' is enabled.
Examples
Example 1: List categories from April 1, 2026, to April 4, 2026, returning 25 categories per page sorted descending by creation date with optional search filtering.
Set Start Date to '2026-04-01', End Date to '2026-04-04', Additional Options with per_page=25, order_by='product_created_at', order_dir='desc', and optionally a search keyword to filter by category name.