Returns

Retrieves a list of returns for the order.

Table-Specific Information

Select

The driver uses the Shopify API to process WHERE clause conditions built with the following column and operators. The driver processes other filters client-side within the driver.

OrdersId supports the '=, IN' comparison operators.

For example, the following query is processed server-side:

  SELECT * FROM Returns WHERE OrdersId = 'Val1'

Insert

The following columns can be used to create a new record:

OrdersId, ReturnLineItems (references ReturnLineItems), ReturnExchangeLineItems (references ReturnExchangeLineItems)

ReturnLineItems Temporary Table Columns


Column Name	Type	Description
Quantity	Int	The quantity being returned.
ReturnReason	String	The reason for returning the item.
ReturnReasonNote	String	Additional information about the reason for the return. Maximum length: 255 characters.
FulfillmentLineItemId	String	A globally-unique ID.

ReturnExchangeLineItems Temporary Table Columns


Column Name	Type	Description
VariantId	String	A globally-unique ID.
Quantity	Int	The number of variant units ordered.
AppliedDiscountValueAmount	Decimal	The discount to be applied to the exchange line item. The value of the discount as a fixed amount.
AppliedDiscountValueAmountCurrencyCode	String	The discount to be applied to the exchange line item. Currency of the money.
AppliedDiscountValuePercentage	Double	The discount to be applied to the exchange line item. The value of the discount as a percentage.
AppliedDiscountDescription	String	The discount to be applied to the exchange line item. The description of the discount.
GiftCardCodes	String	The gift card codes associated with the physical gift cards.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A globally-unique ID.
OrdersId	String	True	Orders.Id	A globally-unique ID.
Name	String	True		The name of the return.
Status	String	True		The status of the return.
TotalQuantity	Int	True		The sum of all line item quantities for the return.
DeclineReason	String	True		The reason the customer's return request was declined.
DeclineNote	String	True		The notification message sent to the customer about their declined return request. Maximum length: 500 characters.
ReturnLineItems	String	True		The list of the line items in the return.
ReturnExchangeLineItems	String	True		The new line items to be added to the order.