Overview

This method allows you to update an existing carrier in Komet Sales.

Request

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): Komet Sales internal ID of the carrier that you want to update. You can obtain this value from the carrier.list API method.
  • name (required)(string:200): name of the carrier.
  • code (required)(string:10): code of the carrier.
  • active (optional)(boolean:1): 1 if the carrier is active, 0 if the carrier is not active.
  • capacity (optional)(integer:10): capacity of the carrier in cubes.

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

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • carrierId (integer:20): carrier internal ID that was just updated.

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