carrier.list

Overview

This method returns a list of carriers ordered by the carrier name.

Request

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

Input parameters:

• authenticationToken (required): Komet Sales security token.
• id: Komet Sales internal carrier id. This field is very useful in other methods.
• code: Carrier code.
• name: Carrier name.
• active (1 or 0): Carrier active.

You can send other 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.

Response

Output:

• status
• message
• carriers: array of carriers
  • id
  • name
  • code
  • active

{
    "status": "1",
    "message": "OK",
    "carriers": [
        {
            "id": "1",
            "name": "Carrier I",
            "code": "CI",
            "active": "1"
        }
        ,
        {
            "id": "2",
            "name": "Carrier II",
            "code": "CII",
            "active": "0"
        }
    ]
}