stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > ScriptDiscountApplication

AdminTypes.ScriptDiscountApplication interface

Script discount applications capture the intentions of a discount that was created by a Shopify Script for an order’s line item or shipping line.

Discount applications don’t represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.

Signature:

export interface ScriptDiscountApplication extends DiscountApplication 

Extends: DiscountApplication

Properties

Property Modifiers Type Description
allocationMethod   DiscountApplicationAllocationMethod | `${DiscountApplicationAllocationMethod}` The method by which the discount’s value is applied to its entitled items.
description   Scalars[‘String’][‘output’] The description of the application as defined by the Script.
index   Scalars[‘Int’][‘output’] An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
targetSelection   DiscountApplicationTargetSelection | `${DiscountApplicationTargetSelection}` How the discount amount is distributed on the discounted lines.
targetType   DiscountApplicationTargetType | `${DiscountApplicationTargetType}` Whether the discount is applied on line items or shipping lines.
title   Scalars[‘String’][‘output’] The title of the application as defined by the Script.
value   PricingValue The value of the discount application.