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.

Operation

Operation	Type	Purpose
adminMarketingCatalogRule	Query	Fetch one catalog rule by id

Details

• Requires an admin Bearer token in the Authorization header.
• Pass the rule's IRI (e.g. /api/admin/marketing/catalog-rules/126) as the id argument; _id in the response is the numeric id.
• Unlike list rows, the detail query resolves conditions, channels, and customerGroups — the per-rule targeting and price-filter data.
• channels and customerGroups are connections — sub-select { edges { node { id _id code name } } }. Each node is the channel / customer-group it targets.

Fields

Field	Type	Notes
id	ID	The rule's IRI
_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	Float	Discount value (capped at 100 for by_percent)
channels	Connection	Channels the rule applies to — edges { node { id _id code name } }
customerGroups	Connection	Customer groups the rule applies to — edges { node { id _id code name } }
createdAt	String	Creation timestamp
updatedAt	String	Last-update timestamp