Skip to main content
GET
/
stores
/
{store_id}
/
status
Get Onboarding by Store ID
curl --request GET \
  --url https://api-staging.luladelivery.store/stores/{store_id}/status
{
  "current_pause": "<string>",
  "is_close": true,
  "is_closed": true,
  "UberEats": [
    {
      "success": true,
      "is_open": true,
      "status": "<string>",
      "end_time": "<string>",
      "current_pause": "<string>",
      "description": [
        {}
      ],
      "id": "<string>",
      "partner_store_id": "<string>",
      "name": "<string>"
    }
  ],
  "DoorDash": [
    {
      "description": [
        {
          "reason": "<string>",
          "notes": "<string>",
          "created_at": "<string>",
          "end_time": "<string>",
          "experience": "<string>"
        }
      ]
    }
  ],
  "GrubHub": [
    {
      "description": [
        {
          "merchant_status": "<string>",
          "merchant_status_descriptor": "<string>",
          "pos_merchant_status": "<string>",
          "reason": "<string>",
          "holds_active_account": true,
          "accepting_phone_orders": true,
          "accepting_online_orders": true
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.lulacommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves detailed onboarding and operational status for a specific store. It’s particularly useful for checking the current state of a store’s onboarding process and its operational status across delivery platforms.

​
Path Parameters

​
store_id
string
required
The unique identifier of the store to retrieve onboarding status for

​
Query Parameters

​
current_local_date
string
required
Current local date and time for the store’s timezoneFormat: “MMM DD YYYY HH:mm:ss”Example: “Nov 15 2024 03:46:34”

​
Response

​
current_pause
string
Any current pause reason affecting all platforms
​
is_close
boolean
Overall store closure status across all platforms
​
is_closed
boolean
Alternative closure status indicator
​
UberEats
array
Array of UberEats store status objects
​
DoorDash
array
Array of DoorDash store status objects
​
GrubHub
array
Array of GrubHub store status objects

​
Response Example

{
    "current_pause": null,
    "is_close": false,
    "UberEats": [
        {
            "success": true,
            "is_open": true,
            "status": "ONLINE",
            "end_time": null,
            "current_pause": null,
            "description": [
                {
                    "status": "ONLINE"
                }
            ],
            "id": "37fa9980-33ba-4419-92c2-a6e5144fdc82",
            "partner_store_id": "15be0357-9b4d-4f05-9a5a-9485b5f783e5",
            "name": "Lula Convenience Store"
        }
    ],
    "DoorDash": [
        {
            "success": true,
            "is_open": false,
            "status": "OFFLINE",
            "end_time": "2024-11-16T06:59",
            "current_pause": null,
            "description": [
                {
                    "reason": "POS Integration - Store Availability Webhook",
                    "notes": "Store is closed",
                    "created_at": "2024-11-14T23:03:49.019",
                    "end_time": "2024-11-16T06:59",
                    "experience": "ANY_EXPERIENCE"
                }
            ],
            "id": "1704fecd-e6ca-45bb-b1b5-776aee294af8",
            "partner_store_id": "b1015bdb-e831-42ef-b6f8-720fab19321f",
            "name": "Lula Convenience Store"
        }
    ],
    "GrubHub": [
        {
            "success": true,
            "is_open": false,
            "status": "OFFLINE",
            "end_time": null,
            "current_pause": null,
            "description": [
                {
                    "merchant_status": "PT_PREMIUM_DATA_PROBLEMS",
                    "merchant_status_descriptor": "Account Update/Escalation (RC)",
                    "pos_merchant_status": "offline",
                    "reason": "If you do not expect this location to be offline, please contact Grubhub",
                    "holds_active_account": true,
                    "accepting_phone_orders": true,
                    "accepting_online_orders": false
                }
            ],
            "id": "d0b3e829-299f-42cc-a768-2f9a908f3355",
            "partner_store_id": "1240569280",
            "name": "Lula Convenience Store"
        }
    ],
    "is_closed": false
}

​
Onboarding Status Interpretation

​
Fully Onboarded
status
All platforms show success: true and is_open: true
Store is fully operational and accepting orders
​
Partial Onboarding
status
Some platforms are online while others are offline
May indicate incomplete setup or platform-specific issues
​
Onboarding Issues
status
Platforms show success: false or error descriptions
Requires investigation and resolution before going live
​
Scheduled Operations
status
Platforms may be offline due to scheduled hours or temporary pauses
Check end_time fields to see if status will change automatically

​
Use Cases

​
Onboarding Verification
use-case
Verify that store onboarding completed successfully across all platforms
Essential checkpoint after initiating onboarding process
​
Operational Monitoring
use-case
Regular monitoring of store availability and platform health
Set up automated monitoring to detect issues quickly
​
Issue Diagnosis
use-case
Investigate why a store might not be receiving orders
Offline platforms won’t generate orders
​
Status Dashboard
use-case
Building dashboards to show current store operational status
Real-time data suitable for monitoring interfaces
Real-time Status: This endpoint provides real-time status information directly from delivery partner systems, ensuring accuracy for operational decisions.
Timezone Awareness: The current_local_date parameter ensures status checks account for the store’s local timezone, which is important for schedule-based operations.