| Excerpt |
|---|
Use this method to get a list of the current items in the |
Hard-Goods Inventory.
|
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Request
Method: GET
URL: https://api.kometsales.com/api/hardgood/inventory.list
Method: GET
Content-Type: URL Parameters .
Header
authenticationToken (required)(string:50)
Komet Sales security token.
Input Parameters
locationId (required)(integer:20)
Komet Sales internal Location ID.
Only applies to Multi-Location companiesCompanies.
You can get this value from the location.list API method.
vendorCode (optional)(string:50)
Code of the Vendor that supplies the products.
You can get this value from the vendor.list API method.
sku (optional)(string:50)
The inventory item SKU number.
category (optional)(string:100)
Category name.
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/hardgood/inventory.list?authenticationToken=token_info_goes_here&locationid=2321 |
Response
inventoryItems (array)
An array containing available inventory items.
inventoryIds (string:200)
Inventory Item IDs that represent the lines listed separated by commas.
vendorId (integer:20)
Vendor Komet Sales internal ID.
productId (integer:20)
Komet Sales internal product ID.
productVendorId (integer:20)
The Vendor ID.
productDescription (string:200)
Product description.
locationCode (optional)(string:10)
The Location code.
Only applies to Multi-Location companies.
locationName locationName (string:200)
Location name.
locationId (integer:20)
Komet Sales internal Location ID.
categoryId (integer:20)
Komet Sales internal category ID.
category (string:200)
Category description.
subcategory (string:200)
Subcategory description.
color (string:100)
Product color.
sku (string:50)
Product SKU.
quantity (integer:20)
Available quantity.
packSize (integer:20)
Number of units per box.
totalUnits (integer:20)
Total available units regardless of the product pack quantity.
unitPrice (decimal:10,2)
Individual unit price.
image (string:200)
Product’s image URL.
unitCost (decimal:10,2)
Individual unit cost.
unitLandedCost (decimal:10,2)
The total landed cost per unit in the inventory.
message (string:500)
Transaction status description.
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
| Code Block | ||
|---|---|---|
| ||
{
"inventoryItems": [
{
"inventoryIds": "69",
"vendorId": 6322,
"productId": 652,
"productVendorId": 27,
"productDescription": "Alcatraz negro ( Soft thing )",
"locationCode": null,
"locationName": null,
"locationId": null,
"categoryId": 13371,
"category": "Soft thing",
"subcategory": "Margaritas",
"color": "negro",
"sku": "11111",
"quantity": 183,
"packSize": 3,
"totalUnits": 549,
"unitPrice": 2003.32,
"image": null,
"unitCost": 1.2,
"unitLandedCost": 1.2
}
],
"message": "OK",
"status": "1"
} |