Returns

Lists returns associated with orders, including statuses and dispositions.

Table-Specific Information

Select

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

OrderId supports the '=, IN' comparison operators.

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

  SELECT * FROM Returns WHERE OrderId = 'Val1'

Insert

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

OrderId, ReturnLineItems (references ReturnLineItems), ReturnExchangeLineItems (references ReturnExchangeLineItems)

ReturnLineItems Temporary Table Columns


Column Name	Type	Description
Quantity	Int	The quantity being returned.
ReturnReasonDefinitionId	String	The return reason definition id.
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 for the return record.
OrderId	String	True	Orders.Id	A globally-unique ID.
OrderReturnStatus	String	True		The order's aggregated return status for display purposes. The allowed values are IN_PROGRESS, INSPECTION_COMPLETE, NO_RETURN, RETURN_FAILED, RETURN_REQUESTED, RETURNED.
Name	String	True		The system-generated name of the return.
Status	String	True		The current status of the return (for example, open, approved, or declined).
TotalQuantity	Int	True		The total number of line item units included in the return.
DeclineReason	String	True		The reason the return request was declined.
DeclineNote	String	True		The message sent to the customer when their return request was declined. Maximum length: 500 characters.
ReturnLineItems	String	True		A list of the line items that are part of the return.
ReturnExchangeLineItems	String	True		A list of new line items to be added to the order as part of an exchange.
ClosedAt	Datetime	True		The date and time when the return was closed.
CreatedAt	Datetime	True		The date and time when the return was created.
RequestApprovedAt	Datetime	True		The date and time when the return was approved.