OrdersItems
Last updated
Last updated
Name
Type
Description
ItemId
Long
The id of the order item. Only available for orders.
OrderId
Long
The id of the order.
OrderUpdatedAt
Datetime
The date and time when the order was last modified.
ProductId
Long
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
Integer
The number of products that were purchased.
ItemPrice
Decimal
The price of the item before discounts have been applied.
ItemGrams
Integer
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
Boolean
States whether or not the fulfillment requires shipping.
Taxable
Boolean
States whether or not the product was taxable.
GiftCard
Boolean
States whether or not the order item is a gift card.
FulfillableQuantity
Integer
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.
Name
Type
Description
Type
String
The type of order item, can be one of the following(Order, DraftOrder, AbandonedCheckout).
The allowed values are Order, DraftOrder, AbandonedCheckout.
The default value is Order.
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.