Skip to main content

OrderItem

Describes an order item of an order.

type OrderItem implements Node {
id: UUID!
createdAt: DateTime!
productVariant: ProductVariant!
productVariantVersion: ProductVariantVersion!
taxRateVersion: TaxRateVersion!
shoppingCartItem: ShoppingCartItem!
count: Int!
compensatableAmount: Int!
shipmentMethod: ShipmentMethod!
discounts(
first: Int
skip: Int
orderBy: CommonOrderInput
): DiscountConnection!
returnedWith: Return
sentWith: Shipment
}

Fields

OrderItem.id ● UUID! non-null scalar

The ID of the node.

OrderItem.createdAt ● DateTime! non-null scalar

Timestamp when order item was created.

OrderItem.productVariant ● ProductVariant! non-null object

Product variant associated with order item.

OrderItem.productVariantVersion ● ProductVariantVersion! non-null object

Product variant version associated with order item.

OrderItem.taxRateVersion ● TaxRateVersion! non-null object

Tax rate version associated with order item.

OrderItem.shoppingCartItem ● ShoppingCartItem! non-null object

Shopping cart item associated with order item.

OrderItem.count ● Int! non-null scalar

Specifies the quantity of the order item.

OrderItem.compensatableAmount ● Int! non-null scalar

Total cost of product item, which can also be refunded.

OrderItem.shipmentMethod ● ShipmentMethod! non-null object

Shipment method of order item.

OrderItem.discounts ● DiscountConnection! non-null object

Retrieves discounts.

OrderItem.discounts.first ● Int scalar

Describes that the first N discounts should be retrieved.

OrderItem.discounts.skip ● Int scalar

Describes how many discounts should be skipped at the beginning.

OrderItem.discounts.orderBy ● CommonOrderInput input

Specifies the order in which discounts are retrieved.

OrderItem.returnedWith ● Return object

The return this order item was returned with.

OrderItem.sentWith ● Shipment object

The shipment this order item was originally sent with.

Interfaces

Node interface

An object with an ID.

Returned By

orderItem query

Member Of

OrderItemConnection object