Get a list of the Open Market Inventory
Use this method to get a list of the current available Open Market Inventory excluding costs and aging.
Valid Tokens: Company.
Related Articles
-
Frequent Actions With PO's (Knowledge Base)
-
-
-
-
Inventory Summary (Knowledge Base)
Request
URL: https://api.kometsales.com/api/inventory.openmarket.list
Method: GET
Content-Type: URL Parameters
Input Parameters
authenticationToken (required)(string:50)
Komet Sales security token.
locationId (optional)(integer:20)
Location ID.
Only applies to Multi-Location companies.
customerId (optional)(integer:20)
Customer ID.
Use this value if you want the API result to show the correct FOB Price based on the settings of a particular Customer.
https://api.kometsales.com/api/inventory.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.
inventoryId (integer:20)
Inventory Line ID.
companyProductId (integer:20)
Product ID.
productDescription (string:200)
Product description.
productCode (string:20)
Product code, also called the Product Legacy Code.
grade (string:100)
Product grade or cut point.
category (string: 200)
Category name.
vendor (string: 200)
Vendor code or name.
This field will be only returned when the customer given in customerId has access to see the Vendor code or name.
quantity (integer:20)
Number of 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: Bunch or Stem
bunches (integer:20)
Number of bunches per box.
unitsPerBox (integer:20)
Units per box or pack.
stemsBunch (integer:20)
Number of stems per bunch.
price (decimal:10,2)
Unit price.
priceB (decimal:10,2)
Unit price B.
fobPrice (decimal:10,2)
FOB unit price based on the unit type of the product and the customer given on the filters.
If no customerID is given, this value will be the same as price.
image (string:200)
Product image URL.
awb (string:15)
AWB or reference number.
shipDate (date)
Date when the product was shipped from the vendor.
Date format: YYYY-MM-DD
availableFrom (date)
Date when the product becomes available.
Date format: YYYY-MM-DD
isAssorted (boolean)
If the item is assorted.
lotNumber (string)
Lot number.
breakdowns (array)
An array containing breakdowns.
This value will be empty if 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.
{
"message": "success",
"status": "1",
"inventoryItems": [
{
"inventoryId": 234234,
"companyProductId": 92341,
"category": "Agapanthus",
"productDescription": "Agapanthus Blue Crme de la Crme 60 Cm",
"productCode": "AGA60",
"image": "http://app.kometsales.com/productImage.jpg",
"grade": "60 Cm",
"vendor": "ABC",
"quantity": 85,
"totalUnits": 12240,
"boxTypeId": 900,
"boxTypeCode": "FB",
"unitType": "Stem",
"bunches": 12,
"unitsPerBox": 144,
"stemsBunch": 12,
"price": 3.01389,
"fobPrice": 3.6211,
"isAssorted": false,
"lotNumber": "4308",
"awb": "098-0823-6522",
"availableFrom": "2016-07-01",
"shipDate": "2016-06-28",
"breakdowns": [
{
"assorteCompositionId": 9999,
"productDescription": "text for product description",
"productId": 99999,
"bunches": 10,
"stemsBunch": 12
}
]
}
]
}