Overview

This method returns a list of carriers available for a given customer in a specific date range on the E-commerce.

Request

https://api.kometsales.com/api/ecommerce/customer-carriers.list

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

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 Komet Sales team to have this ID. 
  • authenticationToken (required)(string:50): Komet Sales security token.


Input parameters:

  • customerId (required)(integer:20): customer ID, used to search orders from only one customer. You can obtain this value from the customer.list API method.
  • date (required)(date) (date format YYYY-MM-DD): The specific date you want to purchase the item for. 
  • availableFrom (required)(date) (date format YYYY-MM-DD): Date range you want to have the item available. You can obtain this value from the ecommerce/inventory.list API method.
  • availableTo (required)(date) (date format YYYY-MM-DD): Date range you want to have the item available. You can obtain this value from the ecommerce/inventory.list API method.
  • companyLocationId (integer:20): Required if the company is in Multi Location mode. You can obtain this value from the location.list API method.

 

Sample
https://api.kometsales.com/api/ecommerce/customer-carriers.list?customerId=7349&date=2017-06-30&availableFrom=2017-06-29&availableTo=2017-07-06 -H authenticationToken=token_info_goes_here

Response

Output:

    • message (String): description of the transaction status.
    • status (integer:1): transaction status. 1 for success or 0 for failure.
    • carrierId (integer: 10): Komet Sales internal carrier Id. The carrier suggested for the given date. 
    • carrierName (string: 50): name of the carrier. The carrier suggested for the given date. 
    • carriers (Array): array of other available carriers for the given date. 
      • carrierId (integer: 10): Komet Sales internal carrier Id.
      • carrierName (string: 50): name of the carrier.
      • carrierCode (string: 10): code of the carrier.


Sample
{  
   "message":"OK",
   "status":1,
   "carrierId":4309,
   "carrierName":"35EN"
   "carriers":[  
      {  
         "carrierId":4309,
         "carrierName":"Armellini",
         "carrierCode":"AR"
      },
      {  
         "carrierId":1357,
         "carrierName":"Prime",
         "carrierCode":"PR"
      }
   ]
}