/hardgood/inventory.list

This method retrieves a list of the current items in the hard goods inventory. This method works with Company type tokens.

Request

Method: GET

URL: https://api.kometsales.com/api/hardgood/inventory.list

Content-Type: URL Params

Header

• authenticationToken (required)(string:50): Komet Sales security token.

Input Parameters

• locationId (required)(integer:20): Komet Sales internal Location ID. You can get this value from the location.list API method. This only applies to Companies in Multi-Location mode.

• vendorCode (optional)(string:50): Code of the vendor that supplies the items. You can get this value from the vendor.list API method.

• sku (optional)(string:50): SKU associated with the item in the inventory.

• category (optional) (string: 100): Category name.

curl

https://api.kometsales.com/api/hardgood/inventory.list?authenticationToken=token_info_goes_here&locationid=2321

Response

Output

• inventoryItems: array of available inventory items.

  • inventoryIds (string:200): Inventory Item IDs that represents the lines listed separated by commas.

  • vendorId (integer: 20): Vendor Komet Sales internal ID.

  • productId (integer:20): product Komet Sales internal ID.

  • productVendorId (integer:20): ID of the product associated with the vendor.

  • productDescription (string:200): product description.

  • locationCode (optional)(string:10): Location code. It applies for Multi-Location companies.

  • locationName locationName (string:200): location name.

  • locationId (integer:20): Komet Sales internal ID of the location.

  • categoryId (integer:20): Komet Sales internal category ID.

  • category (string:200): category description.

  • subcategory (string:200): subcategory description.

  • color (string:100): color of the product.

  • sku (string:50): SKU of the product.

  • quantity (integer:20): quantity available.

  • packSize (integer:20): number of units per box.

  • totalUnits (integer:20): total units available regardless of the product pack quantity.

  • unitPrice (decimal:10,2): unit price or price per individual unit.

  • image (string:200): The url of the product image, if it exists.

  • unitCost (decimal:10,2): The cost per unit in the inventory.

  • unitLandedCost (decimal:10,2): The total landed cost per unit in the inventory.

• message (string:500): contains status description of request.

• status (integer:1): transaction status. 1 for success or 0 for failure/error.

Sample Response

{
   "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"
}