| Excerpt | ||
|---|---|---|
Use this method to get a list of available items from Vendor Availability.
|
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/vendor.availability.items.list
Method: POST
Content-Type: application/json
Input Parameters
authenticationToken (required)(string:50)
Komet Sales security token.
dateFrom (required)(date)
Date when the product becomes available.
Date format: YYYY-MM-DD
dateTo (required)(date)
Date when the product is no longer available.
Date format: YYYY-MM-DD
exactDate (optional)(boolean)
If the dateFrom and dateTo date range should work as it currently works from the Inventory - Add Inventory - Available items screen.
locationId (optional)(integer:20)
Inventory Location ID.
Only applies to Multi-Location Companies.
customerId (optional)(integer:20)
Customer ID.
Use this parameter to get the correct FOB Price based on the settings of the Customer.
shipViaId (optional)(integer:1)
Shipping source.
Valid values: 0 = Warehouse | 1 = Grower
Default is 0.
availableOnly (optional)(boolean)
List only available items.
Valid values: True | False
| Code Block |
|---|
{
"authenticationToken": "your_token_goes_here",
"dateFrom": "2016-11-22",
"dateTo": "2016-11-22",
"customerId": 29559,
"shipViaId":1
} |
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)
Vendor Availability Inventory 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 code or name.
This field is only returned when the Customer sent in the request has permission to see the Vendor code or name.
vendorName (string: 200)
Vendor name.
This field is only returned when the Customer sent in the request has permission to see the Vendor code or name or when the token used does not belong to a specific Customer.
vendorCode (string: 20)
Vendor code.
This field is only returned when the Customer sent in the request has permission to see the Vendor code or name or when the token used does not belong to a specific Customer.
quantity (integer:20)
Available quantity.
The unit is the selected value in the itemType parameter.
itemType (string:5)
Item type.
Valid values: BOX or UN
quantitySold (integer:20)
Quantity sold.
The unit type is the same as the value in the itemType parameter.
originalQuantity (integer:20)
Original quantity.
The unit type is the same as the value in the itemType parameter.
totalUnits (integer:20)
Total units.
The unit type is the same as the value in the itemType parameter.
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)
Number of Units per Box or Pack.
stemsBunch (integer:20)
Number of stems per bunch.
price (decimal:10,2)
Unit price based on the unit type of the product.
postharvest (String:50)
The postharvest of the product.
tag (String:100)
Product tags.
fobPrice (decimal:10,2)
Unit FOB price.
The FOB price is based on the unit type of the product and the Customer given on the filters.
If no Customer given, this value will be the same unit price.
image (string:200)
Product image URL.
availableFrom (date)
Date when the product becomes available.
Date format: YYYY-MM-DD
availableTo (date)
Date when the product stops being available.
Date format: YYYY-MM-DD
| Code Block |
|---|
{
"message": "success",
"status": "1",
"inventoryItems": [
{
"inventoryId": 482594,
"companyProductId": 235229,
"productDescription": "Rose Red 50 cm",
"productCode": "235229",
"grade": "50 cm",
"category": "Rose",
"vendor": "",
"quantity": 116,
"totalUnits": null,
"boxTypeId": 901,
"boxTypeCode": "HB",
"unitType": "Bunch",
"bunches": 12,
"unitsPerBox": 12,
"stemsBunch": 21,
"price": 2.86,
"postHarvest": "ph1",
"tag": "RS-23!",
"fobPrice": null,
"image": "http://d2qenwyttjq8k0.cloudfront.net/7030/product/Image",
"availableFrom": "2016-11-24",
"availableTo": "2016-11-29"
}
]
} |