Admin Marketing: Promotions
List catalog rules
Filters: name (LIKE), status. Sort: id (default desc), name, sort_order.
get/marketing/catalog-rules
Request
- Base URLhttp://localhost:8000/api/admin
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger
Example:1
Page number.
per_pageinteger
Example:10
Items per page (default 10, max 50).
idstring
Filter by ID (single or comma-separated).
namestring
Partial name match.
statusinteger
Enabled flag (0/1).
sort_orderinteger
Filter by priority (sort_order, exact).
starts_from_fromstring date-time
Start date >= (ISO 8601).
starts_from_tostring date-time
Start date <= (ISO 8601).
ends_till_fromstring date-time
End date >= (ISO 8601).
ends_till_tostring date-time
End date <= (ISO 8601).
sort'id' | 'name' | 'sort_order'
Sort column.
order'asc' | 'desc'
Sort direction.
Response
Paginated list in the { data, meta } envelope. conditions / channels / customerGroups are detail-only and null on list rows.
Changes
No recorded changes to this operation across all 8 revisions of this API.