SalesOrderLine objects

Fields

line.isku (string)

The SKU of the Item that this line has been written for.

line.vsku (string)

The variant SKU of the Variant that this line has been written for, or null if this Item does not have Variants. See the bulk import docs for more information about Variants.

line.sku (string)

If this line item has a vsku, then this will be the vsku. If not, it will be the isku. This is just a convenience field to avoid having to test for vsku == null all the time.

line.barcode (string)

If this line has a vsku, then this will be the barcode for that variant. If not, it will be the barcode from the item, e.g. the same value as line.item.barcode.

line.item (reference to Item)

The Item that corresponds to the isku for this line.

line.description (string)

The name of the Variant for this line item, if there is one, otherwise the name of the Item. A convenience method to avoid having to test for whether vsku is null.

line.qty (integer)

The number of units of the product on this line item.

line.unitPrice (decimal)

The per-unit price of this item. Depending on discounts, this may or may not be equal to line.item.unitPrice (i.e. the "list price").

line.notes (string)

Notes specific to this line item.

line.total (method returning decimal)

Returns the total amount for this line item, calculated as line.qty * line.unitPrice.

line.listPrice (method returning decimal)

Returns "list" unit price for this line, i.e. the full price that is paid for a single unit when no discounting is in effect.

line.unitDiscount (method returning decimal)

Returns the difference between the listPrice and the unitPrice that is actually being billed.

line.discount (method returning decimal)

Returns the total discount for this line item, calculated as line.qty * line.unitDiscount.

line.percentageDiscount (method returning decimal)

Returns the percentage discount for this line item, calculated by dividing the unitPrice by the listPrice.