Page Comparison

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

Request

URL: 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.

curl

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

  • code (string:3): code of the box type.

  • kometNetworkName (string:5) : name of the boxType mapped in the Komet Network Codes master data.

  • fbe (decimal:10,2): Full Box Equivalence.

  • id (integer:20): Komet Sales internal Box Type ID.

  • kometNetworkId(integer:4): Unique identifier of the boxType mapped in the Komet Network Codes master data.

Sample Response

{
    "status": "1",
    "message": "OK",
    "boxtypes": 
    [
         {
            "code": "FB",
            "kometNetworkName": "FB",
            "fbe": 1,
            "id": 1056,
            "kometNetworkId": 900
        },
        {
            "code": "HB",
            "kometNetworkName": "HB",
            "fbe": 0.5,
            "id": 1057,
            "kometNetworkId": 901
        }
    ]
}