Skip to main content

ClassIT+ API Methods: SupplementBatch

Updated
ClassIT+™

The SupplementBatch method retrieves the Supplement data in batches. 

Information.svg

This method is only available on Production during the following window:
- Start: 1 week/7 days before Supplement’s Effective Date.
- End: 30 days after the Supplement’s Effective Date.

Batch requests will not impact monthly thresholds.

Method Definition

Http Method: POST

Authorization header: Bearer JWT

The SupplementBatch API method does not require any parameters other than the authentication token for authorization. 

Parameter Name Description Data Type
None required This method does not take any parameters other than the authentication token used for authorization.
 		  

Method Request

Method JSON Request

Result Status Result JSON String
Http Method POST
BODY 
None required

Method Result

Method JSON Result

Result Status Result JSON String
Success {
  "newArticles": [
      {
          "articleNumber": "12700",
          "description": "ALLOYS GROUP:",
          "grouping": "ALLOYS GROUP",
          "tariffIssue": "AY",
          "supplement": "1",
          "articlePointer": "0",
          "classification": "",
          "issueDate": "0001-01-01T00:00:00+00:00",
          "effectiveDate": "0001-01-01T00:00:00+00:00",
          "cancellationDate": "0001-01-01T00:00:00+00:00",
          "articleSubItems": [],
          "isHazardous": false,
          "isSpecialHandling": false,
          "subGrouping": null,
          "isCanceled": false,
          "canceledReference": null
      },
      {
          "articleNumber": "12710",
          "description": "Alloys, viz., see Note, item 12711:Aluminum-manganese-silicon, in bags, boxes or drums;Briquettes, manganese of:",
          "grouping": "",
          "tariffIssue": "AY",
          "supplement": "1",
          "articlePointer": "12700",
          "classification": "",
          "issueDate": "0001-01-01T00:00:00+00:00",
          "effectiveDate": "0001-01-01T00:00:00+00:00",
          "cancellationDate": "0001-01-01T00:00:00+00:00",
          "articleSubItems": [
              {
                  "item": "Sub 1",
                  "description": "Less than 1",
                  "classification": "400"
              },
              {
                  "item": "Sub 2",
                  "description": "1 but less than 2",
                  "classification": "300"
              },
              {
                  "item": "Sub 3",
                  "description": "2 but less than 4",
                  "classification": "250"
              }
          ],
          "isHazardous": false,
          "isSpecialHandling": false,
          "subGrouping": null,
          "isCanceled": false,
          "canceledReference": null
      }
  ],
  "amendedArticles": [        
      {
          "articleNumber": "12740",
          "description": "NOTE-Applies only on articles that have not been cut to a pattern or marked with a design.",
          "grouping": "NOTE-Applies only on articles that have not been cut to a pattern or marked with a design.",
          "tariffIssue": "AY",
          "supplement": "1",
          "articlePointer": "0",
          "classification": "",
          "issueDate": "0001-01-01T00:00:00+00:00",
          "effectiveDate": "0001-01-01T00:00:00+00:00",
          "cancellationDate": "0001-01-01T00:00:00+00:00",
          "articleSubItems": [],
          "isHazardous": false,
          "isSpecialHandling": false,
          "subGrouping": null,
          "isCanceled": false,
          "canceledReference": null
      },
      {
          "articleNumber": "150500",
          "description": "NOTE-Does not apply on wood 'Pallets; Platforms; Skids or Shipping Racks, NOI,' as named in item 150400.",
          "grouping": "NOTE-Does not apply on wood 'Pallets",
          "tariffIssue": "AY",
          "supplement": "1",
          "articlePointer": "0",
          "classification": "",
          "issueDate": "0001-01-01T00:00:00+00:00",
          "effectiveDate": "0001-01-01T00:00:00+00:00",
          "cancellationDate": "0001-01-01T00:00:00+00:00",
          "articleSubItems": [],
          "isHazardous": false,
          "isSpecialHandling": false,
          "subGrouping": null,
          "isCanceled": false,
          "canceledReference": null
      },
      {
          "articleNumber": "160500",
          "description": "Yarn, NOI, in bales, boxes or Packages 2015, 2017, 2018, 2120, 2123, 2151, 2152, 2153, 2154, 2155, 2156 or 2295, subject to Item 170 and having a density in pounds per cubic foot of:",
          "grouping": "Yarn",
          "tariffIssue": "AY",
          "supplement": "1",
          "articlePointer": "0",
          "classification": "",
          "issueDate": "0001-01-01T00:00:00+00:00",
          "effectiveDate": "0001-01-01T00:00:00+00:00",
          "cancellationDate": "0001-01-01T00:00:00+00:00",
          "articleSubItems": [
              {
                  "item": "Sub 1",
                  "description": "Less than 1",
                  "classification": "400"
              },
              {
                  "item": "Sub 2",
                  "description": "1 but less than 2",
                  "classification": "300"
              },
              {
                  "item": "Sub 3",
                  "description": "2 but less than 4",
                  "classification": "250"
              }
          ],
          "isHazardous": false,
          "isSpecialHandling": false,
          "subGrouping": null,
          "isCanceled": false,
          "canceledReference": null
      }
  ],
  "canceledItemNumbers": [
      "40775",
      "40776",
      "40777",
      "40778",
      "40779"
  ],
  "message": "",
  "success": true
} 
Failure {
   "newArticles": [],
   "amendedArticles": [],
   "canceledItemNumbers": [],
   "message": "The batch is not currently available. Please try again between 2025-07-11 00:00:00Z and 2025-08-10 00:00:00Z (UTC).",
   "success": false
} 

Result Definition

JSON Properties Description Data Type
success Identifies if the method call completed successfully.
  • Boolean

  • Valid Values:

    -True

    -False
message Result message.
  • String
newArticles Gets or sets the list of newly created articles in the batch, represented as search result DTOs.
  • Array of ArticleSearchItemDto objects
amendArticles Gets or sets the list of amended (updated) articles in the batch, represented as search result DTOs
  • Array of ArticleSearchItemDto objects
canceledItemNumbers List of item numbers that have been canceled in this batch.
  • Array of strings

ArticleSearchItemDto Object Type

Description: Represents a full article item in the search results, including detailed metadata, description, and associated sub-items.

JSON Properties Description Data Type
articleNumber The number of the article. 
  • String
description The full description of the article. 
  • String
grouping The title of the article rule description.
  • String
tariffIssue The tariff issue related to the article. 
  • String
supplement The supplement associated wiht the article.
  • String
articlePointer The article pointer or reference identifier.
  • String
classification The classification of the article. 
  • String
issueDate The issue date of the article.
  • DateTimeOffset
effectiveDate The effective date when the article becomes valid.
  • DateTimeOffset
cancelationDate The cancellation date when the article is no longer valid.
  • DateTimeOffset
articleSubitems List of sub-items related to the article.
  • Array of ArticleSubItem objects
isHazardous The item represents a hazard.
  • Boolean
isSpeacialHandling The item is related to handling instructions.
  • Boolean
subGrouping Sub-Generic heading.
  • String
isCanceled Indicates whether the article was canceled based on the disposition bulletin data.
  • Boolean
canceledReference Contains the new item number if the article was canceled and replaced.
  • String

ArticleSubItem Object Type

Description: Represents a sub-item or component within an article, such as a section, image, link, or other content.

JSON Properties Description Data Type
item The name or identifier of the sub-item within the article.
  • String
description The detailed description of the sub-item.
  • String
classification The classification or category of the sub-item within the article.
  • String

 

 

 

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

Related articles