Get the E-commerce Inventory for a specific Customer
Use this method to get the details of E-Commerce Inventory items for a given Customer. This method includes the quantity available based on a specific date.
Valid Tokens: Company and Customer.
Related Articles
-
Delete a Prebook 1.0 (API)
-
-
-
Add Inventory (API)
-
Settings for Multiple Location Companies (Knowledge Base)
Request
URL: https://api.kometsales.com/api/ecommerce/inventory.get
Method: GET
Content-Type: URL Parameters
Headers
X-SALES-CHANNEL (optional) (string: 20)
Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE".
X-ACCOUNT (required)(integer:20)
Company ID that is using the API.
Please ask the Komet Sales team for this ID.
authenticationToken (required)(string:50)
Komet Sales security token.
Input parameters
customerId (required)(integer:20)
Customer ID.
You can get this value from the customer.list API method.
inventoryLineIds (required)(string)
List of IDs of the inventory lines displayed on the e-commerce.
Based on the inventoryOrigin parameter.
For OM inventory it corresponds to the inventoryLineIds.
For FS it corresponds to the purchaseOrderItemsIds.
For VA and K2K inventory it corresponds to vendorAvailabilityItemsIds.
inventoryOrigin (required)(integer:1)
Inventory type.
Valid values: 1 = Open Market | 2 = Future Sales | 3 = Vendor Availability | 4 = K2K
date (required)(date)
The purchasing date.
Date format: YYYY-MM-DD
availableFrom (required)(date)
The date range you want to have the item available if carrierId is not specified.
Date format: YYYY-MM-DD
availableTo (required)(date)
The date range you want to have the item available if carrierId is not specified.
Date format: YYYY-MM-DD
companyLocationId (integer:20)
Company Location ID.
Only applies to Multi-Location companies.
You can get this value from the location.list API method.
carrierId (Integer:20)
The ID of the Carrier that will deliver the products.
You can get this value from the /ecommerce/inventory.list API method.
https://api.kometsales.com/api/ecommerce/inventory.get?
customerId=7349&inventoryLineIds=428720&inventoryOrigin=4&
companyLocationId=13&date=2017-06-30
-H authenticationToken=token_info_goes_hereResponse
message (string)
Transaction status description.
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
inventoryItem (Object)
Inventory item information.
id (integer: 20)
Number that identifies the row between all the records of the result.
inventoryLineIds (string: 200)
List of inventory IDs that belong to the line.
inventoryOrigin (integer:1)
Inventory type.
Valid values: 1 = Open Market | 2 = Future Sales | 3 = VA | 4 = K2K
productDescription (string: 200)
Product description.
productDescriptionEcommerce (string: 500)
Additional description of the product for the E-commerce.
price (decimal: 10,3)
Unit price.
unitType (string: 10)
The unit type.
Valid values: Stem or Bunch.
units (integer: 10)
Number of stems per bunch.
bunches (integer: 10)
Number of bunches per box.
pack (integer: 10)
Number of units per box.
totalBunches (integer: 10)
Total bunches available.
totalUnits (integer: 10)
Total units available, based on the Unit Type.
itemSizeCode (string: 3)
Box type code (HB, QB, FB, etc).
isAssorted (boolean)
True if the product is assorted.
sellFast (boolean)
True if the product was marked as Sell Fast.
productImageUrl (string)
URL for the product image.
vendor (string: 50)
Vendor name of code.
companyProductId (integer:20)
Product ID.
{
"message": "OK",
"status": 1,
"inventoryItem": {
"id": "f4b993da-5cd9-11e7-81aa-2ca9caf6766c",
"inventoryLineIds": "428720",
"productDescription": "Agapanthus Silver Queen",
"productDescriptionEcommerce": null,
"quantity": 10,
"price": 17.56,
"units": 2,
"bunches": 2,
"pack": 2,
"totalBunches": 0,
"totalUnits": 10,
"itemSizeCode": "FB",
"isAssorted": false,
"unitType": "Bunch",
"sellFast": false,
"inventoryOrigin": 4,
"productImageUrl": "http://test.kometsales.com.s3.amazonaws.com/7030/product/217044_250x250.jpg?AWSAccessKeyId=AKIAJCADKODN6ZCRUIYQ&Expires=1498924690&Signature=E8QAUci0ibpj%2F2Jzaf2vXtcmpK4%3D"
}
}