Skip to main content

ClassIT+ API Methods: Package Search

Updated
ClassIT+™

The Package Search method performs a search and retrieves a Package from the itemNumber.

Method Definition

Http Method: POST

Authorization header: Bearer JWT

Keyword Search Method Parameter Name, Description, and Data Type

Parameter Type

Description

Data Type
packageNumber Package number to search. 
  • String
    Min. Length = 2
    Max. Length = 6

Method Request

Package Search Method JSON Request

Result Status

Result JSON String
Http Method POST
Body {
    "packageNumber": “27”
}

Method Result

Package Search Method JSON Result

Result Status

Result JSON String
sucess

{

    "package": {

        "packageNumber": "27",

        "packageSubHeading": null,

        "packageDescriptions": [

            {

                "type": "generic",

                "title": "",

                "text": "In five-ply multiple-wall paper bags meeting the requirements of Item 200, except one ply must be waterproofed."

            }

        ],

        "issueDate": "1899-12-30T06:00:00Z",

        "effectiveDate": "1986-01-01T06:00:00Z",

        "cancellationDate": null,

        "tariffIssue": "AF",

        "packageHeader": null

    },

    "message": "",

    "success": true

}
failure {
   "success": false,
   "message ": "The package number must be between 2 and 6 characters long."
}

Package Search Method Result Definition

JSON Properties

Description

Data Type
success Result message. 
  • Boolean
  • Valid Values: -True -False
message Result message.
  • String
packageNumber Package number.
  • String
packageSubHeading Article package sub heading
  • String
packageDescriptions List of descriptions associated with the article package.
issueDate The issue date of the article package. 
  •  DateTime (nullable)
effectiveDate The effective date of the article package.
  •  DateTime (nullable)
cancelationDate The cancelation date of the article package.
  •  DateTime (nullable)
tariffIssue The tariff issue associated with the article package.
  • String
packageHeader The header for the article package.
  • String

 

 

 

All content © Copyright 2025 National Motor Freight Traffic Association, Inc.™ All Rights Reserved.

Related articles