Update a Carrier

Use this method to update an existing Carrier in Komet Sales.

Valid Tokens: Company.


Related Articles

Request


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

Method: POST

Content-Type: application/JSON


Input Parameters

authenticationToken (required)(string:50)

Komet Sales security token.


carrierId (required)(integer:20)

The Komet Sales internal Carrier ID.

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


name (required)(string:200)

Carrier name.


code (required)(string:10)

Carrier code.


active (optional)(boolean:1)

If the Carrier is active.

Valid values: 1 = Active | 0 = Inactive


capacity (optional)(integer:10)

The Carrier capacity in cubes.


{ "authenticationToken": "token_info_goes_here", "carrierId": 234234, "name": "Armellini", "code": "AR", "capacity": "200" }

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


carrierId (integer:20)

Komet Sales internal Carrier ID.


{ "status": "1", "message": "The carrier was successfully saved.", "carrierId": 234234 }
Peacock