Object Index
You are viewing an old version of the API
OrderReturnDiscount
BETA
Object Index
Represents a discount being returned that applies to one or more return line items in an order.
Fixed-amount, order-scoped discounts are distributed across all non-zero return line item totals. The amount distributed to each return line item is relative to that item’s contribution to the order subtotal.
Properties
Name | Description |
---|---|
uid
|
Unique ID that identifies the return discount only within this order. |
source_
|
|
catalog_
|
The catalog object id referencing CatalogDiscount. |
name
|
The discount's name. |
type
|
The type of the discount. If it is created by API, it would be either Discounts that don't reference a catalog object ID must have a type of
|
percentage
|
The percentage of the tax, as a string representation of a decimal number.
A value of
|
amount_
|
The total declared monetary amount of the discount.
|
applied_
|
The amount of discount actually applied to this line item. When an amount-based
discount is at order-level, this value is different from |
scope
|
Indicates the level at which the |