Update store & item status
Marketplace APIs are not yet generally available. Please record interest in early access here.
DoorDash has a set of APIs that allows store level actions to be implemented. This includes deactivating a store, deactivating items and item options, getting store information, and getting store menu information.
Store activation status change
PUT /api/v1/stores/{merchant_supplied_id}/status
DoorDash has a webhook that will allow you to deactivate a store. If there is a situation where a store needs to be deactivated, you will be able to deactivate the store immediately. Include the merchant_supplied_id of the store in the URL parameters. The payloads should have the following format, and are also detailed in the StoreActivationStatus Model:
{
"is_active": false,
"reason": string from list of accepted reasons for deactivation,
"notes": string detailing reason for deactivation,
"end_time": "2023-04-28T01:01:00+01:00"
}
There is a required reason parameter that must be passed within the payload. This reason is for our internal records and implementing the ‘best fit’ for the store deactivation is requested here. Please ensure this parameter is associated with one of the reasons below:
out_of_businessdelete_storepayment_issueoperational_issuesstore_self_disabled_in_their_POS_portalstore_pos_connectivity_issues
Upon sending the Request, you will receive a response code of 200 to confirm that the store was successfully deactivated.
To reactivate the store, send an additional PUT Request to the endpoint. When reactivating a store, the only parameter required in the payload is "is_active": true.
You will receive a response code of 200 to confirm that the store is successfully reactivated. There are a few validations in place on the DoorDash side that are checked before activating a store. You will receive a 400 response in this case. Please do not try on a 400 response, as these will continue to fail until the issue is manually corrected. Due to these checks, the activation webhook could fail do the the following reasons:
- Store banking information is not present
- Store banking information is invalid
- No active POS menus exists at the store
To temporarily deactivate a store with a set end time in the StoreActivationStatus request, please use one of the following:
- “end_time”
- “duration_in_secs” and “duration_in_hours”
If end time and duration are in the request we will honor the DoorDash configured default temporary deactivation duration, not the times sent in the request. The payload should have the below format where the required field are is_active, reason, and notes.
Please notify your TAM if you intend to start sending temporary deactivation webhooks to test & validate the functionality.
{
"is_active": false,
"reason": string from list of accepted reasons for deactivation,
"notes": string detailing reason for deactivation,
"should_send_email": true,
"merchant_supplied_id": "12345_abcd",
"end_time": "2023-04-28T01:01:00+01:00"
}
{
"is_active": false,
"reason": string from list of accepted reasons for deactivation,
"notes": string detailing reason for deactivation,
"should_send_email": true,
"merchant_supplied_id": "12345_abcd",
"duration_in_hours": "24",
"duration_in_secs": "30"
}
Batch Item Activation Status Change
PUT /api/v1/stores/{merchant_supplied_id}/items/status
DoorDash has a webhook that will allow you to stock in/stock out items for a given store (also known as 86'ing). When an item is stocked out, it will be removed from the DoorDash website until it is stocked back in. Instead of using menu updates to deactivate items (which is an expensive operation) it is recommended to use the following calls. In order to do so, please proceed with including the merchant_supplied_id of the store in the URL parameters. This will be in addition to including the merchant_supplied_id of the item that is being deactivated in the Request payload. You will include false to deactivate an item and true to activate an item. The payload should have the following format and is also detailed in the ItemActivation Model:
[{
"merchant_supplied_id": “string”,
"is_active" : false
}]
Batch Item Option Activation Status Change
PUT /api/v1/stores/{merchant_supplied_id}/item_options/status
DoorDash has a webhook that will allow you to remove an item_option from being in stock (also known as 86'ing). In order to do so, please proceed with including the merchant_supplied_id of the store in the URL parameters. This will be in addition to including the merchant_supplied_id of the item_option that is being deactivated in the Request payload. The payload should have the following format and is also detailed in ItemOptionActivation Model:
[{
"merchant_supplied_id": “string”,
"is_active" : false
}]
Please note that you must reactivate an item or itemOption via the endpoints. A menu refresh will not automatically restock the item. Both Item Menu Status and Item Webhook Status must be set to true for an item to appear on the menu. If either the Item Menu Status or the Item Webhooks Status are false, the item will not appear on the menu. Example request and response can be found in the Reference.
Response Status Codes for item and item_option:
| Status Code | Details |
|---|---|
| 200 | Success |
| 400 | Bad Request (If one of the items fails to update, 400 should be returned) |
| 401 | Authentication Error |
| 403 | Not Allowed to modify this store |
| 404 | Store not found |
| 429 | Rate Limit exceeded |
| 500 | Internal Server Error |
Response details for each entity
| Response | Details |
|---|---|
| Success | |
| Not Found | Item not found |
| Server Error | Server internal error |
Please only retry the Request if there is a 500 Response. We recommend retrying 3 times with exponential backoff 0.5 seconds
Retrieving Store Info (GET)
GET api/v1/stores/{merchant_supplied_id}/store_details
Partners can utilize this endpoint to retrieve live store-level information for those locations that are set up on the integration. This endpoint can be helpful in validating the following information:
Which order protocol (tablet, POS, etc) is this store currently using? What is the max length for special instructions set for this store? Is my store temporarily/permanently deactivated? Why? Is Auto-Order Release (AOR) enabled at this store?
The response object is fully detailed in our API Reference documentation, and we’ve also included a sample instance in the Reference section of this document.
Retrieving Store Menu Details (GET)
GET api/v1/stores/{merchant_supplied_id}/menu_details
Partners can utilize this endpoint to retrieve live menu-level information for those locations that are set up on the integration. This endpoint can be helpful in validating the following information regarding active menus at stores:
- What is/are the menu ID(s) tied to this location?
- Is this menu currently active?
- When was the last successful update for this menu?
- What are the Special/Regular hours for this menu?
- Was this menu created via POS or another method?
- What is the menu preview URL?
The response object is fully detailed in our API Reference documentation, and we’ve also included a sample instance in the Reference section of this document.