Schemas
ProductCatalogListResponse
successPagination information
ProductCatalogItem
skuBrand model number (SKU)
srnService reference number
typeHuman-readable product type
HATEOAS links for a catalog item
ProductCatalogLinks
selfURL to the full product record at its type-specific endpoint
PairingListSuccessResponse
successPairings list with embedded pagination
PairingSuccessResponse
successA product pairing or relationship record
ModelInfo
nameabbreviationshortDescriptionlongDescriptionUnitAhriInfo
refNumAHRI reference number
typeAHRI certification type (e.g. 'Ducted'). Not present in V5 data.
PairingListData
Pagination information
PairingData
idProduct relationship ID
typeRelationship type
AHRI reference numbers for a pairing
System-level performance data measured for the pairing (IDU+ODU tested together). Null if no performance data is available. All section fields are always present — null when no data exists for that section.
Pairing-level certification flags. Each key is a certification name and the value indicates whether the pairing holds that certification.
Products in this pairing (1-3 units: P1 always present, P2 for Pairing/Combinations, P3 for Combinations only)
PairingAhriInfo
ductedAHRI ducted reference number
nonductedAHRI non-ducted reference number
mixedAHRI mixed reference number
PairingPerformanceInfo
Efficiency ratings (SEER2, HSPF2, EER2). Dimensionless — fields return a {value} or {min, max} object.
Cooling capacity and power input at standard AHRI test conditions.
Heating capacity and power input at standard AHRI test conditions.
Coefficient of performance at various test conditions. All values are dimensionless numbers.
Sound pressure levels at various fan speeds and conditions (dB (A)).
Airflow rates at various fan speeds and conditions.
System-level electrical performance data.
Other performance data (e.g. connected capacity ranges). Same metric/imperial measurement format.
PairingProduct
idProduct ID
nameProduct name
skuBrand model number (SKU)
categoryProduct category
seriesNameSeries name
HATEOAS links for a product within a pairing
PairingProductLinks
selfPath to the full unit record
PaginationMetadata
countResults per page
pageCurrent page number
offsetOffset in the result set
totalTotal matching records
totalPagesTotal pages available
ErrorResponse
successAlways false for errors
dataAlways null for errors
ErrorObject
codeMachine-readable error code (e.g. VALIDATION, NOT_FOUND, INTERNAL)
messageHuman-readable error message
MeasurementValue
valuePoint measurement value
minMinimum value (for range measurements)
maxMaximum value (for range measurements)
uomUnit of measure (may be absent for dimensionless values)
Measurement
Metric unit value (e.g. W, °C, CMM, mm, kg)
Imperial unit value (e.g. Btu/h, °F, CFM, in, lb)
MeasurementMap
Metric unit value (e.g. W, °C, CMM, mm, kg)
Imperial unit value (e.g. Btu/h, °F, CFM, in, lb)
AirflowSpeedEntry
speedFan speed step number
Measurement at this speed. Either a dual metric/imperial object (for airflow) or a simple value+uom object (for sound pressure).
ProductFeature
nameFeature name
descriptionOptional description of the feature
DigitalAsset
nameAsset name or document title
urlURL to the asset
SubmittalNote
noteNumberNote reference number
descriptionNote text
submittalTypeCategory or type of submittal this note belongs to
superscriptSuperscript label that references this note in spec tables
IndoorUnitData
idInternal product ID.
nameProduct name.
skuBrand model number (SKU).
srnService reference number.
categoryProduct category (INDOOR or OUTDOOR).
subcategoryProduct subcategory.
brandBrand name.
AHRI certification data for a unit. Fields are null when not applicable.
Certification data.
Product features. Empty array if none.
compatibleControlsSKUs of compatible controls.
compatibleAccessoriesSKUs of compatible accessories.
Manuals, submittals, CAD files, and images.
Submittal notes. Empty array if none.
Performance data for an indoor unit.
Technical specification data for an indoor unit.
IndoorPerformanceInfo
Efficiency ratings (SEER2, EER2, HSPF2). Dimensionless — fields return a {value} or {min, max} object.
Cooling performance data with capacity and power input at various conditions.
Heating performance data. Heat pumps have capacity/power at various outdoor conditions. Hydrobox/ATW units have booster heater specifications.
Coefficient of performance data. Dimensionless — fields return {value} or {min, max}.
Sound level data. Heat pump units have indoorCooling1-5 and indoorHeating1-5 fields. Hydrobox/ventilation units have indoorPowerLevel (PWL) and indoorPressureLevel (SPL) fields.
Airflow rate data at various fan speeds and conditions.
Airflow and sound data indexed by fan speed step. Keys are mode names (e.g. heating, fanAirflowRate, soundPressureLevel). Each value is an array of speed-step entries.
Electrical performance data including MOCP, MCA, and power consumption.
Electrical specification data (value + uom, value may be a string).
Other performance data (capacity ranges at specific conditions).
IndoorSpecificationsInfo
Compressor specifications.
Fan specifications.
Refrigerant specifications.
Refrigerant and drain piping specifications.
Water-circuit specifications (hydronic units only).
Physical dimensions and material specifications.
Operating temperature and pressure range specifications.
Product feature specifications.
Brand-specific model or part codes.
General specifications.
OutdoorUnitData
idInternal product ID.
nameProduct name.
skuBrand model number (SKU).
srnService reference number.
categoryProduct category (INDOOR or OUTDOOR).
subcategoryProduct subcategory.
brandBrand name.
AHRI certification data for a unit. Fields are null when not applicable.
Certification data.
Product features. Empty array if none.
compatibleControlsSKUs of compatible controls.
compatibleAccessoriesSKUs of compatible accessories.
Manuals, submittals, CAD files, and images.
Submittal notes. Empty array if none.
Performance data for an outdoor unit.
Technical specification data for an outdoor unit.
Other product attributes (outdoor units). Uses the same mixed measurement format as performance data.
OutdoorPerformanceInfo
Efficiency ratings (SEER2, EER2, HSPF2). Dimensionless — fields return a {value} or {min, max} object.
Cooling performance data with capacity and power input at various conditions.
Heating performance data. Heat pumps have capacity/power at various outdoor conditions. Hydrobox/ATW units have booster heater specifications.
Coefficient of performance data. Dimensionless — fields return {value} or {min, max}.
Sound level data.
Airflow rate data at various fan speeds and conditions.
Airflow and sound data indexed by fan speed step. Keys are mode names (e.g. heating, fanAirflowRate, soundPressureLevel). Each value is an array of speed-step entries.
Electrical performance data including MOCP, MCA, and power consumption.
Electrical specification data (value + uom, value may be a string).
Other performance data (e.g. connected capacity ranges).
OutdoorSpecificationsInfo
Compressor specifications.
Fan specifications.
Refrigerant specifications.
Refrigerant and drain piping specifications.
Water-circuit specifications.
Physical dimensions and material specifications.
Operating temperature and pressure range specifications.
Product feature specifications.
Brand-specific model or part codes.
General specifications.
BranchControllerUnitData
idInternal product ID.
nameProduct name.
skuBrand model number (SKU).
srnService reference number.
categoryProduct category (INDOOR or OUTDOOR).
subcategoryProduct subcategory.
brandBrand name.
AHRI certification data for a unit. Fields are null when not applicable.
Certification data.
Product features. Empty array if none.
compatibleControlsSKUs of compatible controls.
compatibleAccessoriesSKUs of compatible accessories.
Manuals, submittals, CAD files, and images.
Submittal notes. Empty array if none.
Performance data for a branch controller.
Technical specification data for a BC controller.
BranchControllerPerformanceInfo
Sound level data.
Electrical data including MOCP, MCA, and power consumption.
BranchControllerSpecificationsInfo
Refrigerant specifications.
Piping connection specifications.
Physical dimensions and material specifications.
Product feature specifications.
Brand-specific model or part codes.
General specifications.
BranchBoxUnitData
idInternal product ID.
nameProduct name.
skuBrand model number (SKU).
srnService reference number.
categoryProduct category (INDOOR or OUTDOOR).
subcategoryProduct subcategory.
brandBrand name.
AHRI certification data for a unit. Fields are null when not applicable.
Certification data.
Manuals, submittals, CAD files, and images.
Submittal notes. Empty array if none.
Performance data for a branch box.
Technical specification data for a branch box.
BranchBoxPerformanceInfo
Electrical data for the branch box.
BranchBoxSpecificationsInfo
Refrigerant piping connection sizes per side.
Physical dimensions and material specifications.
Brand-specific model or part codes.
General specifications.
VentilationUnitData
idInternal product ID.
nameProduct name.
skuBrand model number (SKU).
srnService reference number.
categoryProduct category (INDOOR or OUTDOOR).
subcategoryProduct subcategory.
brandBrand name.
AHRI certification data for a unit. Fields are null when not applicable.
Certification data.
Product features. Empty array if none.
compatibleControlsSKUs of compatible controls.
compatibleAccessoriesSKUs of compatible accessories.
Manuals, submittals, CAD files, and images.
Submittal notes. Empty array if none.
Performance data for a ventilation unit.
Technical specification data for a ventilation unit.
VentilationPerformanceInfo
Sound level data for ventilation units.
Airflow and sound data indexed by fan speed step. Keys are mode names (e.g. heating, fanAirflowRate, soundPressureLevel). Each value is an array of speed-step entries.
Electrical data for the ventilation unit.
Other performance data (e.g. capacity ranges).
VentilationSpecificationsInfo
Fan specifications.
Physical dimensions and material specifications.
Operating temperature and pressure range specifications.
Product feature specifications.
Brand-specific model or part codes.
General specifications.
AccessoryUnitData
idInternal product ID.
nameProduct name.
skuBrand model number (SKU).
srnService reference number.
categoryProduct category (INDOOR or OUTDOOR).
subcategoryProduct subcategory.
brandBrand name.
AHRI certification data for a unit. Fields are null when not applicable.
Certification data.
Product features. Empty array if none.
Manuals, submittals, CAD files, and images.
Performance data for an accessory.
Technical specification data for an accessory.
AccessoryPerformanceInfo
Electrical data for the accessory.
AccessorySpecificationsInfo
Refrigerant specifications.
Piping specifications where applicable.
Physical dimensions and material specifications.
Operating range specifications.
Product feature specifications.
Brand-specific model or part codes.
General specifications.