Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to get a list of Box-types ordered by Box-type code.

Tip

Valid Tokens: Company and Vendor.


Filter by label (Content by label)
showLabelsfalse
max6
sorttitle
titleRelated Articles
cqllabel in ( "box-type" , "box-code" , "box-dimensions" , "api-customer" , "api" , "warehouse" , "warehouse-management" )
labelsbox-code box-type

Request


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

Method: GET

Content-Type: URL Parameters


Input parameters

authenticationToken (required)(string:50)

Komet Sales security token.


id (optional)(integer:20)

Komet Sales internal Box-Type ID.


code (optional)(string:3)

The Box-Type code.


Code Block
languagejs
https://api.kometsales.com/api/boxtype.list?
authenticationToken=token_info_goes_here

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


boxtypes (array)

An array containing the Box-Types.


code (string:3)

The Box-Type code.


kometNetworkName (string:5)

The Komet Network Code Box-Type name.


fbe (decimal:10,2)

The Full Box Equivalent.


id (integer:20)

The Komet Sales internal Box-Type ID.


kometNetworkId(integer:4)

The Komet Network Code Box-Type ID.


Code Block
{
    "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
        }
    ]
}

We've encountered an issue exporting this macro. Please try exporting this page again later.