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 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/drs/partner/page/{pageType}?vendorCode={vendorCode}&modelId={modelId}&exitUri={exitUri}&settings=true

The pageType indicates which Dash replenishment settings page to open in the Alexa app. For details about page types, see Dash replenishment page types.

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. For websites, use the following endpoints based on the location of the customer. The pageType indicates which page to open on the Alexa website. For details about valid page types, see Dash replenishment page types. To access the Dash page, the customer must sign in with their Amazon account credentials.

Region Endpoint

European

https://drs-web-eu.amazon.co.uk/drs/partner/page/{pageType}?vendorCode={vendorCode}&modelId={modelId}&exitUri={exitUri}&settings=true

North American

https://drs-web.amazon.com/drs/partner/page/{pageType}?vendorCode={vendorCode}&modelId={modelId}&exitUri={exitUri}&settings=true

Far East

https://drs-web.amazon.co.jp/drs/partner/page/{pageType}?vendorCode={vendorCode}&modelId={modelId}&exitUri={exitUri}&settings=true

Path parameters

Include the following parameters in your URI path to specify the path in the Alexa app or website to redirect your customers to.

Parameter Located in Description Type Required

pageType

Path

Indicates the Dash settings page to open in the Alexa app or website.

Page type strings

Yes

vendorCode

Query

Amazon identifier for a vendor organization. To obtain your vendor ID, see Locate your customer ID and vendor ID. Include based on the page type.

String

No

modelId

Query

Unique identifier for your device. Must match the model ID in the Dash console.
Include based on the page type.

String

No

exitUri

Query

URL to route customers back to your app or website after completing Dash replenishment settings in the Alexa app. You must include a schema in the URL. Before routing, Alexa validates the URL and adds it to the allow list.
Include if you want Alexa to route the customer back to your app or website.
Valid values: a deep-link or website URL

String

No

settings

Query

Required for page types that update settings.
Valid value: true

Boolean

No

returnUrl

Query

Required for landing page type only.
Valid value: /dart_device_list

String

No

Page types

The following table shows the page type values and the associated Alexa Dash settings pages that the URL opens. For more details, see Dash replenishment settings page types.

Page type Dash replenishment page Used for

dart_landing

Landing page

Education

dart_device_list

Device list

View

settings

Device settings

Settings

product_selection

Supply tracking

Settings

inventory_management

Inventory management

Settings

inventory_history

Inventory history

Settings

installed_inventory

Installed inventory

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.

Copied to clipboard.

https://alexa.amazon.com/spa/index.html#v2/drs/page/dart_landing?vendorCode=your.vendor.id&modelId=your.model.id&returnUrl=/dart_device_list

Browser example

Copied to clipboard.

https://drs-web.amazon.com/dart_landing?vendorCode=your.vendor.id&modelId=your.model.id&returnUrl=/dart_device_list

Required parameters

Page type value Required query parameters Supported inventory sensor types

dart_landing

vendorCode, modelId, returnUrl

Level, usage, and level usage

Device list

View the list of smart reorder capable devices filtered by your vendor ID.

Copied to clipboard.

https://alexa.amazon.com/spa/index.html#v2/drs/partner/page/dart_device_list?vendorCode=your.vendor.id&exitUri=https://your-website-url

Browser example

Copied to clipboard.

https://drs-web.amazon.com/drs/partner/page/dart_device_list?vendorCode=your.vendor.id&exitUri=https://your-website-url

Required parameters

Page type value Required query parameters Supported inventory sensor types

dart_device_list

vendorCode

Level, usage, and level usage

Device settings

Enable customers to change their device settings. Settings options include: update the device friendly name, smart reorder status, and inventory.

Copied to clipboard.

https://alexa.amazon.com/spa/index.html#v2/drs/page/settings?vendorCode=your.vendor.id&modelId=your.model.id&exitUri=https://your-website-url

Browser example

Copied to clipboard.

https://drs-web.amazon.com/settings?vendorCode=your.vendor.id&modelId=your.model.id&settings=true&exitUri=https://your-website-url

Required parameters

Page type value Required query parameters Supported inventory sensor types

settings

vendorCode, modelId, settings(browser only)

Level, usage, and level usage

Supply tracking

Enable customers to change their smart reorder preferences.

Copied to clipboard.

https://alexa.amazon.com/spa/index.html#v2/drs/page/sensor_tracking_selection?vendorCode=your.vendor.id&modelIyour.model.id

Browser example

Copied to clipboard.

https://drs-web.amazon.com/sensor_tracking_selection?vendorCode=your.vendor.id&modelId=your.model.id&settings=true&exitUri=https://your-website-url

Required parameters

Page type value Required query parameters Supported inventory sensor types

sensor_tracking_selection

vendorCode, modelId, settings(browser only)

Level, usage, and level usage

Inventory management

Enable customers to update their household inventory.

Copied to clipboard.

https://alexa.amazon.com/spa/index.html#v2/drs/page/inventory_management?vendorCode=your.vendor.id&modelIyour.model.id&exitUri=https://your-website-url

Browser example

Copied to clipboard.

https://drs-web.amazon.com/inventory_management?vendorCode=your.vendor.id&modelId=your.model.id&settings=true&exitUri=https://your-website-url

Required parameters

Page type value Required query parameters Supported inventory sensor types

inventory_management

vendorCode, modelId, settings(browser only)

Level, usage, and level usage

Inventory history

Enable customers to update their household inventory.

Copied to clipboard.

https://alexa.amazon.com/spa/index.html#v2/drs/page/inventory_history?vendorCode=your.vendor.id&modelIyour.model.id

Browser example

Copied to clipboard.

https://drs-web.amazon.com/inventory_history?vendorCode=your.vendor.id&modelId=your.model.id&settings=true&exitUri=https://your-website-url

Required parameters

Page type value Required query parameters Supported inventory sensor types

inventory_history

vendorCode, modelId, settings(browser only)

Level, usage, and level usage

Installed inventory

Enable customers to update their household inventory.

Copied to clipboard.

https://alexa.amazon.com/spa/index.html#v2/drs/page/installed_inventory?vendorCode=your.vendor.id&modelIyour.model.id

Browser example

Copied to clipboard.

https://drs-web.amazon.com/installed_inventory?vendorCode=your.vendor.id&modelId=your.model.id&settings=true&exitUri=https://your-website-url

Required parameters

Page type value Required query parameters Supported inventory sensor types

installed_inventory

vendorCode, modelId, settings(browser only)

Usage