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.

IDTypeDescription
event_datedateThe date of the refund. Based on the time zone of the shop at the moment of refund.
event_date.daydateThe day the refund was issued. Derived from event_date.
event_date.weekdateThe Sunday of the week during which the refund was issued. Derived from event_date.
event_date.monthdateThe month during which the refund was issued. Derived from event_date.
event_date.quarterdateThe first month of the quarter during which the refund was issued. Derived from event_date.
event_date.yeardateThe year during which the refund was issued. Derived from event_date.
event_hourstringThe hour of the day the refund was issued, 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
platformstringThe sales platform where the refunded order was processed.

Example value: shopify
order_idstringThe unique ID for the original order that was issued a refund. Assigned by the shop platform.

Example value: 6024492815432
order_datedateThe date the original order was processed. Based on the time zone of the shop at the moment of purchase.
products_inforecordInformation about the product(s) associated with the order. There may be multiple products per order.
products_info.product_idstringThe unique ID of the product in the shop (not order-specific). Assigned by the shop platform.

Example value: 3891505496131
products_info.product_namestringName of the product in the original order.

Example value: all black 3-pack
products_info.product_skustringStock keeping unit of the product in the original order.

Example value ALLBLACK3PACKXS
products_info.variant_idstringThe unique ID of the product variant in the shop (not order-specific). Assigned by the shop.

Example value: 29275946877001
products_info.is_gift_cardbooleanTrue if the product purchased in the original order is a gift card.
products_info.product_name_pricenumericThe product's price (before discounts) in the original order. 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 Triple Whale Admin.
products_info.discount_amount_for_productnumericThe amount discounted from the product price in the original order. By default shown in the shop's currency.
products_info.product_name_quantity_soldnumericThe quantity of the product sold in the original order.
products_info.single_product_costnumericThe cost of goods for the product in the original order. By default shown in the shop's currency.

- For Shopify, the single product cost is set in the store and imported directly, or configured in Triple Whale admin under the costs settings tab.
refund_line_itemrecordInformation about the refund(s) issued. There may be multiple refunds per order.
refund_line_item.refund_line_item_idstringThe unique ID for the refunded line item. Assigned by the shop platform.

Example value: 558610612293
refund_line_item.line_item_idstringThe 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
refund_line_item.gift_cardbooleanTrue if the line item refunded is a gift card.
refund_line_item.product_idstringThe unique ID of the product in the shop (not order-specific). Assigned by the shop platform.

Example value: 3891505496131
refund_line_item.variant_idstringThe unique ID of the product variant in the shop (not order-specific). Assigned by the shop platform.

Example value: 29275946877001
refund_line_item.taxes_includedbooleanTrue if taxes are included in the refunded line item.
refund_line_item.restock_typestringHow 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.quantitynumericThe quantity of the line item that was refunded.
refund_line_item.total_discountnumericThe total discount amount applied to the refunded line item.
refund_line_item.subtotalnumericThe subtotal of the refunded line item before taxes and discounts.
refund_line_item.pre_tax_pricenumericThe price of the refunded line item after discounts but before taxes.
refund_line_item.total_taxnumericThe total tax amount for the refunded line item.
refund_line_item.pricenumericThe price of the refunded line item, after taxes and discounts.
refund_line_item.refunded_cogs_per_itemnumericCost of goods refunded per item. If refund_line_item.restock_type is no_restock, the cost is 0.
refund_line_item. refunded_cogs_per_line_itemnumericCost 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_adjustmentrecordList of order adjustments applied to the refund. There may be multiple adjustments per order.
refund_order_adjustment.kindstringThe order adjustment type.

Valid values:
shipping_refund: Refunds related to shipping charges. refund_discrepancy: Discrepancies in the refund amount.
refund_order_adjustment. order_adjustment_tax_amountnumericThe taxes that are added to the order adjustment amount, such as applicable shipping taxes added to a shipping refund.
refund_order_adjustment. order_adjustment_amountnumericThe 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.
updated_attimestampThe 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.

NameTypeDescription
total_refunded_pricenumericTotal amount refunded, not including cost of goods, tax, and shipping.
total_refunded_cogsnumericTotal cost of goods refunded.
total_refunded_taxnumericTotal amount of tax refunded.
total_refunded_shippingnumericTotal amount of shipping charges refunded.