• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
OrderReturn BETA

The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.

Properties

Name Description
uid
string

A unique ID that identifies the return only within this order.

Max Length 60
source_order_id
string

An order that contains the original sale of these return line items. This is unset for unlinked returns.

return_line_items
OrderReturnLineItem [ ]

A collection of line items that are being returned.

return_service_charges
OrderReturnServiceCharge [ ]

Read only A collection of service charges that are being returned.

return_taxes
OrderReturnTax [ ]

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

return_discounts
OrderReturnDiscount [ ]

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

rounding_adjustment
OrderRoundingAdjustment

A positive or negative rounding adjustment to the total value being returned. Adjustments are commonly used to apply cash rounding when the minimum unit of the account is smaller than the lowest physical denomination of the currency.

return_amounts
OrderMoneyAmounts

An aggregate monetary value being returned by this return entry.

Share Feedback

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