Return View

The Return view provides dimensions and measures related to returned items, refunds, and replacements.

The measures calculated by this view are:

NameMeasure TypeDescription
Average Product Loss TotalAverageAverage of total product loss for all returns.
Average Return LossAverageAverage of the sum of total product loss and total shipping loss.
Average Refund AmountAverageAverage of refund amount for all returns.
Average Shipping Loss TotalAverageAverage of of shipping loss total for all returns.
Returned Order CountCountCount of all orders with an associated return.
Return CountCountCount of all returns.
Total Product Loss TotalSumSum of product loss total for all returns.
Total Refund AmountSumSum of refund amount for all returns.
Total Return LossSumSum of total product loss and total shipping loss.
Total Shipping Loss TotalSumSum of shipping loss total for all returns.

The dimensions included in this view are:

NameData TypeDescription
Channel CodeStringCode that identifies the channel associated with the site for the shopper's return.
Contact Address 1StringAddress line one for the contact for the return.
Contact Address 2StringAddress line two for the contact for the return.
Contact Address 3StringAddress line three for the contact for the return.
Contact Address 4StringAddress line four for the contact for the return.
Contact CityStringCity provided in the contact address for the return.
Contact Country CodeStringCountry code provided in the contact address for the return.
Contact Postal CodeStringPostal or zip code provided in the contact address for the return.
Contact State/ProvinceStringState or province provided in the contact address for the return.
Currency CodeStringThe localized currency code for the monetary amount.
Customer Account IDStringInternal unique identifier of the customer account.
Customer EmailStringEmail address provided by the user when submitting the order.
Customer First NameStringThe first name of the customer.
Customer Interaction TypeStringThe type of customer interaction used to create the return. Possible values are Website, Call, Store, or Unknown.
Customer Last NameStringThe last name of the customer.
Customer User IDStringInternal unique identifier of the customer account. If the shopper user is anonymous, the user ID represents a system-generated user ID string.
Location CodeStringThe unique user-defined code that identifies the location where the products are returned.
Original Order IDStringIf this return is associated with a previously completed order, the internal unique identifier of the original order.
Original Order NumberStringThe order number of the original order where the return was created.
Product Loss TotalNumberThe total value of the product returned to the merchant for accounting purposes, calculated by multiplying the cost of the item by its quantity returned.
Receive StatusStringThe status that indicates whether the merchant has received the return item from the shopper. The accepted values are "Not requested," "Received," or "Waiting."
Refund AmountNumberIf a refund action was performed for this return, the total amount refunded to the shopper. The refund amount can differ from the sum of the price of the returned items.
Refund StatusStringThe status of the refund. The accepted values are "Not requested" if the shopper only wants a replacement or "Refunded" if either a partial or full refund is applied to the return.
Replace StatusStringThe status of the replacement order. The accepted values are "Not requested" if there is no replacement order or "Replaced" if a replacement order exits.
Return Created DateDatetimeThe timestamp of the date and time the return was created.
Return IDStringThe internal unique identifier of the return.
Return NumberStringA merchant-specific identifier used to sequentially order returns.
Return StatusStringThe current status of the return. Valid values for this field are Active, Expired, and Inactive.
Return TypeStringThe type of return, which is Refund or Replace. At the top-level return level, this field is deprecated because Refund and Replace items can now be mixed within a single return. For backwards-compatibility with older applications, the field defaults to Replace.
Return Updated DateDatetimeThe timestamp of the date and time the return was most recently updated.
Shipping Loss TotalNumberThe total value of shipping the returned product to the merchant for accounting purposes, calculated by multiplying the shipping cost of the item by its quantity returned.
Site IDNumberUnique identifier for the site. This ID is used at all levels of a store and catalog to associate objects to a site.
Site NameStringThe human readable name for the site associated with the Site ID.