About Dash Replenishment
You can add the Amazon Dash Replenishment service to your smart home device to enable Alexa to monitor and reorder supplies or replacement parts for your device. After you set up replenishment for the products that your device consumes, your customers can track supply levels within the Alexa app and receive notifications from Alexa when supplies run low or parts need replacement. Customers can set up automatic reordering of these supplies. For example, a printer can report ink usage to Alexa. Alexa keeps track of the ink level, and automatically reorders the low cartridge, so that the customer doesn't run out of ink. Customers pay for products by using the payment options associated with their Amazon account.
You can add the Dash Replenishment service to your Alexa smart home skill, multi-capability skill, or Alexa Connect Kit (ACK) device.
Report consumption with inventory sensors
To report consumption of device supplies or parts, you include inventory sensor APIs in your smart home skill or ACK logic. A device can have one or more consumable product types, such as vacuum filter and bag, and multiple consumable products of the same type, such as magenta, yellow, and cyan ink cartridges.
Each inventory sensor type uses a different method to report consumption. Select the sensor that matches your device detection method and the type of consumable product:
-
Level sensor – A sensor that measures and reports the current remaining inventory. A device with a level sensor usually stores the consumable product internally. The sensor measures the level of the inventory as an absolute count, percentage, volume, or weight. For example, a printer that measures the amount of ink remaining in each cartridge might send the current inventory for each ink color as a percentage. After the customer replaces the consumable product, the device resets the current inventory. To report the amount of a consumable product remaining in your device, implement the
Alexa.InventoryLevelSensor
interface and report the amount with theChangeReport
event. If you don't know when the customer replaces the product, implement theAlexa.InventoryLevelUsageSensor
interface instead. -
Usage sensor – A sensor that knows when the device uses a certain quantity of inventory. The sensor measures the inventory used, expressed as count, volume, or weight. For example, a coffee maker that uses one coffee pod for one brew. A device might know variable amounts. For example, after a small load of wash completes, a washing machine knows the amount of fabric softener used. To report the amount of a consumable product that your device used already, implement the
Alexa.InventoryUsageSensor
interface and report the usage with theInventoryConsumed
event. -
Level usage sensor – A combination sensor that doesn't know the remaining quantity of a consumable product, but knows the amount used, expressed as duration. After a period of time passes, the device reports the usage as a duration. For example, a vacuum with a dust filter reports 1 hour 13 minutes used. When the customer replaces the consumable product, the device informs Alexa by sending an
InventoryReplaced
event. To report the approximate usage of a consumable product installed in your device, implement theAlexa.InventoryLevelUsageSensor
interface and report the usage with theInventoryConsumed
event.
To report inventory consumption to Alexa, your device sends asynchronous events to the Alexa event gateway. For details, see the documentation for the inventory sensor APIs and events that your product supports.
Sensor examples
Level sensor | Usage sensor | Level usage sensor | |
---|---|---|---|
Use when |
You measure the total amount of the consumable remaining. |
You know the relative consumed amount. |
You don't know the total or relative amount, but know the duration used and the total lifespan of the consumable product. |
Example device |
Printer and battery-powered devices, such as cameras and doorbells |
Coffee machine, washing machine, dishwasher |
Vacuum, air purifier |
Example consumable |
Ink, toner, batteries |
Coffee pods, detergent pods |
Brushes, filters |
Report inventory updates |
Each time the level changes or one time per day, whichever occurs first |
Each time consumption occurs |
One time per day report aggregated consumption data |
Example inventory report |
50% remaining, 100 grams remaining, 2.5 liters remaining |
1 pod used, 1 oz used, 30 ml used |
1 hour 13 minutes used |
Automatic reordering in the Alexa app
Customers that connect devices to Alexa and use the Dash Replenishment Service can enable smart reordering in the Alexa app. All smart home skills must enable account linking to connect the identity of the Alexa customer with the customer's identity in your system. After the customer enables the skill, the Alexa app takes the customer through smart reordering setup. Thereafter, the device reports inventory updates to Alexa as the customer uses the device. Then, Alexa sends a notification to the customer or automatically reorders the consumed product.
Manage Dash replenishment settings from your app
You can enable customers to view and update their Dash settings directly from your app or website. Embed the Dash management URLs to redirect customers to the Alexa app or website. There, customers can set up automatic reordering of supplies and replacement parts, update their household inventory, set the date when parts are replaced, and track supply levels. On completion, Alexa can redirect the customer back to your app or website. For details, see Add Dash Device Management to Your App or Website.
The following image shows linking from a smart home device app to the Alexa app settings page to set up smart reordering.
Dash Replenishment prerequisites
To implement Dash Replenishment, you must have the following items:
- A smart home skill or a custom skill with smart home capability. For details, see Steps to Implement a Smart Home Skill and About Multi-capability Skills.
Or, you must have a smart home device integrated with the ACK product components. For details, see What is the Alexa Connect Kit. - Account linking configured for your skill.
- A device with an inventory sensor that reports the status of the consumables on each use, or at least one time per day.
Steps to add Dash Replenishment
To add Dash Replenishment to your smart home skill or ACK device, complete the following steps:
- Choose the right inventory sensor interface for your device.
- Register your device and consumable products on the Dash console. For details, see Register Devices for Dash Replenishment.
Amazon provides replenishment IDs for each consumable product. - Report your replenishment IDs in your discovery response. For details, see the discovery response for the inventory sensor APIs that your product supports.
Alexa.InventoryLevelSensor
,Alexa.InventoryUsageSensor
, andAlexa.InventoryLevelUsageSensor
. - Report a new device capability with
AddOrUpdateReport
. For details, see the documentation for the inventory sensor APIs that your product supports. - Report inventory updates to Alexa as events. You send these events to the Alexa event gateway. For details, see the documentation for the inventory sensor APIs that your product supports.
- Test inventory sensors event reporting.
Note: Validate the implementation on test devices before you promote your skill to production.
- Certify your Dash Replenishment device.
- (Optional) Add Dash Device Management to Your App or Website.
Availability
Dash Replenishment is available in the following locales: de-DE
, en-GB
, en-US
, es-ES
, es-US
, fr-FR
, it-IT
, ja-JP
.
If you have a smart home skill that supports multiple locales, configure your skill for each language that you support and deploy your AWS Lambda function in the region that supports the locale. For details, see Develop Smart Home Skills for Multiple Languages.
Related topics
- Register Devices for Dash Replenishment
- Test Dash Replenishment
- Certify Your Dash Replenishment Device
- Manage Dash Replenishment Devices
- Add Dash Device Management to Your App or Website
Last updated: Jan 26, 2024