RefundsItems
Get data on OrdersItems that have been refunded.
View-Specific Information
Select
The cmdlet uses the Shopify API to process WHERE clause conditions built with the following column and operator. The cmdlet processes other filters client-side within the cmdlet.
- OrderID supports the '=,IN' comparison operators.
- RefundId supports the '=,IN' comparison operators.
- Status supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM RefundsItems
SELECT * FROM RefundsItems WHERE OrderID = 123
SELECT * FROM RefundsItems WHERE RefundId = 123
SELECT * FROM RefundsItems WHERE Status = 'Val1'
Columns
Name | Type | References | Description |
ItemId [KEY] | Long |
OrdersItems.ItemId | The id of the order item. Only available for orders. |
OrderID [KEY] | Long |
Orders.Id | The id of the refund this refunded item belongs to. |
RefundId [KEY] | Long |
Refunds.Id | The id of the refund this refunded item belongs to. |
LocationId | Long | The unique identifier of the location tied to the refund item | |
ProductId | Long |
Products.Id | The id of the of the product beloning to the order item. |
ItemVariantId | Long | The id of the product variant. | |
ItemTitle | String | The title of the product. | |
Name | String | The name of the product variant. | |
ItemQuantity | Int | The number of products that were purchased. | |
ItemPrice | Decimal | The price of the item before discounts have been applied. | |
ItemGrams | Int | The weight of the item in grams. | |
SKU | String | A unique identifier of the item in the fulfillment. | |
VariantTitle | String | The title of the product variant. | |
Properties | String | Shows custom properties for this order item. | |
Vendor | String | The name of the supplier of the item. | |
FulFillmentsService | String | Service provider who is doing the fulfillment. | |
RequiresShipping | Bool | States whether or not the fulfillment requires shipping. | |
Taxable | Bool | States whether or not the product was taxable. | |
GiftCard | Bool | States whether or not the order item is a gift card. | |
FulfillableQuantity | Int | The amount available to fulfill. | |
TotalDiscount | Decimal | The total discount amount applied to this order item. | |
FulfillmentStatus | String | How far along an order is in terms order items fulfilled. | |
RefundSubtotal | Decimal | The refunded amount for this item. This is calculated by multiplying ItemPrice with RefundQuantity. | |
RefundQuantity | Int | The quantity of the item refunded. | |
RefundRestockType | String | The type of the restock action. | |
RefundSubtotalPresentmentAmount | Decimal | The total amount of the presentment money. | |
RefundSubtotalPresentmentCurrencyCode | String | The currency code of the presentment money. | |
RefundSubtotalShopAmount | Decimal | The total amount of the shop money. | |
RefundSubtotalShopCurrencyCode | String | The currency code of the shop money. | |
RefundTotalTax | Decimal | Total tax for the refunded item. | |
RefundTotalTaxPresentmentAmount | Decimal | Total tax amount for the presentment money. | |
RefundTotalTaxPresentmentCurrencyCode | String | Currency code for the tax on presentment money. | |
RefundTotalTaxShopAmount | Decimal | Total tax amount for the shop money. | |
RefundTotalTaxShopCurrencyCode | String | Currency code for the tax on shop money. | |
AppliedDiscountTitle | String | The title of the applied discount for this order. Only available for draft orders. | |
AppliedDiscountDescription | String | The description of the applied discount for order. Only available for draft orders. | |
AppliedDiscountValue | Decimal | The value of the applied discount for this order. Only available for draft orders. | |
AppliedDiscountValueType | String | The value type of the applied discount for order. Only available for draft orders. | |
AppliedDiscountAmount | Decimal | The amount of the applied discount for this order. Only available for draft orders. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements, to offer a more granular control over the tuples that are returned from the data source, or as parameters in INSERT statements.
Name | Type | Description | |
Status | String | Filter orders by their status. Valid values are: open: show only open orders, closed: show only closed orders, cancelled: show only canceled orders, any: show orders of any status,default: open. |