Skip to main content

OrderItem

Order item entity representing a single line on an order.

External entity from the order service. Used as a reference for order-item-specific attributes within the attribute system.

type OrderItem {
  id: Int!
  productId: Int
  attributes(input: AttributeResultSearchInput): AttributeResultResponse
  orderId: Int!
  uuid: String!
  class: OrderItemClass!
  parentOrderItemId: Int
  quantity: Int!
  sku: String!
  notes: String
  name: String!
  supplier: String
  supplierCode: String
  manufacturer: String
  manufacturerCode: String
  eanCode: String
  originalPrice: Float
  price: Float!
  priceTotal: Float!
  priceNet: Float
  priceTotalNet: Float
  customerPrice: Float
  costPrice: Float
  discount: Float
  tax: Float
  taxPercentage: Int!
  taxCode: Taxcode!
  isBonus: YesNo!
  minimumQuantity: Int
  unit: Int
  package: String
  packageUnit: String
  packageUnitQuantity: String
  purchaseUnit: Int
  purchaseMinimumQuantity: Int
  requestDate: DateTime
  sources: [Source!]
  priority: Int
  product(hidden: Boolean): Product
}

Fields​

OrderItem.id ● Int! non-null scalar​

The autoincrement ID for the OrderItem

OrderItem.productId ● Int scalar​

The productId of the OrderItem

OrderItem.attributes ● AttributeResultResponse object​

Lists attributes for this order item based on the search input.

OrderItem.attributes.input ● AttributeResultSearchInput input​

OrderItem.orderId ● Int! non-null scalar​

The ID of the Order the OrderItem belongs to

OrderItem.uuid ● String! non-null scalar​

The UUID for the OrderItem

OrderItem.class ● OrderItemClass! non-null enum​

The class of the orderItem. Either product, incentive, surcharge, postage, payment

OrderItem.parentOrderItemId ● Int scalar​

The ID of the parent OrderItem

OrderItem.quantity ● Int! non-null scalar​

The quantity of the product for the OrderItem

OrderItem.sku ● String! non-null scalar​

Product SKU

OrderItem.notes ● String scalar​

Additional notes about this item

OrderItem.name ● String! non-null scalar​

Display name of the item

OrderItem.supplier ● String scalar​

The supplier of the product of the OrderItem

OrderItem.supplierCode ● String scalar​

The supplierCode of the product of the OrderItem

OrderItem.manufacturer ● String scalar​

The manufacturer of the product of the OrderItem

OrderItem.manufacturerCode ● String scalar​

The manufacturerCode of the product of the OrderItem

OrderItem.eanCode ● String scalar​

The eanCode of the product of the OrderItem

OrderItem.originalPrice ● Float scalar​

The original price of the OrderItem, before applying any discounts

OrderItem.price ● Float! non-null scalar​

The calculated price per unit excluding tax

OrderItem.priceTotal ● Float! non-null scalar​

The total price of the OrderItem excluding tax

OrderItem.priceNet ● Float scalar​

The calculated price per unit including tax

OrderItem.priceTotalNet ● Float scalar​

The total price of the OrderItem including tax

OrderItem.customerPrice ● Float scalar​

The calculated customerPrice of the OrderItem at the time the order was placed

OrderItem.costPrice ● Float scalar​

The cost price of the OrderItem at the time the order was placed

OrderItem.discount ● Float scalar​

The discount of the OrderItem, as an absolute amount per unit in the order's currency. It is never a percentage. Calculated as originalPrice - price, including any item incentive. For the percentage equivalent, use discount / originalPrice * 100. Unlike the order level total.discountValue, which is absolute or a percentage depending on total.discountType, this field is always absolute.

OrderItem.tax ● Float scalar​

The total tax of the OrderItem

OrderItem.taxPercentage ● Int! non-null scalar​

The tax percentage of the OrderItem

OrderItem.taxCode ● Taxcode! non-null enum​

The tax code of the OrderItem

OrderItem.isBonus ● YesNo! non-null enum​

Is the OrderItem a bonusItem?

OrderItem.minimumQuantity ● Int scalar​

The minimum quantity of the product of the OrderItem

OrderItem.unit ● Int scalar​

The unit of the product of the OrderItem

OrderItem.package ● String scalar​

The package of the product of the OrderItem

OrderItem.packageUnit ● String scalar​

The package unit of the product of the OrderItem

OrderItem.packageUnitQuantity ● String scalar​

The package unit quantity of the product of the OrderItem

OrderItem.purchaseUnit ● Int scalar​

The purchase unit of the product of the OrderItem

OrderItem.purchaseMinimumQuantity ● Int scalar​

The purchase minimum quantity of the product of the OrderItem

OrderItem.requestDate ● DateTime scalar​

The requested delivery date for this orderline

OrderItem.sources ● [Source!] list object​

The sources for the order items

OrderItem.priority ● Int scalar​

The priority of the order item within its order. Auto-assigned in increments of 100 if not provided. Lower numbers are considered higher priority. Must be unique per order. When setting a priority that conflicts with an existing item, other items are automatically shifted to make room.

OrderItem.product ● Product object​

OrderItem.product.hidden ● Boolean scalar​

Returned By​

orderItemCreate mutation ● orderItemUpdate mutation

Member Of​

Order object ● ShipmentItem object