Versions Compared

Key

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

This method allows you to add a new Carrier in Komet Sales.

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "company-token" , "api" , "carrier-setup" )

Request


URL: https://api.kometsales.com/api/carrier.add

Method: POST

Content-Type: application/

json

JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


name (required)(string:200)

Carrier name.


code (required)(string:10)

Carrier code.


capacity (optional)(integer:10)

Carrier capacity in cubes.


Code Block
{
   "authenticationToken":"token_info_goes_here",
   "name":"Armellini",
   "code":"AR",
   "capacity":"200"
}

Response

Output


status (integer:1)

: transaction

Transaction status.

1 for success or 0 for failure.

Valid values: 1 = Success | 0 = Failure


message (string:500)

: description of the status of the transaction

Transaction status description.


carrierId (integer:20)

: carrier

Komet Sales internal Carrier ID

that was just created

.

Sample Response


Code Block
{
   "status":"1",
   "message":"The carrier was successfully saved.",
   "carrierId":234234
}
Filter by label (Content by label)showLabelsfalsemax5titleRelated Articlescqllabel in ( "company-token" , "api" , "carrier-setup" )