SalesOrderItem
Sales Order Line Item.
| Name | Description | Type | Additional information |
|---|---|---|---|
StyleCode |
Product style code |
string |
None. |
Barcode |
Barcode/UPC. Note, if the product option barcode exists in Cin7, only quantity needs to be included; all other fields are optional. |
string |
None. |
SupplierCode |
Supplier code |
string |
None. |
SizeCodes |
An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-only) |
string |
None. |
LineComments |
Line item comment |
string |
None. |
UnitCost |
Unit Cost |
decimal number |
None. |
UnitPrice |
Unit Price |
decimal number |
None. |
UomPrice |
Uom Price of the product. To create/update UOM's use UomPrice instead of UnitPrice. |
decimal number |
None. |
Discount |
Total line item discount |
decimal number |
None. |
UomQtyOrdered |
Uom Qty Ordered. To create/update UOM's use UomQtyOrdered instead of Qty. |
decimal number |
None. |
UomQtyShipped |
Uom Qty shipped/dispatched. This field is read-only. This is calculated from QtyShipped. |
decimal number |
None. |
UomSize |
Uom Size. (Read-only) |
decimal number |
None. |
QtyShipped |
Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. |
decimal number |
None. |
HoldingQty |
Holding Quantity (Read-only). |
decimal number |
None. |
AccountCode |
Alternative GL Account Code. Omit to default to Product GL. |
string |
None. |
StockControl |
StockControl |
None. |
|
StockMovements |
On PUT, the serial numbers, batches or sizes to dispatch on this line, one entry each - see StockMovement for which field to use per stock type and how 'Quantity' works. Supplying entries dispatches this line even with no dispatch date (a date also dispatches the order's remaining lines), and they are honored even when the branch is set to auto-dispatch as FIFO, a line with no entries still auto-FIFOs. |
Collection of StockMovement |
None. |
Sizes |
TODO: remove ApiExplorerSettings Attribute after removing APISizeCodeLookup Feature Flag. |
Collection of Size |
None. |
TaxRate |
Currently not made visible to the API documentation as we're only using it internally for our Numeral tax Calculation. If we want to expose it in the future, we can remove the ApiExplorerSettings attribute. |
decimal number |
None. |
Id |
The unique Cin7 ID |
integer |
None. |
CreatedDate |
Created date |
date |
None. |
TransactionId |
Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id |
integer |
None. |
ParentId |
Parent Line Item ID (Read-only) |
integer |
None. |
ProductId |
Product ID (Read-only) |
integer |
None. |
ProductOptionId |
The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item. |
integer |
None. |
IntegrationRef |
Integration reference |
string |
None. |
Sort |
Sort (or sequence) of line items |
integer |
None. |
Code |
string |
None. |
|
Name |
Item name |
string |
None. |
Option1 |
Option 1 |
string |
None. |
Option2 |
Option 2 |
string |
None. |
Option3 |
Option 3 (required for size products) |
string |
None. |
Qty |
Quantity |
decimal number |
None. |