Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to get a consolidated list of the current available Open Market Inventory and exclude costs and aging.

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
sorttitle
titleRelated Articles
cqllabel in ( "inventory" , "open-market" , "inventory-api" , "inventory-adjustments" )
labelsopen-market inventory

Request


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

Method: GET

Content-Type: URL Parameters


Parameters

authenticationToken (required) (string:50)

Komet Sales security token.


Code Block
languagejs
https://api.kometsales.com/api/inventory.consolidated.openmarket.list?
authenticationToken=token_info_goes_here

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


inventoryItems (array)

An array containing available inventory items.


companyProductId (integer:20)

Product ID.


inventoryItemIds (integer:20)

Inventory Item IDs separated by a comma.


grade (string:100)

Product grade or cut point.


productDescription (string:200)

Product description.


productCode (string:20)

Product code.


quantity (integer:20)

Total available boxes.


totalUnits (integer:20)

Total units.


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)

Number of units per box or pack.


stemsBunch (integer:20)

Number of stems per bunch.


price (decimal:10,2)

Unit price or price per individual item.


category (string: 200)

Category name.


Code Block
message": "success",
   "status": "1",
   "inventoryItems": [
   {
     "companyProductId": 999999,
     "inventoryItemIds": "2343,35454",
     "grade": "60 Cm",
     "productDescription": "Agapanthus Blue Crme de la Crme 60 Cm",
     "productCode": "AGA60",
     "quantity": 85,
     "totalUnits": 12240,
     "boxTypeId": 900,
     "boxTypeCode": "FB",
     "unitType": "Stem",
     "bunches": 12,
     "unitsPerBox": 144,
     "stemsBunch": 12,
     "price": 3.01389,
     "category": "Agapanthus"
   }
 ]
}

We've encountered an issue exporting this macro. Please try exporting this page again later.