Represents a discount that applies to one or more line items in an order. Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal.
| Name | Type | Description | Notes |
|---|---|---|---|
| catalogObjectId | String | The catalog object id referencing CatalogDiscount. | [optional] |
| name | String | The discount's name. | [optional] |
| type | TypeEnum | The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See OrderLineItemDiscountType for possible values | [optional] |
| percentage | String | The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount. | [optional] |
| amountMoney | Money | The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount. The amount_money won't be set for a percentage-based discount. | [optional] |
| appliedMoney | Money | The amount of discount actually applied to this line item. Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items. | [optional] |
| scope | ScopeEnum | Indicates the level at which the discount applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See OrderLineItemDiscountScope for possible values | [optional] |
| Name | Value |
|---|---|
| UNKNOWN_DISCOUNT | "UNKNOWN_DISCOUNT" |
| FIXED_PERCENTAGE | "FIXED_PERCENTAGE" |
| FIXED_AMOUNT | "FIXED_AMOUNT" |
| VARIABLE_PERCENTAGE | "VARIABLE_PERCENTAGE" |
| VARIABLE_AMOUNT | "VARIABLE_AMOUNT" |
| Name | Value |
|---|---|
| OTHER_DISCOUNT_SCOPE | "OTHER_DISCOUNT_SCOPE" |
| LINE_ITEM | "LINE_ITEM" |
| ORDER | "ORDER" |