Add Dash Device Management to Your App or Website
Implement the Dash device management extension to enable customers to manage their devices directly from your app or website. Embed the Dash management URL to link to a specific settings page. For mobile apps, use deep links to take customers directly to the selected settings page in the Alexa app. For websites, redirect to the selected settings page in a webpage. 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 an overview of Dash Replenishment, see About Dash Replenishment.
Prerequisites
Before you implement the Dash management extension, complete the following prerequisites:
Endpoints
You link to the selected Dash replenishment settings page based on the locale of the customer. Use deep links for mobile apps and URLs for websites.
Endpoints for mobile apps
For mobile apps, use the following endpoint for all locales: https://alexa.amazon.com/spa/index.html#v2
Endpoints for websites
For websites, redirect customers to the selected Dash replenishment page on the Alexa website at the endpoint based on the customer's locale. To access the Dash page, the customer must sign in with their Amazon account credentials.
For websites, use the following endpoints based on the location of the customer.
Region | Endpoint |
---|---|
European |
|
North American |
|
Far East |
|
URL path and query parameters
Use the following URL parameters to link to the specified Alexa Dash settings page:
- Deep link for mobile apps –
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/{pageType}?vendorCode={vendorCode}&modelId={modelId}&exitUri={exitUri}&settings=true
- URL for websites –
<endpoint>/drs/partner/page/{pageType}?vendorCode={vendorCode}&modelId={modelId}&exitUri={exitUri}&settings=true
Path parameters
Include the following parameters in your URL path to specify the settings page in the Alexa app or website to which to redirect your customers.
Parameter | Located in | Description | Type | Required |
---|---|---|---|---|
|
Path |
Indicates the Dash settings page to open in the Alexa app or website.
For more details, see Dash replenishment page types. |
String |
Yes |
|
Query |
Amazon identifier for a vendor organization. |
String |
No |
|
Query |
Unique identifier for your device. Must match the model ID in the Dash console. |
String |
No |
|
Query |
Required for page types that update settings. |
Boolean |
No |
|
Query |
URL to route customers back to your website after completing Dash replenishment settings. Valid for websites only. Include if you want Alexa to route the customer back to your website. Note: To add your URL to the allow list, please contact the Dash Replenishment program.
|
String |
No |
Page types
The following table shows the page type string values and the associated Alexa Dash settings page that the URL opens. For more details, see Dash replenishment settings page types.
Page type | Dash replenishment settings page | Used for |
---|---|---|
|
Education | |
|
View | |
|
Settings | |
|
Settings | |
|
Settings | |
|
Settings | |
|
Settings |
Dash replenishment page types
You specify the page type in the path to open a specific Dash replenishment settings page. The following examples show the North American endpoint. You use the endpoint that matches the customer's locale.
Landing page
Enable customers to view educational content about the Dash replenishment program and how to enroll in smart reordering.
Deep-link example
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/dart_landing_srr?vendorCode=your.vendor.code&modelId=your.model.id
Browser example
https://drs-web.amazon.com/drs/partner/page/dart_landing_srr?vendorCode=your.vendor.code&modelId=your.model.id&exitUri=https://your-website-url
Required parameters
Page type value | Required query parameters | Supported inventory sensor types |
---|---|---|
|
|
Level, usage, and level usage |
Device list
View the list of smart reorder-capable devices filtered by your vendor code.
Deep-link example
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/dart_device_list?vendorCode=your.vendor.code
Browser example
https://drs-web.amazon.com/drs/partner/page/dart_device_list?vendorCode=your.vendor.code&exitUri=https://your-website-url
Required parameters
Page type value | Required query parameters | Supported inventory sensor types |
---|---|---|
|
|
Level, usage, and level usage |
Device settings
Enable customers to change their device settings. On the settings page, options include inventory consumption history, smart reorder subscription status, and address and payment configurations.
Deep-link example
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/settings?vendorCode=your.vendor.code&modelId=your.model.id
Browser example
https://drs-web.amazon.com/drs/partner/page/settings?vendorCode=your.vendor.code&modelId=your.model.id&settings=true&exitUri=https://your-website-url
Required parameters
Page type value | Required query parameters | Supported inventory sensor types |
---|---|---|
|
|
Level, usage, and level usage |
Supply tracking
Enable customers to change their smart reorder preferences.
Deep-link example
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/sensor_tracking_selection?vendorCode=your.vendor.code&modelId=your.model.id
Browser example
https://drs-web.amazon.com/drs/partner/page/sensor_tracking_selection?vendorCode=your.vendor.code&modelId=your.model.id&settings=true&exitUri=https://your-website-url
Required parameters
Page type value | Required query parameters | Supported inventory sensor types |
---|---|---|
|
|
Level, usage, and level usage |
Inventory management
Enable customers to update their household inventory.
Deep-link example
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/inventory_management?vendorCode=your.vendor.code&modelIyour.model.id
Browser example
https://drs-web.amazon.com/drs/partner/page/inventory_management?vendorCode=your.vendor.code&modelId=your.model.id&settings=true&exitUri=https://your-website-url
Required parameters
Page type value | Required query parameters | Supported inventory sensor types |
---|---|---|
|
|
Level, usage, and level usage |
Inventory consumption history
Enable customers to view the inventory consumption history for their device.
Deep-link example
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/inventory_history?vendorCode=your.vendor.code&modelIyour.model.id
Browser example
https://drs-web.amazon.com/drs/partner/page/inventory_history?vendorCode=your.vendor.code&modelId=your.model.id&settings=true&exitUri=https://your-website-url
Required parameters
Page type value | Required query parameters | Supported inventory sensor types |
---|---|---|
|
|
Level, usage, and level usage |
Installed inventory
Enable customers to update their device inventory.
Deep-link example
https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/installed_inventory?vendorCode=your.vendor.code&modelIyour.model.id
Browser example
https://drs-web.amazon.com/installed_inventory?vendorCode=your.vendor.code&modelId=your.model.id&settings=true&exitUri=https://your-website-url
Required parameters
Page type value | Required query parameters | Supported inventory sensor types |
---|---|---|
|
|
Level usage |
Related topics
- Register Devices for Dash Replenishment
- Test Dash Replenishment
- Certify Your Dash Replenishment Device
- Manage Dash Replenishment Devices
Last updated: May 23, 2024