Check warranty status for a specific product
Looks up a customer's warranty coverage by matching both the product serial number and model number. Returns the warranty status and product information if a record is found.
query Parameters
serialNumberstring · requiredThe product serial number to look up.
modelNumberstring · requiredThe product model number to look up.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Successful warranty lookup
successboolean · requireddataobject · requirederrorsstring[] · requiredversionstring · required
Register a warranty
Submits a new warranty registration. Requires customer info, contractor info, install date, and at least one unit (model + serial). Returns the generated warranty number and per-unit warranty details from Salesforce.
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:HomeownerContractorinstallDatestring · date-time · requiredInstallation date as an RFC3339 timestamp.
customerobject · requiredcontractorobject · requiredRequired field depends on type. When type=Contractor, salesforceId is required (name is ignored). When type=Homeowner, name is required (salesforceId is ignored).
unitsobject[] · minItems: 1 · requiredAt least one unit is required.
registrationCommentsstringOptional comments for the registration.
sourcestringOptional originating system or channel identifier; forwarded to Salesforce.
warrantyTermsobjectOptional warranty term overrides (years).
propertyTypestringOptional property type classification.
Responses
Registration accepted by the upstream registration service, OR the upstream responded but rejected the submission at the application layer (e.g. Tavant returned a non-Success status such as "Already registered under MP00…123"). On acceptance: success is true and data carries the generated warrantyNumber and per-unit details. On application-layer rejection: success is false, errors carries the upstream message, and data is populated with whatever the registration service returned. Transport-level failures surface as 502 with no data block.
statusintegersuccessbooleanTrue when the registration was accepted by the upstream registration service.
messagestringdataobjecterrorsstring[]versionstring