Object Index / Definition

You are viewing an old version of the API
OrderReturnDiscount

Beta

Represents a discount being returned that applies to one or more return line items in an order.

Properties

Name Description
uid
string

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

Max Length 60
source_discount_uid
string

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

Max Length 60
catalog_object_id
string

The catalog object id referencing CatalogDiscount.

Max Length 192
name
string

The discount's name.

Max Length 255
type
string

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. See OrderLineItemDiscountType for possible values

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

percentage is not set for amount-based discounts.

Max Length 10
amount_money
Money

The total declared monetary amount of the discount.

amount_money is not set for percentage-based discounts.

applied_money
Money

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.

scope
string

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. See OrderLineItemDiscountScope for possible values

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?