Refunds Table

The Refunds table captures detailed information on each refund transaction, encompassing event dates, the original order details, product information, and refund specifics. By querying this table, you can analyze refund patterns, understand the impact of refunds on inventory, and evaluate the reasons behind product returns or order cancellations.

📘

Note

event_date is a required field for queries on this table, and refers to the date of the refund.

Dimensions

Dimensions are immutable properties that can be used for grouping data.

Title

ID

Type

Description

Event Date

event_date

date

The date the refund was processed. Based on the time zone of the shop at the moment of refund.

Event Day

event_date.day

date

The day on which the event occurred. Derived from event_date.

Event Week

event_date.week

date

The Sunday of the week during which the event occurred. Derived from event_date.

Event Month

event_date.month

date

The month during which the event occurred. Derived from event_date.

Event Quarter

event_date.quarter

date

The first month of the quarter during which the event occurred. Derived from event_date.

Event Year

event_date.year

date

The year during which the event occurred. Derived from event_date.

Event Hour

event_hour

string

The hour of the day the refund was processed, according to a 24-hour clock. Based on the time zone of the shop at the time the refund was issued.

Example values: 07, 16, 21

Order Date

order_date

date

The date the original order was processed. Based on the time zone of the shop at the moment of purchase.

Order ID

order_id

string

The unique ID for the original order that was issued a refund. Assigned by the shop platform.

Example value: 6024492815432

Sales Platform

platform

string

The sales platform where the order was processed.

Example values: Shopify, BigCommerce, WooCommerce, Amazon

Products

products_info

record repeated

Details about the products associated with the order (at the level of the variant), including name, product ID, variant ID, type, SKU, etc.

Product ID

products_info.product_id

string

The unique ID of the product as set within the main sales platform.

Example value: 3891505496131

Product Name

products_info.product_name

string

The name of the product as set within the main sales platform.

Example values: Green Soft Socks 3-Pack, Paring Knife Travel Case, Gift Subscription

Product Type

products_info.product_type

string

The product type as set within the main sales platform.

Example values: Jackets, Coffee Mugs, Books

Product SKU

products_info.product_sku

string

The SKU (Stock Keeping Unit) for the product, as set within the main sales platform.

Example values: GP-BACK-02, A02630, POP200NAVY

Product Variant ID

products_info.variant_id

string

The unique identifier for a specific variant of a product as set within the main sales platform.

Example value: 29275946877001

Is Gift Card

products_info.is_gift_card

boolean

True if the product purchased is a gift card.

Possible values: true, false

Product Price

products_info.product_name_price

numeric

The price of a single product (to the buyer), before discounts. By default shown in the shop's currency.

Note: Tax will be included in the product price if the seller has configured the sale to require taxes in the main sales platform.

Product Discount

products_info.discount_amount_for_product

numeric

The amount discounted from the product price. By default shown in the shop's currency.

Product Units Sold

products_info.product_name_quantity_sold

numeric

The total number of individual units sold for the product.

Product Cost

products_info.single_product_cost

numeric

The cost of a single product (to the seller). By default shown in the shop's currency.

Refund Line Item

refund_line_item

record repeated

Information about the refund(s) issued. There may be multiple refunds per order.

Refund Line Item ID

refund_line_item.refund_line_item_id

string

The unique ID for the refunded line item. Assigned by the shop platform.

Example value: 558610612293

Order Line Item ID

refund_line_item.line_item_id

string

The unique ID for the line item in the original order, that is associated with the refunded line item. Assigned by the shop platform.

Example value: 14883345367111

Is Gift Card

refund_line_item.gift_card

boolean

True if the line item refunded is a gift card.

Product ID

refund_line_item.product_id

string

The unique ID of the product as set within the main sales platform.

Example value: 3891505496131

Variant ID

refund_line_item.variant_id

string

The unique identifier for a specific variant of a product as set within the main sales platform.

Example value: 29275946877001

Is Tax-Inclusive

refund_line_item.taxes_included

boolean

True if taxes are included in the refunded line item.

Restock Type

refund_line_item.restock_type

string

How the refund line item affects inventory.

Valid values:
no_restock: Not restocked.
cancel: Canceled and possibly restocked if unfulfilled.
return: Returned and restocked if fulfilled.
legacy_restock: Deprecated. Used for general restocking.

Refund Line Item Product Quantity

refund_line_item.quantity

numeric

The quantity of products in the refunded line item.

Refund Line Item Discount Amount

refund_line_item.total_discount

numeric

The total discount amount applied to the refunded line item.

Refund Line Item Subtotal

refund_line_item.subtotal

numeric

The subtotal of the refunded line item before taxes and discounts.

Refund Line Item Pre-Tax Price

refund_line_item.pre_tax_price

numeric

The price of the refunded line item after discounts but before taxes.

Refund Line Item Tax Amount

refund_line_item.total_tax

numeric

The total tax amount for the refunded line item.

Refund Line Item Price

refund_line_item.price

numeric

The price of the refunded line item, after taxes and discounts.

Refund Line Item Single Product Cost

refund_line_item.refunded_cogs_per_item

numeric

Cost of goods refunded per item. If refund_line_item.restock_type is no_restock, the cost is 0.

Refund Line Item Cost

refund_line_item. refunded_cogs_per_line_item

numeric

Cost of goods refunded for the entire line item (which may contain multiple units). If refund_line_item.restock_type is no_restock, the cost is 0.

Refund Order Adjustments

refund_order_adjustment

record repeated

List of refund order adjustments applied to the order. There may be multiple adjustments per order.

Order Adjustment Type

refund_order_adjustment.kind

string

The order adjustment type.

Valid values:
shipping_refund: Refunds related to shipping charges. refund_discrepancy: Discrepancies in the refund amount.

Order Adjustment Tax Amount

refund_order_adjustment. order_adjustment_tax_amount

numeric

The taxes that are added to the order adjustment amount, such as applicable shipping taxes added to a shipping refund.

Order Adjustment Amount

refund_order_adjustment. order_adjustment_amount

numeric

The value of the discrepancy between the calculated refund and the actual refund. If the kind property's value is shipping_refund, then amount returns the value of shipping charges refunded to the customer.

Source

source_name

string

The origin of the order as designated by the seller on the main sales platform.

Example values: web, pos, tiktok

Tags

tags

repeated string

Tags associated with the order, assigned by the seller on the main sales platform.

Example values: Upsell, Order Credits, discount_eligible

Updated At

updated_at

timestamp

The time at which the refund record was last updated. Formatted according to the ISO 8601 international standard.

Example value: 2022-06-15T19:26:30.000Z

Measures

Measures are numeric fields that can be aggregated and/or combined to calculate new metrics.

Title

ID

Type

Description

Refunded COGS

total_refunded_cogs

numeric

Total cost of goods refunded.

Refunded Price

total_refunded_price

numeric

Refund value processed during the selected time period, based on the refund date (not including refunded cost of goods, taxes, and shipping).

Note that Triple Whale does not track refunds from third-party return management apps (e.g., Loop), so totals may vary from the main sales platform.

Refunded Shipping

total_refunded_shipping

numeric

Total amount of shipping charges refunded.

Refunded Tax

total_refunded_tax

numeric

Total amount of tax refunded.