Overview

This method returns a list of available carriers for a specific customer and dates. The number of days shown on this API method depends on the number of days that your company allows the customers to place orders in advance in the E-commerce site. This method takes into the account the following inventories: On Hand, Future and Vendor Availability. 

Request

https://api.kometsales.com/api/carriers.by.customer.ship.date.list

  • Method: GET
  • Content-Type: URL Params.

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • customerId (required)(integer:20): Komet Sales internal customer ID. You can obtain this value from the customer.list API method.
  • companyLocationId (required)(integer:20):  Required if the company is in Multi Location mode. You can obtain this value from the location.list API method.
  • inventoryOrigin (optional)(integer: 1): 1 for On Hand, 2 for Future Inventory and 3 for Vendor Availability. 

https://api.kometsales.com/api/carriers.by.customer.ship.date.list?authenticationToken=token_info_goes_here&customerId=6236

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • deliverDates: Array of days when the product can be shipped or received by the Customer considering the 
  • defaultCarriersByDate: array of the default carriers for each date specified in the previous array. 
  • carrierDate: array of carriers available for each day.
    • carrierId (integer:20): Komet Sales internal carrier ID.
    • carrierName (string:200): carrier name.

Sample
{ "status": 1,  "message": "OK", "deliverDates": [ "02/29/2016", "03/01/2016" ], "defaultCarriersByDate": { "02/29/2016": { "carrierId": 4232, "carrierName": "Air Canada" }, "03/01/2016": { "carrierId": 4232, "carrierName": "Air Canada" } }, "02/29/2016": [ { "carrierId": 4232, "carrierName": "Air Canada" }, { "carrierId": 4233, "carrierName": "Armellini" }, { "carrierId": 4235, "carrierName": "Fedex" } ], "03/01/2016": [ { "carrierId": 4232, "carrierName": "Air Canada" } ] }