METUS API Hub
Warranty Next-Gen
Warranty Next-Gen

POST

Register a warranty with per-unit install dates (Trane next-gen)

POST
https://api.metahvac.com
/warranties/next-gen/v1.0/register

Submits a new warranty registration with per-unit install dates. This endpoint is designed for Trane and takes over business logic from Tavant-provided scripts. Unlike the legacy v1.0 and v2.0 endpoints which use a single installDate for all units, this next-gen endpoint allows each unit to have its own installation date. This is critical for multi-unit installations where equipment is installed over time. Uses v2-style structured errors (code + message) for better machine-readability.

Register a warranty with per-unit install dates (Trane next-gen) › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Register a warranty with per-unit install dates (Trane next-gen) › Request Body

type
​string · enum · required

Who is registering the warranty. Drives which contractor field is required: Homeowner → contractor.name; Contractor → contractor.salesforceId.

Enum values:
Homeowner
Contractor
​object · required
​object · required

Required field depends on type. When type=Contractor, salesforceId is required (name is optional). When type=Homeowner, name is required (salesforceId is ignored).

​object[] · minItems: 1 · required

At least one unit is required. Each unit must have its own installDate.

comments
​string

Optional comments for the registration.

source
​string

Optional originating system or channel identifier; forwarded to Salesforce.

registrationNumber
​string

Optional pre-assigned warranty registration number. If provided, this number will be stored in Salesforce and returned as the warrantyNumber in the response. If not provided, the system will generate one.

​object

Optional warranty term overrides (years).

propertyType
​string

Optional property type classification (e.g., Residential, Commercial).

Register a warranty with per-unit install dates (Trane next-gen) › Responses

Warranty registration successful - all units registered successfully

success
​boolean

True when at least one unit was registered successfully.

​object
​object[]

Empty array on success. Request-level validation or system errors are here. Unit-level errors are in data.unitResults[].error.