Cart Rule Detail

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

TIP

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

Endpoint

Endpoint	Method
/api/admin/marketing/cart-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 cart-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 or null
endsTill	string	End date or null
status	int	0 inactive / 1 active
couponType	int	0 auto-apply / 1 specific code
useAutoGeneration	int	1 when coupon codes are auto-generated
usagePerCustomer	int	Per-customer usage cap (0 = unlimited)
usesPerCoupon	int	Per-coupon usage cap (0 = unlimited)
timesUsed	int	Times the rule has applied (read-only)
conditionType	int	1 match all conditions / 0 match any
conditions	array	Cart / product filters
actionType	string	by_percent, by_fixed, cart_fixed, buy_x_get_y
discountAmount	number	Discount value (capped at 100 for by_percent)
discountQuantity	int	Quantity for buy_x_get_y
discountStep	string	Step for buy_x_get_y
applyToShipping	int	1 applies the discount to shipping
freeShipping	int	1 grants free shipping
endOtherRules	int	1 stops lower-priority rules from also applying
usesAttributeConditions	int	1 when conditions use product attributes
sortOrder	int	Priority — lower runs first
couponCode	string	Primary coupon code (null when the rule has no coupon)
channels	int[]	Channel ids the rule applies to
customerGroups	int[]	Customer-group ids the rule applies to
createdAt	string	Creation timestamp
updatedAt	string	Last-update timestamp