Create or exchange a line item

Unique identifier.

Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff. Note that item color can be changed and deleted any time such that it no longer matches this line item

Line item name.

Alternate name of the line item.

Price of the item, typically in cents of merchant currency. When unit quantity is not null then this is the price for a single unit and is not the complete price.

Price of item after adding all modifications. This is used only for reporting.

Price of item after adding all modifications and subtracting all line item and order level discounts. This is used only for reporting.

This is applicable only if the item is priced by quantity of a unit. The item must have a priceType of PER_UNIT. The value is a fixed-point integer with scaling factor of 1000 (e.g. if charging per ounce, the value should be set to 2500 for 2.5 ounces). To compute the complete price perform the following calculation: PRICE * (UNIT QTY / 1000). If the item doesn’t have a priceType of PER_UNIT, then unitQty is ignored.

Unit name (e.g. oz, lb, etc) if priced by unit, otherwise null.

True if this line item has been printed out on an order printer at least once already.

Unnamed fixed discount amount in cents. Or, in reporting, this may be the calculated sum of all the line item discounts.

The calculated sum of order level discounts attributed, approximately to the nearest cent, to this the line item. This is only used in reporting.

True if this line item has been refunded

True if this item should be counted as revenue, for example gift cards and donations would not.

Revenue collected for this. This field is only used in reporting.

Quantity sold for this line item. This field is only used in reporting