Overview

This method returns a list of carriers.

Request

URL: 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.

Note
You can send parameters such as

the ID

Id, code, and name

in order

to filter the results. Filtering by

ID

id and code uses an exact match. Filtering by name uses a "LIKE" expression. Filters are not case sensitive.

Sample Request

Code Block
language js theme Confluence title Sample
https://api.kometsales.com/api/carrier.list? authenticationToken=token_info_goes_here

Response

Output

• carriers: array of carriers:

  • id (integer:20): Komet Sales internal carrier Id.

  • code (string:10): code of the carrier.

  • name (string:200): name of the carrier.

  • active (boolean:1): 1 if the carrier is active, 0 if the carrier is not active.

  • street (string: 50?): the street address

  • city (string: 50?): the name of the city.

  • state(string:50?): the name of the state

  • zipCode(string:20?): the postal code of the carrier's address

  • country(string:50?): the name of the country

  • phone(integer:20?): the phone number of the carrier.

  • kometNetworkName (string:20): Name of the carrier mapped in the Komet Network Codes master data.

  • kometNetworkId (integer:5): Unique identifier of the carrier mapped in the Komet Network Codes master data.

Elite soft json viewerwidth100%languagejsthemeConfluencetitleSampleheight350

• status (integer:1): transaction status. 1 for success or 0 for failure.

• message (string:500): description of the status of the transaction.

Sample Response

Code Block

{ "status": "1", "message": "OK", { "carriers": [ { "id": 1360, "code": "AA", "name": "AA - American Airlines", "active": 1, "street": "Air Canada Centre 14000, Station Airport", "city": "Dorval", "state": "Québec", "zipCode": "1273", "country": "USA", "phone": "1 (888) 247-2262", "kometNetworkName": "Air Canada", "kometNetworkId": 4232 }, { "id": 1361, "code": "AAE", "name": "AAE-Armellini Air Express", "active": 1, "street": "2811 NW 74th Ave", "city": "Doral", "state": "Florida", "zipCode": "33122", "country": "USA", "phone": "(305) 592-5933", "kometNetworkName": "Armellini", "kometNetworkId": 1204 } ], ]"message": "OK", "status": 1 }