RefundsItems
Lists refunded line items with quantities, amounts, duties, and restock instructions.
Columns
| Name | Type | References | Description |
| ItemId [KEY] | Long |
OrdersItems.ItemId | The unique numeric identifier for the order item associated with the refund. Available only for orders. |
| OrderID [KEY] | Long |
Orders.Id | The unique numeric identifier for the order related to this refund item. |
| RefundId [KEY] | Long |
Refunds.Id | The unique numeric identifier for the refund that this refunded item belongs to. |
| LocationId | Long | The unique identifier of the physical location associated with the refunded item. | |
| ProductId | Long | The unique numeric identifier for the product associated with this order item. | |
| ItemVariantId | Long | The unique numeric identifier for the product variant associated with this item. | |
| ItemTitle | String | The title of the product. | |
| Name | String | The name of the product variant. | |
| ItemQuantity | Int | The total quantity of this item originally purchased in the order. | |
| ItemPrice | Decimal | The price of the item before any discounts were applied. | |
| ItemGrams | Int | The weight of the item in grams. | |
| SKU | String | A unique identifier assigned to the item for inventory tracking purposes. | |
| VariantTitle | String | The title of the product variant. | |
| Properties | String | A JSON object showing any custom properties associated with this order item. | |
| Vendor | String | The name of the product vendor or supplier. | |
| FulFillmentsService | String | The name of the fulfillment service responsible for processing this item. | |
| RequiresShipping | Bool | Indicates whether this item requires shipping for fulfillment. | |
| Taxable | Bool | Indicates whether the item is subject to tax. | |
| GiftCard | Bool | Indicates whether the refunded item was a gift card product. | |
| FulfillableQuantity | Int | The number of units still available to fulfill for this item. | |
| TotalDiscount | Decimal | The total discount amount applied to this item before refund. | |
| FulfillmentStatus | String | Indicates the fulfillment progress of this order item. | |
| RefundSubtotal | Decimal | The subtotal amount refunded for this item, calculated as ItemPrice multiplied by RefundQuantity. | |
| RefundQuantity | Int | The quantity of this item that was refunded. | |
| RefundRestockType | String | The restock action applied to the refunded item (for example, 'return', 'cancel', or 'none'). | |
| RefundSubtotalPresentmentAmount | Decimal | The refunded subtotal amount in presentment currency. | |
| RefundSubtotalPresentmentCurrencyCode | String | The ISO 4217 currency code for the refunded subtotal in presentment currency. | |
| RefundSubtotalShopAmount | Decimal | The refunded subtotal amount in the shop's currency. | |
| RefundSubtotalShopCurrencyCode | String | The ISO 4217 currency code for the refunded subtotal in the shop's currency. | |
| RefundTotalTax | Decimal | The total tax amount refunded for this item. | |
| RefundTotalTaxPresentmentAmount | Decimal | The refunded tax amount in presentment currency. | |
| RefundTotalTaxPresentmentCurrencyCode | String | The ISO 4217 currency code for the refunded tax in presentment currency. | |
| RefundTotalTaxShopAmount | Decimal | The refunded tax amount in the shop's currency. | |
| RefundTotalTaxShopCurrencyCode | String | The ISO 4217 currency code for the refunded tax in the shop's currency. | |
| AppliedDiscountTitle | String | The title of the discount applied to this order. Available only for draft orders. | |
| AppliedDiscountDescription | String | A description of the discount applied to this order. Available only for draft orders. | |
| AppliedDiscountValue | Decimal | The numeric value of the applied discount. Available only for draft orders. | |
| AppliedDiscountValueType | String | The value type of the applied discount (for example, 'percentage' or 'fixed_amount'). Available only for draft orders. | |
| AppliedDiscountAmount | Decimal | The total discount amount applied to this order. Available only for draft orders. |
Pseudo-Columns
疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。
| Name | Type | Description | |
| Status | String | Filters refunded orders by their status. Valid values: 'open', 'closed', 'cancelled', 'any'. Default value: 'open'. |