| Excerpt | ||
|---|---|---|
Use this method to get a list of additional charges.
|
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/additional.charge.list
Method: GET
Content-Type: URL Parameters
Input parameters
authenticationToken (required)(string:50)
Komet Sales security token.
id (optional)(integer:20)
Komet Sales internal Additional Charge ID.
name (optional)(string:200)
Additional Charge name.
code (optional)(string:10)
Additional Charge code.
active (optional)(boolean:1)
If the Additional Charge is active.
Valid values: 1 = Active | 0 = Inactive
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/additional.charge.list?authenticationToken=your_token_goes_here&id=123&name=giftpack&code=22&active=1 |
Response
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
additionalCharges (array)
Array of Additional Charges
id (integer:20)
Komet Sales internal Additional Charge ID.
name (string:200)
Additional Charge name.
code (string:10)
Additional Charghe code.
active (boolean:1)
If the additional charge is active.
Valid values: 1 = Active | 0 = Inactive
| Code Block |
|---|
{
"status": "1",
"message": "OK",
"additionalCharges": [
{
"id": "23243",
"name": "Fuel Surcharge",
"code": "FS",
"active": "1"
},
{
"id": "23334",
"name": "Fedex Charge",
"code": "FC",
"active": "0"
}
]
} |