OpenFLIS API Documentation

To start using the OpenFLIS API, you need to:

• You must use a valid API Key to send requests to the API endpoints. You can get your API key from OpenFLIS’ integrations dashboard.
• In additional to reviewing the detailed OpenFLIS API documentation, you can also make a call to the self-discovering /api/v1/product endpoint, which is designed so that applications and users can learn what data tables are available. This endpoint returns a json object with all data keys (see below) and their underlying tables.
• The data keys that tables are organized under in the OpenFLIS API are: NSN, CAGE, INC, FSC, DODIC
• There are three subscription tiers: Developer, Business, and Enterprise.
• The Developer tier of the API is free to use. However, It has rate and usage limits and is intended for development and not for production use.
• The Business tier allows 10,000 transaction per month.
• If higher volume usage is required beyond what is allowable by the Business tier, contact our customer happiness team at happiness@openflis.com to get on the Enterprise tier
• The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
• The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.

You must include an API key in each request to the OpeNFLIS API with the API-KEY request header.

After you create an api key on the OpenFLIS API integrations dashboard, copy the generated key and add it to each request as a request header with key “API-KEY” and value of your key. You can alternatively provide your key as a querystring parameter with key “API-KEY” and value of your key, but please be aware that this is less secure because your URL is never encrypted even using HTTPS requests.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

API access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

A National Stock Number (NSN) is a 13-digit numerical code that uniquely identifies an “item of supply” used by the United States Department of Defense (DoD) and NATO allies. NSNs are a critical part of the Federal Logistics Information System (FLIS) and play a vital role in global logistics and supply chain management for military and other government entities. Here’s a breakdown of what an NSN consists of and its importance:

Structure of an NSN

• Federal Supply Class (FSC): The first 4 digits of the NSN represent the Federal Supply Class, which categorizes the item into one of the various classes based on its type or function (e.g., electronics, clothing, fuel, medical supplies).
• National Item Identification Number (NIIN): The last 9 digits are the National Item Identification Number, which uniquely identifies each item within its FSC. The NIIN itself is composed of two parts:
  • The first 2 digits (the 5th and 6th digits of the NSN) are the National Codification Bureau (NCB) code, which identifies the country of the item’s initial cataloging (e.g., 00 and 01 for the United States).
  • The remaining 7 digits are a unique number that differentiates each item within its FSC and NCB code.

Example of an NSN

To illustrate, an NSN might look like this: 5961-01-123-4567, where:

• “5961” is the FSC for semiconductor devices,
• “01” indicates the United States as the country of initial cataloging,
• “123-4567” uniquely identifies the specific item within this category.

Importance of NSNs

• Standardization: NSNs ensure standardization of items across the military and NATO allies, facilitating interoperability and logistics planning.
• Efficiency: They streamline procurement, inventory management, and logistics operations by providing a universal language for identifying items.
• Tracking: NSNs allow for the effective tracking and management of items throughout their lifecycle, from procurement to disposal.
• Global Logistics: With NSNs, military forces and government agencies can efficiently coordinate logistics and support operations on a global scale.

Uses of NSNs

NSNs are used in various applications, including but not limited to:

• Procurement: Ordering and purchasing items accurately and efficiently.
• Inventory Management: Tracking and managing stock levels, locations, and movements within the supply chain.
• Logistics Planning: Planning and coordinating logistics operations, including transportation and distribution.
• Maintenance and Support: Managing maintenance schedules and support materials for equipment and systems.

Accessing NSN Data

NSNs are a foundational element of military logistics and supply chain management, ensuring that items can be accurately identified, procured, and managed across the defense sector and among allied nations. When using NSN APIs, set “key” querystring parameter to the NSN that you would like to retrieve.

The Federal Supply Class (FSC) is a key element of the Federal Logistics Information System (FLIS) and plays a critical role in the cataloging and identification process for items of supply within the United States Department of Defense (DoD) and among NATO allies. The FSC is part of the National Stock Number (NSN) system, which is used to identify and classify items that are procured, stocked, and issued within the federal supply system.

Overview of FSC

• Definition: The FSC is a four-digit code that groups items into categories based on their similarity or relatedness in terms of functionality and use. It is the first part of the 13-digit NSN, which uniquely identifies each item of supply.
• Purpose: The main purpose of the FSC is to simplify the process of identifying, cataloging, and stocking items. By categorizing items into classes, the FSC helps in managing the vast array of supplies and equipment used by the military and other federal agencies efficiently.

Key Features of the FSC System

• Standardization: The FSC provides a standardized method for classifying items, facilitating easier management, reporting, and research across the federal supply chain.
• Simplification: It simplifies the procurement and logistics processes by grouping items of similar form and function, making it easier to find and manage items within the supply system.
• Interoperability: Enables interoperability among different branches of the military and with NATO allies by using a common classification system for items of supply.

Examples of Federal Supply Classes

• FSC 1005: Guns, 100 mm through 150 mm
• FSC 5895: Miscellaneous Communication Equipment
• FSC 7025: Computers and Computer Peripheral Equipment

Each FSC code points to a specific category of items, allowing for quick identification and classification within the logistics system.

Usage of FSC

• Procurement: The FSC codes are used in procurement documents, contracts, and requisitions to specify the types of items being requested or supplied.
• Inventory Management: Helps in organizing and managing inventory by categorizing items into manageable groups.
• Logistics Planning: Assists in logistics planning and operations by categorizing equipment and supplies for easier management and planning.

Accessing FSC Data

Data related to FSC codes, including descriptions and listings of the classes, can be accessed through the OpenFLIS API and traditional resources like PUB LOG. These resources provide detailed information about each FSC, including the items it covers, which is crucial for logistics personnel, procurement officers, and supply chain managers in the DoD and allied organizations.

The FSC system is a fundamental part of the military’s logistics and supply chain management infrastructure, facilitating efficient and effective support for military operations and other federal activities.

The Commercial and Government Entity (CAGE) Code is a unique identifier used extensively within the logistics and supply chains of the Department of Defense (DoD) and other federal agencies. It is a five-character alphanumeric code that is assigned to suppliers of various goods and services. CAGE codes facilitate the standardization of company identifications across federal agencies, simplifying procurement and logistics processes by providing a distinct method of identifying a given legal entity at a specific location.

Key Aspects of CAGE Codes

• Issuance: CAGE codes are issued by the Defense Logistics Agency (DLA) through its CAGE Code System. Companies must obtain a CAGE code to do business with the DoD and other federal agencies.
• Purpose: They are used to support a variety of procurement and logistics activities, including bidding on government contracts, registering in government databases (such as the System for Award Management [SAM]), and facilitating payment processes.
• Structure: While primarily numeric, CAGE codes can also include letters, providing a vast range of possible codes to uniquely identify entities.

Applications of CAGE Codes

• Procurement and Contracting: CAGE codes are essential for companies wishing to participate in government contracting opportunities. They are used in the solicitation, award, administration, and payment processes of government contracts.
• Logistics and Supply Chain Management: Within the FLIS and other logistical systems, CAGE codes are used to identify manufacturers and suppliers of items, facilitating the tracking and management of parts and supplies.
• Regulatory Compliance: They help ensure compliance with federal regulations by clearly identifying the source of products and services.

Accessing CAGE Code Information

• Public Databases: Information on CAGE codes is publicly accessible through various databases, such as the System for Award Management (SAM) and the DLA’s official CAGE Search & Inquiry Page, allowing for verification and research of entities registered to do business with the federal government.
• DLA: Direct inquiries and management of CAGE codes, including requests for new codes or updates to existing ones, are handled through the DLA.

Importance of CAGE Codes

CAGE codes play a critical role in maintaining the integrity and efficiency of federal procurement and supply chain operations. They provide a standardized identifier for suppliers, ensuring that contracts are awarded and managed effectively, and that the supply chain is secure and reliable. For businesses, obtaining a CAGE code is a crucial step towards becoming a government contractor or supplier, opening up a wide range of opportunities for working with the federal government.

The Department of Defense Identification Code (DODIC), also known as the DOD Ammunition Code (DODAC), is a unique identifier used by the United States Department of Defense to catalog and manage ammunition and explosives. The DODIC is a critical element in the logistics and supply chain management of military munitions, facilitating the tracking, procurement, storage, and distribution of ammunition across all branches of the military.

Key Features of DODIC

• Four-Character Code: The DODIC consists of a four-character alphanumeric code. The first character is usually a letter, followed by three numeric digits. This structure helps in categorizing and identifying different types of ammunition and explosives.
• Standardization: The DODIC standardizes the identification of munitions, ensuring consistency across the military’s logistics systems and enabling efficient management of ammunition inventories.
• Logistics and Supply Chain Management: It plays a vital role in the logistics and supply chain management processes, from procurement to deployment, by providing a standardized method for identifying and tracking ammunition and explosives.

Usage of DODIC

• Procurement: The DODIC is used in procurement documents and contracts, ensuring that the correct types of ammunition are ordered and supplied.
• Inventory Management: It aids in inventory management by allowing for accurate tracking of ammunition quantities, types, and locations within storage facilities and in the field.
• Safety and Compliance: The DODIC is essential for ensuring safety and regulatory compliance, as it helps in identifying specific handling, storage, and transportation requirements for different types of ammunition.

Accessing DODIC Information

Access to detailed DODIC information is typically restricted to authorized military personnel and defense contractors due to the sensitive nature of ammunition and explosives. Information about specific DODICs may be available through secure military logistics databases or systems, such as those managed by the Defense Logistics Agency (DLA) or within specific branch logistics systems. These systems provide the necessary data for managing the procurement, storage, distribution, and disposal of military munitions.

The DODIC is an essential tool within the military’s logistics and supply chain management framework, ensuring that ammunition and explosives are accurately tracked, managed, and utilized efficiently and safely across all branches of the United States military.

The Item Name Code (INC) is a critical component of the Federal Logistics Information System (FLIS) used by the Department of Defense (DoD) and other federal agencies to standardize the identification of items of supply. The INC is a numeric code that categorizes items based on their name and function, facilitating consistent naming and categorization across the federal supply system.

Key Features of the INC

• Numeric Code: The INC consists of a 5-digit numeric code. Each number is specifically assigned to categories that define items by their form, fit, and function.
• Standardization: The INC supports standardization across the military and federal inventory systems by ensuring that items with the same name and similar functions are categorized under a single code, regardless of the manufacturer or supplier.
• Integration with NSN: The INC is used in conjunction with the National Stock Number (NSN) system. While the NSN uniquely identifies each item, the INC provides a categorization based on the item’s name and function.

Usage of the INC

• Cataloging: The INC is essential for the cataloging process, helping to organize items into a coherent system that facilitates easy identification and retrieval.
• Procurement: In procurement processes, the INC aids in ensuring that solicitations and contracts refer to the correct category of items, thereby reducing errors and mismatches.
• Logistics and Supply Chain Management: For logistics and supply chain management, the INC enables more efficient inventory control, storage, and distribution by categorizing items in a standardized manner.

Accessing INC Information

Access to detailed INC information, as part of the FLIS data, is typically available to authorized military personnel, government employees, and defense contractors through specific logistics and procurement systems. These systems might include the Defense Logistics Agency’s (DLA) logistics information services or other secure federal databases. The INC data aids in the management, procurement, and logistical support of items across the federal supply chain.

The use of the INC, along with other standardized codes and systems like the NSN and FSC, ensures that the DoD and federal agencies can manage their inventories efficiently, support interoperability, and enhance the overall effectiveness of federal logistics and supply chain operations.