Skip to main content

OrderItem

The order item type. This type represents an order item in the system.

type OrderItem {
  allocationInfo: [ItemAllocation!] @deprecated
  allocationStatusInfo: OrderItemAllocationStatus!
  createdAt: ISO8601DateTime!
  depth: DepthEnum!
  discount: Decimal
  fulfillable: Boolean!
  height: Decimal
  id: ID!
  inventoryItem: InventoryItem
  length: Decimal
  name: String
  price: Float
  processable: Boolean!
  product: Product
  productId: ID
  quantity: Int!
  sku: String
  status: OrderItemStatusEnum! @deprecated
  total: Decimal
  updatedAt: ISO8601DateTime!
  weight: Decimal
  width: Decimal
}

Fields​

OrderItem.allocationInfo ● [ItemAllocation!] deprecated list object​

DEPRECATED

Use allocationStatusInfo instead. This field will be removed in the future.

The allocation info for the order item. This information includes information about the location where the item is allocated, the quantity allocated, and the status of the allocation.

OrderItem.allocationStatusInfo ● OrderItemAllocationStatus! non-null object​

The allocation status information for the order item. This information includes information about the status of the order item, and general allocation information.

OrderItem.createdAt ● ISO8601DateTime! non-null scalar​

OrderItem.depth ● DepthEnum! non-null enum​

OrderItem.discount ● Decimal scalar​

OrderItem.fulfillable ● Boolean! non-null scalar​

OrderItem.height ● Decimal scalar​

OrderItem.id ● ID! non-null scalar​

OrderItem.inventoryItem ● InventoryItem object​

The inventory item object of the order item. User must have the read_inventory_item permission.

OrderItem.length ● Decimal scalar​

OrderItem.name ● String scalar​

OrderItem.price ● Float scalar​

OrderItem.processable ● Boolean! non-null scalar​

OrderItem.product ● Product object​

The product object of the order item. User must have the read_product permission.

OrderItem.productId ● ID scalar​

OrderItem.quantity ● Int! non-null scalar​

OrderItem.sku ● String scalar​

OrderItem.status ● OrderItemStatusEnum! deprecated non-null enum​

DEPRECATED

Deprecated in favor of allocationStatusInfo. This field will be removed in the future.

The status of the order item.

OrderItem.total ● Decimal scalar​

OrderItem.updatedAt ● ISO8601DateTime! non-null scalar​

OrderItem.weight ● Decimal scalar​

OrderItem.width ● Decimal scalar​

Returned By​

addOrderItem mutation ● orderItems query ● updateOrderItem mutation

Member Of​

FulfillmentItem object ● ItemAllocation object ● Order object ● ShippingContainerLine object