Overview

This method returns a list of additional charges. 

Request

https://api.kometsales.com/api/additional.charge.list

  • Method: GET
  • Content-Type: URL Params.

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • id (optional)(integer:20): Komet Sales internal additional charge id.
  • name (optional)(string:200): name of the additional charge.
  • code (optional)(string:10): code of the additional charge.
  • active (optional)(boolean:1): 1 if the additional charge is active, 0 if the additional charge is not active.

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

Sample
https://api.kometsales.com/api/additional.charge.list?authenticationToken=token_info_goes_here

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • additionalCharges: array of additional charges
    • id (integer:20): Komet Sales internal additional charge Id.
    • name (string:200): name of the additional charge.
    • code (string:10): code of the additional charge.
    • active (boolean:1): 1 if the additional charge is active, 0 if the additional charge is not active.

Sample
{
    "status": "1",
    "message": "OK",
    "additionalCharges": [
        {
            "id": "23243",
            "name": "Fuel Surcharge",
            "code": "FS",
            "active": "1"
        }
        ,
        {
            "id": "23334",
            "name": "Fedex Charge",
            "code": "FC",
            "active": "0"
        }
    ]
}