Overview

Returns a list of box types ordered by the box type code. 

Request

https://api.kometsales.com/api/boxtype.list

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

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • id (optional)(integer:20): Komet Sales internal Box Type ID.
  • code (optional)(string:3): code of the box type.


Sample
 https://api.kometsales.com/api/boxtype.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.
  • boxtypes: array of box types
    • id (integer:20): Komet Sales internal Box Type ID.
    • code (string:3): code of the box type.
    • fbe (decimal:10,2): Full Box Equivalence.

Sample
{
    "status": "1",
    "message": "OK",
    "boxtypes": 
    [
        {
            "id": "1",
            "code": "HB",
            "fbe": "0.5"
        }
        ,
        {
            "id": "2",
            "code": "QB",
            "fbe": "0.25"
        }
    ]
}
Related Articles

Information

This method can be executed with tokens type company and vendor.