| Excerpt | ||
|---|---|---|
Use this method to get a list of Carriers.
|
You can send parameters such as the id, code and name in order to filter the results. Take the following statements into account when applying filters:
Filtering by
idandcodeuses an exact match.Filtering by
nameuses a "LIKE" expression.Filters are not case sensitive.
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/carrier.list
Method: GET
Content-Type: URL Parameters
Input parameters
authenticationToken (required)(string:50)
Komet Sales security token.
id (optional)(integer:20)
Komet Sales internal Carrier ID.
name (optional)(string:200)
Carrier name.
code (optional)(string:10)
Carrier code.
active (optional)(boolean:1)
If the Carrier is active.
Valid values: 1 = Yes | 0 = No
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/carrier.list? authenticationToken=token_info_goes_here |
Response
carriers (array)
An array containing Carriers.
id (integer:20)
Komet Sales internal Carrier ID.
code (string:10)
Carrier code.
name (string:200)
Carrier name.
active (boolean:1)
If the Carrier is active.
Valid values: 1 = Yes | 0 = No
street (string: 50)
The Carrier’s street address.
city (string: 50)
The Carrier’s city.
state(string:50)
The Carrier’s state.
zipCode(string:20)
The Carrier’s ZIP code.
country(string:50)
The Carrier’s country.
phone(integer:20)
Carrier phone number.
kometNetworkName (string:20)
Komet Network Codes Carrier name.
kometNetworkId (integer:5)
Komet Network Codes Carrier ID.
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
| Code Block |
|---|
{
"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
} |