Discount Application Allocation Method
Controls how a discount's value is distributed across entitled lines. A discount can either spread its value across all entitled lines or apply the full value to each line individually.
Used by the interface and its implementations to capture the intentions of a discount source at the time of application.
Anchor to Valid valuesValid values
- ACROSS
- EACH
- ONE: deprecated
- Anchor to ACROSSACROSS
The value is spread across all entitled lines.
- Anchor to EACHEACH
The value is applied onto every entitled line.
- •Deprecated
Anchor to FieldsFields
- Anchor to AutomaticDiscountApplication.allocationMethodAutomatic•OBJECT
Discount Application.allocationMethod An automatic discount applied to a cart or checkout without requiring a discount code. Implements the
interface.Includes the discount's title, value, and allocation details that specify how the discount amount distributes across entitled line items or shipping lines.
- •OBJECT
Captures the intent of a discount source at the time it was applied to a cart. This includes the discount value, how it's allocated across entitled items, and which line types it targets.
The actual discounted amounts on specific cart lines are represented by
objects, which reference this application.- •INTERFACE
Captures the intent of a discount at the time it was applied. Each implementation represents a different discount source, such as automatic discounts, discount codes, and manual discounts.
The actual discounted amount on a line item or shipping line is represented by the
object, which references the discount application it originated from.- •OBJECT
Records the configuration and intent of a discount code when a customer applies it. This includes the code string, allocation method, target type, and discount value at the time of application. The
applicablefield indicates whether the code was successfully applied.NoteNote: To see the actual amounts discounted on specific line items or shipping lines, use the <a href="https://shopify.dev/docs/api/storefront/current/objects/DiscountAllocation"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Allocation</span></code></a> object instead.
- •OBJECT
A discount created manually by a merchant, as opposed to automatic discounts or discount codes. Implements the
interface and includes a title, optional description, and the discount value as either a fixed amount or percentage.- •OBJECT