Reading discounts on the order
Show a customer which discount reduced what, rather than a single lump sum.
{% set advancedAdjustments = cart.adjustments|filter(
adjustment => adjustment.sourceSnapshot.advancedDiscountId ?? false
) %}
The plugin does not change prices. Every discount it applies is a Commerce order adjustment, so the order keeps its original subtotal, shipping cost, and tax lines. Each adjustment has a snapshot describing the rule that produced it.
Finding this plugin’s adjustments#
Commerce’s own discounts also use the adjustment type discount, so filtering on type alone mixes the two together. Every adjustment from this plugin has advancedDiscountId in its source snapshot. Commerce’s own discount adjustments do not set it.
cart.adjustments returns every adjustment on the order, including those attached to line items. lineItem.adjustments returns only that line item’s.
If the filtered adjustments do not add up to the order’s total discount, another discount, such as one of Commerce’s own, applies to the order. To see every adjustment, drop the filter.
Example#
- Loop over the line items and show each line’s own adjustments from the plugin.
- Show the order-level adjustments from the plugin, the ones without a
lineItemId.
{% for lineItem in cart.lineItems %}
<p>{{ lineItem.description }}: {{ lineItem.subtotal|commerceCurrency(cart.currency) }}</p>
{% for adjustment in lineItem.adjustments|filter(
adjustment => adjustment.sourceSnapshot.advancedDiscountId ?? false
) %}
<p>
{{ adjustment.name }}: {{ adjustment.amount|commerceCurrency(cart.currency) }}
({{ adjustment.sourceSnapshot.discountValue }}{{ adjustment.sourceSnapshot.discountType == 'percentage' ? '%' }})
</p>
{% endfor %}
{% endfor %}
{% for adjustment in cart.adjustments|filter(
adjustment => (adjustment.sourceSnapshot.advancedDiscountId ?? false) and adjustment.lineItemId is null
) %}
<p>{{ adjustment.name }}: {{ adjustment.amount|commerceCurrency(cart.currency) }}</p>
{% endfor %}
The snapshot#
| Key | Value |
|---|---|
advancedDiscountId |
ID of the discount that produced the adjustment. |
rule |
Which cart action ran: order, shipping, lineItem, or bogo. |
discountType |
flatAmount or percentage. |
discountValue |
The number set on the action. A percentage of 10 means 10%. |
requireCouponCode |
Whether the discount is gated behind a code. |
couponCode |
The code the customer entered, or null when the discount is not gated. |
discountedPurchasableIds |
The purchasables the adjustment covers. Absent on shipping. |
Two more fields come from the adjustment itself rather than the snapshot:
amountis negative. Add it to a running total rather than subtracting it.nameis the group’s Discount Name, or the discount’s own name when the group does not set one. When a group holds more than one cart action, each adjustment name ends with its rule label, such asSummer Sale: Item SubtotalandSummer Sale: Shipping.
Where each rule attaches#
order and shipping adjustments belong to the order. lineItem and bogo adjustments belong to a line item and set lineItemId. They appear in both cart.adjustments and that line item’s own adjustments.
A per-line breakdown reads lineItem.adjustments. A cart summary reads the order-level ones, as in the example.
Showing the coupon that was used#
couponCode is set only on adjustments from a discount with Require Coupon Code on. On an ungated sale it is null:
{% for adjustment in advancedAdjustments|filter(adjustment => adjustment.sourceSnapshot.couponCode) %}
<p>Code {{ adjustment.sourceSnapshot.couponCode }}: {{ adjustment.name }}</p>
{% endfor %}
An order has one coupon code at most, so every gated adjustment on an order repeats the same value.
Tax#
The Tax Basis setting decides whether the plugin’s adjustments are applied before or after tax. With Before discounts, the plugin adds its adjustments after tax is calculated. See the configuration reference.