Get Integration Details
GEThttps://api.uber.com/v1/eats/stores/{store_id}/pos_data
This endpoint allows for a partner to retrieve its store’s integration details.
¶ Authorization
OAuth 2.0 Bearer token with the eats.store
scope. For more information, see Authentication.
¶ Path Parameters
Name | Type | Description |
---|---|---|
store_id |
string |
Unique Uber identifier representing a store. |
¶ Response
{
"store_id": "e71251ce-41be-4822-a76a-b395f4be72bf",
"integration_enabled": true,
"integrator_store_id": "mypos-coffeecoffee-store-43",
"integrator_brand_id": "coffeecoffee",
"store_configuration_data": "{\"someCustomField\": \"data\"}",
"order_release_enabled": true,
"online_status": "online"
}
¶ Response Body Parameters
Name | Type | Description |
---|---|---|
store_id |
string |
Uber Eats restaurant UUID. |
integration_enabled pos_integration_enabled |
boolean |
Indicates whether this app is authorized to operate on this store. If true , you will be authorized to access most of the endpoints you have scope(s) for; and you would be eligible to receive webhooks. If false , you may only fetch historical details from this endpoint. |
integrator_store_id |
?string |
The ID that your app uses to reference this store. This can be updated programmatically via PATCH /pos_data or POST /pos_data . |
integrator_brand_id |
?string |
The ID that your app uses to reference this store’s brand. This can be updated programmatically via PATCH /pos_data or POST /pos_data . |
store_configuration_data |
?JSON string |
This custom JSON blob that an integration partner can attach to the store. This can be updated programmatically via PATCH /pos_data or POST /pos_data . |
order_manager_client_id |
?string |
The client ID that is currently nominated as the store’s order manager. Compare this string against X-Api-Client-Id response header to conveniently check if the calling app is the same. Note: this may be represented as an arbitrary redacted string if nominated order manager isn’t related to your app. |
is_order_manager_pending |
?boolean |
Indicates that this app has been nominated for order manager status, but needs to complete certain steps before it can assume. For example, you may have to make a successful PUT /menu request. |
online_status |
string |
Field indicating the online status of the restaurant POS. |
order_release_enabled |
boolean |
Indicates whether orders should be held before food preparation should take place (eligible only for quick-service restaurants). After order.notification , apps will receive a subsequent order.release webhook for orders. |
partner_store_id |
?string |
Deprecated: please use GET /stores/:store-id which includes both merchant_store_id as well as a subset of this payload in its pos_data field. |
pos_metadata |
?object |
Deprecated: this field has been phased out. Please use other fields from the payload, such as the integrator customizable store_configuration_data instead. |