Overview

This method returns a list of carriers. 

Request

https://api.kometsales.com/api/carrier.list

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

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • id (optional)(integer:20): Komet Sales internal carrier id.
  • name (optional)(string:200): name of the carrier.
  • code (optional)(string:10): code of the carrier.
  • active (optional)(boolean:1): 1 if the carrier is active, 0 if the carrier is not active.

You can send parameters such as the ID, code, and name in order to filter the results. Filtering by ID and code uses an exact match. Filtering by name uses a "LIKE" expression. Filters are not case sensitive.

Sample
https://api.kometsales.com/api/carrier.list?authenticationToken=token_info_goes_here

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • carriers: array of carriers:
    • id (integer:20): Komet Sales internal carrier Id.
    • name (string:200): name of the carrier.
    • code (string:10): code of the carrier.
    • active (boolean:1): 1 if the carrier is active, 0 if the carrier is not active.
Sample
{
    "status": "1",
    "message": "OK",
    "carriers": [
        {
            "id": "23243",
            "name": "Armellini",
            "code": "AR",
            "active": "1"
        }
        ,
        {
            "id": "23334",
            "name": "Prime",
            "code": "PT",
            "active": "0"
        }
    ]
}

 

 

Information

This method can be executed with tokens type company and vendor.