Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to get a list of dates when a product will be available on the E-Commerce for a specific Customer.

Tip

Valid Tokens: Company and Customer.


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "company-token" , "customer-token" , "e-commerce-availability" )

Request


URL: https://api.kometsales.com/api/ecommerce/inventory-available-dates.list

Method: GET

Content-Type: URL Parameters


Headers

X-SALES-CHANNEL (optional) (string: 20)

The Sales channel.

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 for the orders.

You can get this value from the customer.list API method.


inventoryLineIds (required)(string)

The inventory line ID.


inventoryOrigin (required)(integer:1)

The type of inventory.

Valid values: 1 = Open Market | 2 = Future Sales | 3 = Vendor Availability | 4 = K2K


companyLocationId (integer:20)

The Location ID.

Only applies to Multi-Location companies.

You can get this value from the location.list API method.


Code Block
languagejs
https://api.kometsales.com/api/ecommerce/inventory-available-dates.list?
customerId=7349&inventoryLineIds=428720&inventoryOrigin=4&
companyLocationId=13 -H authenticationToken=token_info_goes_here

Response


message (string)

Transaction status description.


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


availableDates (array)

An array containing dates when the product will be available.


availableDateFrom (date)

The date when the product becomes available.

Date format: YYYY-MM-DD


availableDateTo (date)

The date when the product becomes unavailable.

Date format: YYYY-MM-DD


Code Block
{  
   "message":"OK",
   "availableDateFrom":"2017-06-29",
   "availableDateTo":"2017-07-09",
   "status":1,
   "availableDates":[  
      "2017-06-29",
      "2017-06-30",
      "2017-07-01",
      "2017-07-02",
      "2017-07-03",
      "2017-07-04",
      "2017-07-06",
      "2017-07-07",
      "2017-07-09"
   ]
}

We've encountered an issue exporting this macro. Please try exporting this page again later.