OrdersItems
Query order items.
View-Specific Information
Select
The provider uses the Shopify API to process search criteria that refer to the OrderId and OrderUpdatedAt columns and the Type pseudo column. The supported SQL operators are '=' for OrderId and Type and '>' and '<' for OrderUpdatedAt. The provider processes other filters client-side within the provider.For example, the following queries are processed server-side. You can set the Type pseudo column to "DraftOrder" to list order items belonging to draft orders instead of orders, or you can set Type to "AbandonedCheckout" to list order items belonging to abandoned checkouts.
SELECT * FROM OrderItems WHERE OrderId = '123'
SELECT * FROM OrderItems WHERE OrderUpdatedAt > '2018-05-10'
SELECT * FROM OrderItems WHERE Type = 'DraftOrder'
SELECT * FROM OrderItems WHERE Type = 'AbandonedCheckout'
Columns
Name | Type | References | Description |
ItemId [KEY] | Long | The id of the order item. Only available for orders. | |
OrderId | Long |
Orders.Id | The id of the order. |
OrderUpdatedAt | Datetime | The date and time when the order was last modified. | |
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. | |
CurrentQuantity | Int | The line item's current quantity after removals. | |
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. | |
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 | |
Type | String | The type of order item, can be one of the following(Order, DraftOrder, AbandonedCheckout). | |
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. |