URL: https://api.kometsales.com/api/inventory.list

Method: GET

Content-Type: URL Parameters

Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.

includeBoxes (optional)(integer:1)

If the list should include boxes.

Valid values: 1 = Yes | 0 = No

inventoryType (optional)(string:5)

Inventory type.

You can enter different values separated by commas.

Valid values: M = Open Market | L = Local | S = Standing Order | P = Prebook | all = Every Inventory

Default is M.

excludeHeldItems (optional)(boolean)

Exclude items on hold.

Valid values: 1 = Yes | 0 = No

lotNumber (optional)(string)

Lot number that identifies the inventory item. 

locationId (optional)(integer:20)

Komet Sales internal Location ID.

Only applies to Multi-Location companies.

You can get this value from the location.list API method.

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

Transaction status description.

inventoryItems (array)

Array containing available inventory items.

companyProductId (integer:20)

Product ID.

orderItemId (integer:20)

Inventory Item ID.

grade (string:100)

Product grade or cut point.

productDescription (string:200)

Product description.

productCode (optional)(string:50)

Product legacy code.

quantity (integer:20)

Number of available boxes.

totalUnits (integer:20)

Total units.

growerId (integer: 20)

Grower or Vendor ID.

growerName (string:200)

Grower or Vendor name.

boxTypeId (integer:20)

Box type ID.

boxTypeCode (string:3)

Box size code.

unitType (string:5)

Unit type.

Valid values: Stem or Bunch

bunches (integer:20)

Number of Bunches per Box.

unitsPerBox (integer:20)

Units per Box or Pack.

stemsBunch (integer:20)

Number of Stems per Bunch.

inventoryDate (date)

Inventory date.

price (decimal:10,2)

Unit price or price per individual item.

Not available for Vendor tokens.

sellFast (boolean)

Indicates if the item is marked as sell-fast.

Valid values: True | False

localAfter (integer:10)

The number of days set for the category of the product in the Local After Setting.

isAssorted (boolean)

If the item is assorted or it has breakdowns.

Valid values: True | False

category (string: 200)

Category name.

awb (string:20)

Air Way Bill number.

unitCost (decimal:10,2)

Unit cost.

landedCost (decimal: 10,2)

Unit Landed Cost.

reference (string:100)

Item reference.

lotNumber (string)

Lot number.

markCode (string:20)

Mark code or item label.

aging (integer:20)

The amount of time in days that the item has been in the Inventory.

breakdowns (array)

Array containing breakdown information.

This field will be empty when isAssorted is false.

assortedCompositionId (integer:20)

Breakdown item ID.

productId (integer:20)

Product ID.

productDescription (string:200)

Breakdown product description.

bunches (integer:20)

Number of Bunches.

stemsBunch (integer:20)

Number of Stems per Bunch.

cost (decimal:10,2)

Unit cost.

price (decimal:10,2)

Unit price. 

Not available for Vendor tokens.