Object Index / Definition

You are viewing an old version of the API

2019-11-20

Version 2019-11-20

• All Versions

Order​Return​Discount

The total declared monetary amount of the discount.

amount_money is not set for percentage-based discounts.

The amount of discount actually applied to this line item. 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.

The catalog object id referencing CatalogDiscount.

The discount's name.

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%.

percentage is not set for amount-based discounts.

Indicates the level at which the OrderReturnDiscount applies. For ORDER scoped discounts, the server will generate references in applied_discounts on all OrderReturnLineItems. For LINE_ITEM scoped discounts, the discount will only apply to OrderReturnLineItems with references in their applied_discounts field.

uid of the Discount from the Order which contains the original application of this discount.

The type of the discount. If it is created by API, it would be either FIXED_PERCENTAGE or FIXED_AMOUNT.

Discounts that don't reference a catalog object ID must have a type of FIXED_PERCENTAGE or FIXED_AMOUNT.

Unique ID that identifies the return discount only within this order.