Skip to main content

SalesOrderItem

A line on a sales order: a product or variant, quantity, price, discount and tax, with its shipped and invoiced progress.

type SalesOrderItem {
  acceptAlternativeIfUnavailable: Boolean!
  allocatedQuantity: Float!
  availableQuantity: Float!
  canceledQuantity: Float
  conversionFactor: Float!
  createdAt: DateTime!
  discountAmount: Float!
  discountBreakdown: JSON
  discountPercent: Float!
  id: ID!
  inventoryConversionFactor: Float!
  inventoryUOMId: String
  invoiceItems: [InvoiceItemInfo!]
  invoicedQuantity: Float
  notes: String
  priceSource: String
  product: Product
  productId: String!
  productName: String!
  productSku: String!
  quantity: Float!
  remainingQuantity: Float
  returnedQuantity: Float! @deprecated
  salesOrderId: String!
  shippedQuantity: Float!
  taxAmount: Float!
  taxBreakdown: JSON
  taxGroupId: String
  taxRate: Float!
  taxRateIds: [String!]
  totalAmount: Float!
  unitPrice: Float!
  uomId: String!
  uomName: String!
  uomSymbol: String!
  updatedAt: DateTime!
  variant: ProductVariant
  variantId: String
  variantName: String
  warehouse: Warehouse
  warehouseId: String
}

Fields​

SalesOrderItem.acceptAlternativeIfUnavailable ● Boolean! non-null scalar​

Buyer consent: if this item becomes unavailable, may fulfillment ship a manually-picked substitute instead? Consent + visibility only.

SalesOrderItem.allocatedQuantity ● Float! non-null scalar​

Quantity allocated to this line.

SalesOrderItem.availableQuantity ● Float! non-null scalar​

Not populated: currently always 0. Use the inventory queries for stock on hand.

SalesOrderItem.canceledQuantity ● Float scalar​

Quantity cancelled on this line.

SalesOrderItem.conversionFactor ● Float! non-null scalar​

How many base units one unit of the line's unit of measure equals.

SalesOrderItem.createdAt ● DateTime! non-null scalar​

When the line was created.

SalesOrderItem.discountAmount ● Float! non-null scalar​

Total discount amount on the line.

SalesOrderItem.discountBreakdown ● JSON scalar​

Attribution of discountAmount: [{ kind: "TIER" | "SCHEME" | "MANUAL", label: string, percent: number | null, amount: "<exact decimal string>" }]. Null when the line carries no discount or predates the column.

SalesOrderItem.discountPercent ● Float! non-null scalar​

The line discount as a percentage.

SalesOrderItem.id ● ID! non-null scalar​

Unique identifier of the record.

SalesOrderItem.inventoryConversionFactor ● Float! non-null scalar​

How many inventory units one unit of the line's unit of measure equals.

SalesOrderItem.inventoryUOMId ● String scalar​

The ID of the unit of measure the stock for this line is held in.

SalesOrderItem.invoiceItems ● [InvoiceItemInfo!] list object​

The invoice lines that bill this line.

SalesOrderItem.invoicedQuantity ● Float scalar​

Quantity already invoiced on this line.

SalesOrderItem.notes ● String scalar​

Notes on this line.

SalesOrderItem.priceSource ● String scalar​

Whose price this line carries: ENGINE, CLIENT, OVERRIDE, QUOTE_CONVERSION, IMPORT, or CONVERTED (the product's base price converted at the document rate). Null on older lines.

SalesOrderItem.product ● Product object​

The product on this line.

SalesOrderItem.productId ● String! non-null scalar​

The ID of the product on this line.

SalesOrderItem.productName ● String! non-null scalar​

The product name, as stored on the line.

SalesOrderItem.productSku ● String! non-null scalar​

The SKU of the variant, as stored on the line.

SalesOrderItem.quantity ● Float! non-null scalar​

Quantity ordered, in the line's unit of measure.

SalesOrderItem.remainingQuantity ● Float scalar​

Quantity not yet invoiced: the line quantity (after cancellations) less invoicedQuantity.

SalesOrderItem.returnedQuantity ● Float! deprecated non-null scalar​

DEPRECATED

Never written; always 0. Read SalesOrder.lineReturns for what returns hold against each line.

Not maintained; always 0.

SalesOrderItem.salesOrderId ● String! non-null scalar​

The ID of the sales order this line belongs to.

SalesOrderItem.shippedQuantity ● Float! non-null scalar​

Quantity shipped so far.

SalesOrderItem.taxAmount ● Float! non-null scalar​

Total tax on the line.

SalesOrderItem.taxBreakdown ● JSON scalar​

Tax applied to this line, as a list of { taxName, taxCode, taxType, rate, taxAmount }.

SalesOrderItem.taxGroupId ● String scalar​

The ID of the tax group applied to this line.

SalesOrderItem.taxRate ● Float! non-null scalar​

The tax rate applied to the line, as a percentage.

SalesOrderItem.taxRateIds ● [String!] list scalar​

The IDs of the tax rates applied to this line.

SalesOrderItem.totalAmount ● Float! non-null scalar​

The line total, as calculated and stored by the server.

SalesOrderItem.unitPrice ● Float! non-null scalar​

Price per unit before the line discount.

SalesOrderItem.uomId ● String! non-null scalar​

The ID of the unit of measure the quantity is expressed in.

SalesOrderItem.uomName ● String! non-null scalar​

Name of the unit of measure.

SalesOrderItem.uomSymbol ● String! non-null scalar​

Symbol of the unit of measure.

SalesOrderItem.updatedAt ● DateTime! non-null scalar​

When the line was last changed.

SalesOrderItem.variant ● ProductVariant object​

The product variant on this line.

SalesOrderItem.variantId ● String scalar​

The ID of the product variant on this line.

SalesOrderItem.variantName ● String scalar​

The variant name, as stored on the line.

SalesOrderItem.warehouse ● Warehouse object​

The warehouse this line is fulfilled from.

SalesOrderItem.warehouseId ● String scalar​

The ID of the warehouse this line is fulfilled from.

Returned By​

getSalesOrderItemsWithRemainingQuantity query

Member Of​

SalesOrder object