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 @deprecated
  discountMonetary: MonetaryValue
  externalId: String
  fulfillable: Boolean!
  height: Decimal
  id: ID!
  inventoryItem: InventoryItem
  length: Decimal
  name: String
  originFulfillmentInformation: OrderItemOriginFulfillment
  price: Float @deprecated
  priceMonetary: MonetaryValue
  processable: Boolean!
  product: Product
  productId: ID
  quantity: Int!
  sku: String
  status: OrderItemStatusEnum! @deprecated
  total: Decimal @deprecated
  totalMonetary: MonetaryValue
  updatedAt: ISO8601DateTime!
  weight: Decimal
  width: Decimal
}

Fields

`OrderItem.allocationInfo` ● `[ItemAllocation!]` deprecated list object inventory

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 orders

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 common

`OrderItem.depth` ● `DepthEnum!` non-null enum inventory

`OrderItem.discount` ● `Decimal` deprecated scalar common

DEPRECATED

Use discountMonetary instead.

`OrderItem.discountMonetary` ● `MonetaryValue` object common

`OrderItem.externalId` ● `String` scalar common

`OrderItem.fulfillable` ● `Boolean!` non-null scalar common

`OrderItem.height` ● `Decimal` scalar common

`OrderItem.id` ● `ID!` non-null scalar common

`OrderItem.inventoryItem` ● `InventoryItem` object inventory

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

`OrderItem.length` ● `Decimal` scalar common

`OrderItem.name` ● `String` scalar common

`OrderItem.originFulfillmentInformation` ● `OrderItemOriginFulfillment` object orders

`OrderItem.price` ● `Float` deprecated scalar common

DEPRECATED

Use priceMonetary instead.

`OrderItem.priceMonetary` ● `MonetaryValue` object common

`OrderItem.processable` ● `Boolean!` non-null scalar common

`OrderItem.product` ● `Product` object products

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

`OrderItem.productId` ● `ID` scalar common

`OrderItem.quantity` ● `Int!` non-null scalar common

`OrderItem.sku` ● `String` scalar common

`OrderItem.status` ● `OrderItemStatusEnum!` deprecated non-null enum orders

DEPRECATED

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

The status of the order item.

`OrderItem.total` ● `Decimal` deprecated scalar common

DEPRECATED

Use totalMonetary instead.

`OrderItem.totalMonetary` ● `MonetaryValue` object common

`OrderItem.updatedAt` ● `ISO8601DateTime!` non-null scalar common

`OrderItem.weight` ● `Decimal` scalar common

`OrderItem.width` ● `Decimal` scalar common

Returned By

addOrderItem mutation ● orderItems query ● updateOrderItem mutation

Member Of

FulfillmentItem object ● ItemAllocation object ● Order object ● ShippingContainerLine object ● V2Order object

Fields
Returned By
Member Of