The Store API provides developers with the ability to manage stores and retrieve store information. Use the store endpoints to enable/disable POS integration and set date-specific store override hours.
- Retrieve Store Data
Developers can retrieve store information such as store address and name on an individal location basis via
- Retrieve Stores
To see all stores provisioned to your developer account, use the
- Set & Retrieve Restaurant Status
Developers can set stores as online or offline (‘paused’) via the
POST /statusendpoint. When set to online, stores will be searchable and available to customers on the Uber Eats platform during store hours. When set to offline, stores will show as “currently unavailable”.
- Enable or Disable Order Integration
Toggle order integration on and off at stores using
PATCH /pos_data. This endpoint should be used to launch live stores that are provisioned prior to their integration launch date,
- Set & Retrieve Date-Specific Hours
Set and retrieve holiday hours via the
¶ Syncing Store Availability
Support of the
POST /status endpoint is strongly recommended. To ensure a great Eater experience, stores should be set offline using this endpoint when they are unable to fulfill orders during store hours (e.g. while experiencing connectivity issues or undergoing maintenance).
¶ Setting Holiday Hours
Regular store hours are determined by menu hours set through the Menu API. However, date-specific exceptions to the normal operating hours of a restaurant should be set through the Holiday Hours endpoint. Holiday hours override store hours on the specified date(s) and can be set far in advance.
¶ Testing with Uber Eats Orders
In an incognito Chrome browser, navigate to Uber Eats Orders. Log in as a store using your test store credentials.
POST /status endpoint to pause the store (set it offline). Refresh the Uber Eats Orders page. You should see the display message change to “New orders paused”. Now click on the top button with the three lines (“Menu” on hover) in the left-hand navigation bar. Click “Resume new orders” on the bottom of the sidebar and click “Confirm” in the following prompt. Now use
GET /status to retrieve the store’s status. The status should now read as “ONLINE”.
You can also use Uber Eats Orders to test holiday hours. Set holiday hours via the
POST /holiday_hours endpoint. Refresh your Uber Eats Orders window. Click again on “Menu” in the left-hand navigation bar. In the Menu sidebar, click “Hours” and then “Holiday Hours”. You should see your newly-set holiday hours reflected.
¶ Next Steps
See the Menu Integration guide for steps to construct your menu.