Path Parameters
The unique identifier of the store to update status for
Request Body Fields
Request Body Fields
Delivery Service Provider to control. Options:
"All"
- Controls all platforms simultaneously"UberEats"
- Controls only UberEats"DoorDash"
- Controls only DoorDash"GrubHub"
- Controls only GrubHub
Store operational status:
true
- Opens the store (ONLINE)false
- Closes the store (OFFLINE)
When the status change should automatically revert. ISO 8601 format with timezone.Example: “2024-11-15T23:59:00-07:00”
If omitted, the status change is permanent until manually changed
When the status change should take effect (for scheduled changes).Example: “2024-11-15T00:00:00-05:00”
Used primarily for scheduling future status changes
Common Operations
Open All Platforms
Opens the store on all delivery platforms simultaneously.Close All Platforms
Closes the store on all delivery platforms simultaneously.Platform-Specific Control
Open UberEats Only
Close DoorDash Only
Pause GrubHub
Scheduled Operations
Schedule Store Pause
Response Types
Successful Status Change
Indicates whether the status change was successful
Detailed status information after the change (included for “All” operations)
Simple Success Response
For single platform operations or basic operations:Detailed Response Example
For “All” platform operations with full status:Best Practices
Status Management Recommendations
Status Management Recommendations
Use “All” for consistent customer experience across platforms
Customers expect consistent availability across all delivery apps
Use individual platform controls when specific integrations have issues
This allows you to maintain operations on working platforms
Use end_time for temporary closures (breaks, maintenance, etc.)
Without end_time, status changes are permanent
For immediate closures, use “All” with is_active: false
This immediately stops new orders across all platforms
Real-time Effect: Status changes take effect immediately on all specified platforms. Existing orders in progress are not affected.
Timezone Awareness: When using end_time, ensure the timezone offset matches the store’s local timezone to avoid unexpected behavior.
Platform Dependencies: Some platforms may have additional requirements or delays in reflecting status changes. The response indicates the success of the API call, not necessarily the immediate platform reflection.