NameDescriptionTypeAdditional information
qty_shipped

How many of the ordered quantity have been shipped from the Eskimo system.

integer

None.

qty_refunded

How many of the ordered quantity have been refunded from the Eskimo system.

integer

None.

id

The database id for this item

string

None.

status

EskimoClassLibraries.clsOrderItemExt+OrderStatusEnum

None.

lineID

A unique number for each line in the sale. Start at 1 and increment. Optional, unless Kit items are included.

integer

None.

sku_code

Matches the sku_code property from the SKUs Controller. Must be a valid SKU code.

string

Required

String length: inclusive between 0 and 35

qty_purchased

The quantity being purchased.

integer

Range: inclusive between 1 and 32767

unit_price

The price of one of these items AFTER any discounts. So assuming the customer bought 4 of the item priced at £25.00 and then received a £10.00 discount, this unit_price value should be 22.50

decimal number

Required

line_discount_amount

The sum of the discounts applied to all of the items on this line. See notes on unit_price; In the example there, this value would be 10.00

decimal number

Required

item_note

Optional property that allows for any notes about this item. For example, the item purchased may be a personalised t-shirt and this will contain the name to be printed on the reverse.

string

None.

item_description

The description of the product. This is populated when retrieving order information and is not required for inserting new orders.

string

None.

vat_rate

The VAT Percentage rate for this product. Not required when inserting orders as the rate associated with the product will be used. This is populated when retrieving an order though.

decimal number

None.

vat_id

Optional. If omitted, the VAT ID assigned to the product will be used. If the goods are being exported outside of the UK for instance, the VAT ID might be different to what is assigned on the product. See api/TaxCodes/All for a list of the possible values

integer

None.

kit_product_type

Determines if this order line is part of a package (or kit). If omitted, 5 (Normal item) will be assumed.

EskimoClassLibraries.clsSaleItemBase+ItemKitTypeEnum

None.

kit_parent_line

If this item is a kit (package) component, then this property determines which item in the sale is the kit header

integer

None.