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 | https://drs-web-eu.amazon.co.uk |
| North American | https://drs-web.amazon.com |
| Far East | https://drs-web.amazon.co.jp |
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 |
|---|---|---|---|---|
pageType | Path | Indicates the Dash settings page to open in the Alexa app or website. For more details, see Dash replenishment page types. Valid values: Page types | String | Yes |
vendorCode | Query | Amazon identifier for a vendor organization. To obtain your vendor code, sign in to the Dash console, and then select App Settings. 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 |
settings | Query | Required for page types that update settings. Valid value: true | Boolean | No |
exitUri | 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. Before routing, Alexa validates the URL, and then verifies that the URL is on the allow list. Valid value: website URL that includes a schema | 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 |
|---|---|---|
dart_landing_srr | 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 consumption 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.Deep-link example
Browser example
Required parameters
| Page type value | Required query parameters | Supported inventory sensor types |
|---|---|---|
dart_landing_srr | vendorCode, modelId | Level, usage, and level usage |
Device list
View the list of smart reorder-capable devices filtered by your vendor code.Deep-link example
Browser example
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. On the settings page, options include inventory consumption history, smart reorder subscription status, and address and payment configurations.Deep-link example
Browser example
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.Deep-link example
Browser example
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.Deep-link example
Browser example
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 consumption history
Enable customers to view the inventory consumption history for their device.Deep-link example
Browser example
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 device inventory.Deep-link example
Browser example
Required parameters
| Page type value | Required query parameters | Supported inventory sensor types |
|---|---|---|
installed_inventory | vendorCode, modelId,settings(browser only) | Level usage |
