Skip to main content

OrderItemCreateInput

No description

input OrderItemCreateInput {
  class: OrderItemClass!
  uuid: String
  productId: Int
  productSource: SourceInput
  parentOrderItemId: Int
  parentOrderItemUUID: String
  quantity: Int!
  sku: String!
  notes: String
  name: String! =
  supplier: String
  supplierCode: String
  manufacturer: String
  manufacturerCode: String
  eanCode: String
  originalPrice: Float!
  customerPrice: Float
  price: Float!
  priceTotal: Float!
  priceNet: Float
  priceTotalNet: 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: String
  priority: Int
  sources: [SourceInput!]
}

Fields​

OrderItemCreateInput.class ● OrderItemClass! non-null enum​

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

OrderItemCreateInput.uuid ● String scalar​

The UUID for the OrderItem

OrderItemCreateInput.productId ● Int scalar​

The productId of the OrderItem

OrderItemCreateInput.productSource ● SourceInput input​

Product source

OrderItemCreateInput.parentOrderItemId ● Int scalar​

The ID of the parent OrderItem

OrderItemCreateInput.parentOrderItemUUID ● String scalar​

The UUID of the parent OrderItem, this can be used in bulk operations where the auto-increment ID's are not known

OrderItemCreateInput.quantity ● Int! non-null scalar​

The quantity of the product for the OrderItem

OrderItemCreateInput.sku ● String! non-null scalar​

Product SKU

OrderItemCreateInput.notes ● String scalar​

Additional notes about this item

OrderItemCreateInput.name ● String! non-null scalar​

Display name of the item

OrderItemCreateInput.supplier ● String scalar​

The supplier of the product of the OrderItem

OrderItemCreateInput.supplierCode ● String scalar​

The supplierCode of the product of the OrderItem

OrderItemCreateInput.manufacturer ● String scalar​

The manufacturer of the product of the OrderItem

OrderItemCreateInput.manufacturerCode ● String scalar​

The manufacturerCode of the product of the OrderItem

OrderItemCreateInput.eanCode ● String scalar​

The eanCode of the product of the OrderItem

OrderItemCreateInput.originalPrice ● Float! non-null scalar​

The original price of the OrderItem, before applying any discounts

OrderItemCreateInput.customerPrice ● Float scalar​

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

OrderItemCreateInput.price ● Float! non-null scalar​

The calculated price per unit excluding tax

OrderItemCreateInput.priceTotal ● Float! non-null scalar​

The total price of the OrderItem excluding tax

OrderItemCreateInput.priceNet ● Float scalar​

The calculated price per unit including tax

OrderItemCreateInput.priceTotalNet ● Float scalar​

The total price of the OrderItem including tax

OrderItemCreateInput.costPrice ● Float scalar​

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

OrderItemCreateInput.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.

OrderItemCreateInput.tax ● Float scalar​

The total tax of the OrderItem

OrderItemCreateInput.taxPercentage ● Int! non-null scalar​

The tax percentage of the OrderItem

OrderItemCreateInput.taxCode ● Taxcode! non-null enum​

The tax code of the OrderItem

OrderItemCreateInput.isBonus ● YesNo! non-null enum​

Is the OrderItem a bonusItem?

OrderItemCreateInput.minimumQuantity ● Int scalar​

The minimum quantity of the product of the OrderItem

OrderItemCreateInput.unit ● Int scalar​

The unit of the product of the OrderItem

OrderItemCreateInput.package ● String scalar​

The package of the product of the OrderItem

OrderItemCreateInput.packageUnit ● String scalar​

The package unit of the product of the OrderItem

OrderItemCreateInput.packageUnitQuantity ● String scalar​

The package unit quantity of the product of the OrderItem

OrderItemCreateInput.purchaseUnit ● Int scalar​

The purchase unit of the product of the OrderItem

OrderItemCreateInput.purchaseMinimumQuantity ● Int scalar​

The purchase minimum quantity of the product of the OrderItem

OrderItemCreateInput.requestDate ● String scalar​

The requested delivery date for this orderline

OrderItemCreateInput.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.

OrderItemCreateInput.sources ● [SourceInput!] list input​

The sources for the order items

Member Of​

CreateOrUpdateOrderItemInput input ● OrderCreateInput input ● orderItemCreate mutation