Appliance Assets & Warranty
For property integrations that include Samsung appliances, you can use Asset Information APIs to retrieve information critical to understanding and managing Samsung warranties:
- Serial Number
- Model Code
These two fields are required to later retrieve warranty information, but are also useful for identifying the device during customer support inquiries.
Asset values like serial number and model do not change over the lifetime of the device. Any non-null values returned by these APIs should be seen as safe to persist should you prefer to avoid having to re-query these values.
Usage
There are two ways to obtain asset information about your Samsung appliances:
- Asset Info by Device: Query for a specific asset using the canonical SmartThings Device identifier (
deviceId). - Asset Info by Location:: Query for all assets within a SmartThings Location.
The values returned in these responses are semi-permanent. Consider persisting them alongside any device information persistence you may have. When deviceId is not known, these raw values can optionally be used to query warranty information directly.
Conversely, warranty information is more likely to change over time as warranty terms are updated to reflect renewal or lapse of services.
Query warranty information within the context of a device:
- Warranty Info by Device. Query warranty using the SmartThings device identifier (
deviceId). - Warranty Info by raw values. Query warranty using the raw values:
serialNumber,modelCode.- This is particularly useful if you know these values but cannot obtain them through the SmartThings Asset Info APIs.
- Both serial number and model code should be visible on the physical appliance's asset tag.
You may re-query warranty information as often as your integration requires.
Asset Information APIs
The endpoints found below can help you manage and track Samsung Appliance assets. If you are working with Locations, the device asset information is an extension of the Locations endpoint.
Refer to the Enterprise API specification for more detail about Asset Information.
Asset by Device
When querying for asset info by device, receiving a 404 response indicates that the device is not associated with any asset information, not that the device does not exist.
Asset by Location
List all assets by locationId - you will need to map each returned item by its deviceId to any corresponding known Devices.
When querying for asset information for all devices in a location, the omission of items in the response will indicate that the device is not associated with any asset information. An empty list is not an indicator of the devices being removed from the location.
Warranty Information APIs
Warranty by Device
When querying for warranty info by device, receiving a 404 response may indicate that the device does not exist, but warranty information is only available for devices that have been associated with asset information.
The field warrantyDetailsStatus will indicate the status of the warranty information. A value of PENDING can indicate that SmartThings may require additional time to acquire the information.
If an appliance warranty is expected to exist, follow-up requests should be made until receiving a status of READY.
An appliance warranty is not a requirement, therefore this API may never return a READY status. Allowing Property Managers to assert whether a warranty is expected may be the most logical workflow for your integration.
Query Warranty
Query for warranty information by using the raw values: serialNumber, modelCode. Both fields are required.