Catalog Rule Detail

Returns a single catalog rule with its full field set — the data behind the admin Marketing → Promotions → Catalog Rules view screen.

TIP

New here? Read the Catalog Rules overview for what a catalog rule does and how its fields behave.

Endpoint

Endpoint	Method
/api/admin/marketing/catalog-rules/{id}	GET

Details

• Requires an admin Bearer token in the Authorization header.
• Unlike list rows, the detail endpoint returns conditions, channels, and customerGroups — the per-rule targeting and price-filter data.
• An unknown id returns a 404.

Response fields

Field	Type	Notes
id	int	Numeric id
name	string	Rule name
description	string	Free-text description
startsFrom	string	Start date (YYYY-MM-DD) or null
endsTill	string	End date (YYYY-MM-DD) or null
status	int	0 inactive / 1 active
sortOrder	int	Priority — lower runs first
conditionType	int	1 match all conditions / 0 match any
conditions	array	Product-attribute filters
endOtherRules	int	1 stops lower-priority rules from also applying
actionType	string	by_percent, by_fixed, to_percent, to_fixed
discountAmount	number	Discount value (capped at 100 for by_percent)
channels	object[]	Channels the rule applies to — each { id, code, name }
customerGroups	object[]	Customer groups the rule applies to — each { id, code, name }
createdAt	string	Creation timestamp
updatedAt	string	Last-update timestamp