| Excerpt | ||
|---|---|---|
Use this method to get a list of products in the Future Inventory.
|
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/future.inventory.openmarket.list
Method: GET
Content-Type: URL Parameters
Input Parameters
authenticationToken (required)(string:50)
Komet Sales security token.
dateFrom (required)(date)
Availability starting date.
Date format: YYYY-MM-DD
dateTo (required)(date)
Availability ending date.
Date format: YYYY-MM-DD
locationId (optional) (integer:20)
Inventory Location ID.
Only applies to Multi-Location Companies.
customerId (optional)(integer:20)
Customer ID.
Use this value to get the correct FOB Price based on the settings of a particular Customer.
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/future.inventory.openmarket.list?authenticationToken=token_info_goes_here& dateFrom=2020-11-15&dateTo=2020-11-20 |
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 Item ID.
In Komet Sales this ID represents the Purchase Order Item ID.
companyProductId (integer:20)
Product ID.
productDescription (string:200)
Product description.
productCode (string:20)
Product code, also known as Product Legacy Code.
grade (string:100)
Product grade or cut point.
category (string:200)
Category name.
vendor (string:200)
Vendor name or code.
This field will be only returned when the customer given in customerId has access to see the vendor code or name.
portOfOrigin (string:10)
Product’s Port of Origin.
quantity (integer:20)
Number of available boxes.
totalUnits (integer:20)
Total units.
boxTypeId (integer:20)
Box type ID.
boxTypeCode (string:3)
Box type code for the size of the box.
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.
fobPrice (decimal:10,2)
Unit FOB price. If you use customerId the system will return the FOB price. If not, this value will be the same as the unit price.
image (string:200)
Product image URL.
awb (string:15)
AWB number or shipment reference.
shipDate (date)
Date when the product will be shipped by the Vendor.
Date format: YYYY-MM-DD
availableFrom (date)
Date when the product will be available.
Date format: YYYY-MM-DD
lotNumber (integer:10string)
Lot number.
isAssorted (bolean)
If the product is assorted or contains breakdowns.
Valid values: True | False
breakdowns (array)
An array of breakdowns.
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.
| Code Block |
|---|
{
"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
}
]
}
]
} |