OrderDiscountApplications
Returns a list of discounts that are applied to the order, not including order edits and refunds.
View-Specific Information
Select
The cmdlet uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The cmdlet processes other filters client-side within the cmdlet.
- OrderId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM OrderDiscountApplications
SELECT * FROM OrderDiscountApplications WHERE OrderId = 'Val1'
Columns
| Name | Type | References | Description |
| OrderId [KEY] | String |
Orders.Id | A globally-unique ID. |
| AllocationMethod | String | The method by which the discount's value is applied to its entitled items. | |
| Index [KEY] | Int | An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations. | |
| TargetSelection | String | How the discount amount is distributed on the discounted lines. | |
| TargetType | String | Whether the discount is applied on line items or shipping lines. | |
| ValueAmount | Decimal | The value of the discount application. Decimal money amount. | |
| ValueCurrencyCode | String | The value of the discount application. Currency of the money. | |
| ValuePercentage | Double | The value of the discount application. The percentage value of the object. This is a number between -100 (free) and 0 (no discount). | |
| AutomaticDiscountApplicationTitle | String | The title of the discount application. | |
| DiscountCodeApplicationCode | String | The string identifying the discount code that was used at the time of application. | |
| ManualDiscountApplicationTitle | String | The title of the discount application. | |
| ManualDiscountApplicationDescription | String | The description of the discount application. | |
| ScriptDiscountApplicationTitle | String | The title of the discount application. |