Object Index / Definition

You are viewing an old version of the API
Order​Return

Beta

The set of line items, service charges, taxes, discounts, tips, etc

being returned in an Order.

Properties

Name Description
return_amounts
Order​Money​Amounts

Aggregate monetary value being returned by this Return entry.

return_discounts
Order​Return​Discount [ ]

Collection of references to discounts being returned for an order, including the total applied discount amount to be returned. The discounts must reference a top-level discount ID from the source order.

return_line_items
Order​Return​Line​Item [ ]

Collection of line items which are being returned.

return_service_charges
Order​Return​Service​Charge [ ]

Read only Collection of service charges which are being returned.

return_taxes
Order​Return​Tax [ ]

Collection of references to taxes being returned for an order, including the total applied tax amount to be returned. The taxes must reference a top-level tax ID from the source order.

rounding_adjustment
Order​Rounding​Adjustment

A positive or negative rounding adjustment to the total value being returned. Commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency.

source_order_id
string

Order which contains the original sale of these returned line items. This will be unset for unlinked returns.

uid
string

Unique ID that identifies the return only within this order.

Max Length 60

Share Feedback

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