Register a warranty with per-unit install dates (Trane next-gen)
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.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
typestring · enum · requiredWho is registering the warranty. Drives which contractor field is required: Homeowner → contractor.name; Contractor → contractor.salesforceId.
Enum values:HomeownerContractorcustomerobject · requiredcontractorobject · requiredRequired field depends on type. When type=Contractor, salesforceId is required (name is optional). When type=Homeowner, name is required (salesforceId is ignored).
unitsobject[] · minItems: 1 · requiredAt least one unit is required. Each unit must have its own installDate.
commentsstringOptional comments for the registration.
sourcestringOptional originating system or channel identifier; forwarded to Salesforce.
warrantyTermsobjectOptional warranty term overrides (years).
propertyTypestringOptional property type classification (e.g., Residential, Commercial).
Responses
Warranty registration successful
statusintegersuccessbooleanTrue when the registration was accepted.
messagestringdataobjecterrorsobject[]Null on success. When errors occur, contains array of error objects with code and message.
versionstring