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
id
andcode
uses an exact match.Filtering by
name
uses 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 idCarrier ID.
name (optional)(string:200):
Carrier name of the carrier.
code (optional)(string:10):
Carrier code of the carrier.
active (optional)(boolean:1): 1 if the carrier is active, 0 if the carrier is not active.
Note |
---|
|
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 of carriers:(array)
An array containing Carriers.
id (integer:20):
Komet Sales internal carrier IdCarrier ID.
code (string:10):
Carrier code of the carrier.
name (string:200):
Carrier name of the carrier.
active (boolean:1): 1 if the carrier is active, 0 if the carrier is not active.
If the Carrier is active.
Valid values: 1 = Yes | 0 = No
street (string: 50?): the
The Carrier’s street address.
city (string: 50?): the name of the )
The Carrier’s city.
state(string:50?): the name of the state)
The Carrier’s state.
zipCode(string:20?): the postal code of the carrier's address)
The Carrier’s ZIP code.
country(string:50?): the name of the country)
The Carrier’s country.
phone(integer:20?): the
Carrier phone number of the carrier.
kometNetworkName (string:20): Name of the carrier mapped in the
Komet Network Codes master dataCarrier name.
kometNetworkId (integer:5): Unique identifier of the carrier mapped in the
Komet Network Codes master dataCarrier ID.
status (integer:1): transaction
Transaction status. 1 for success or 0 for failure.
Valid values: 1 = Success | 0 = Failure
message (string:500): description of the status of the transaction
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 } |