Get a list of E-Commerce Carriers

Use this method to get a list of available E-Commerce Carriers for a given Customer in a specific date range.

Valid Tokens: Company and Customer.


Related Articles

Request


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

Method: GET

Content-Type: URL Parameters


Headers

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

Sales channel.

Valid values: "WEB_APP", "MOBILE_APP", "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 used to search orders from only one customer.

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


date (required)(date) 

The purchasing date.

Date format: YYYY-MM-DD 


availableFrom (required)(date)

The date when the product will be available.

You can get this value from the ecommerce/inventory.list API method.

Date format: YYYY-MM-DD 


availableTo (required)(date)

The date when the item stops being available. 

You can get this value from the ecommerce/inventory.list API method.

Date format: YYYY-MM-DD 


companyLocationId (integer:20)

The Company Location ID.

Only applies to Multi-Location Companies.

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


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


message (string)

Transaction status description.


carrierCubeRate (decimal:10,2)

Cube Rate set per Customer and Carrier in the Days of Service setup.


status (integer:1)

Transaction status. 1 = Success | 0 = Failure


carrierId (integer:10)

Komet Sales internal carrier ID of the suggested Carrier for the given date. 


carrierName (string:50)

The name of the suggested Carrier 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)

Carrier name.


carrierCode (string:10)

Carrier code.


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