> ## 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.

# Get Onboarding by Store ID

> This endpoint retrieves the current onboarding and operational status of a store by its store ID. It provides comprehensive information about the store's availability across all delivery platforms and any onboarding-related status information.

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

<ParamField path="store_id" type="string" required>
  The unique identifier of the store to retrieve onboarding status for
</ParamField>

### Query Parameters

<ParamField query="current_local_date" type="string" required>
  Current local date and time for the store's timezone

  Format: "MMM DD YYYY HH:mm:ss"

  Example: "Nov 15 2024 03:46:34"
</ParamField>

### Response

<ResponseField name="current_pause" type="string">
  Any current pause reason affecting all platforms
</ResponseField>

<ResponseField name="is_close" type="boolean">
  Overall store closure status across all platforms
</ResponseField>

<ResponseField name="is_closed" type="boolean">
  Alternative closure status indicator
</ResponseField>

<ResponseField name="UberEats" type="array">
  Array of UberEats store status objects

  <Expandable title="UberEats Status Object">
    <ResponseField name="success" type="boolean">
      Whether the platform query was successful
    </ResponseField>

    <ResponseField name="is_open" type="boolean">
      Whether the store is currently open on UberEats
    </ResponseField>

    <ResponseField name="status" type="string">
      Current platform status: "ONLINE" or "OFFLINE"
    </ResponseField>

    <ResponseField name="end_time" type="string">
      When current status expires (null if permanent)
    </ResponseField>

    <ResponseField name="current_pause" type="string">
      Any active pause reason for this platform
    </ResponseField>

    <ResponseField name="description" type="array">
      Detailed status descriptions and reasons
    </ResponseField>

    <ResponseField name="id" type="string">
      Internal store partner record ID
    </ResponseField>

    <ResponseField name="partner_store_id" type="string">
      UberEats-specific store identifier
    </ResponseField>

    <ResponseField name="name" type="string">
      Store name as it appears on UberEats
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="DoorDash" type="array">
  Array of DoorDash store status objects

  <Expandable title="DoorDash Status Object">
    <ResponseField name="description" type="array">
      DoorDash-specific status information

      <Expandable title="DoorDash Description">
        <ResponseField name="reason" type="string">
          Reason for current status
        </ResponseField>

        <ResponseField name="notes" type="string">
          Additional status notes
        </ResponseField>

        <ResponseField name="created_at" type="string">
          When this status was set
        </ResponseField>

        <ResponseField name="end_time" type="string">
          When this status expires
        </ResponseField>

        <ResponseField name="experience" type="string">
          Experience type (e.g., "ANY\_EXPERIENCE")
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="GrubHub" type="array">
  Array of GrubHub store status objects

  <Expandable title="GrubHub Status Object">
    <ResponseField name="description" type="array">
      GrubHub-specific merchant status information

      <Expandable title="GrubHub Description">
        <ResponseField name="merchant_status" type="string">
          GrubHub internal merchant status code
        </ResponseField>

        <ResponseField name="merchant_status_descriptor" type="string">
          Human-readable status description
        </ResponseField>

        <ResponseField name="pos_merchant_status" type="string">
          POS integration status: "online" or "offline"
        </ResponseField>

        <ResponseField name="reason" type="string">
          Reason for current status if offline
        </ResponseField>

        <ResponseField name="holds_active_account" type="boolean">
          Whether the merchant account is active
        </ResponseField>

        <ResponseField name="accepting_phone_orders" type="boolean">
          Whether phone orders are being accepted
        </ResponseField>

        <ResponseField name="accepting_online_orders" type="boolean">
          Whether online orders are being accepted
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Response Example

```json theme={null}
{
    "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

<Accordion title="Understanding Onboarding Status">
  <ResponseField name="Fully Onboarded" type="status">
    All platforms show `success: true` and `is_open: true`

    <Info>Store is fully operational and accepting orders</Info>
  </ResponseField>

  <ResponseField name="Partial Onboarding" type="status">
    Some platforms are online while others are offline

    <Warning>May indicate incomplete setup or platform-specific issues</Warning>
  </ResponseField>

  <ResponseField name="Onboarding Issues" type="status">
    Platforms show `success: false` or error descriptions

    <Note>Requires investigation and resolution before going live</Note>
  </ResponseField>

  <ResponseField name="Scheduled Operations" type="status">
    Platforms may be offline due to scheduled hours or temporary pauses

    <Tip>Check end\_time fields to see if status will change automatically</Tip>
  </ResponseField>
</Accordion>

### Use Cases

<Accordion title="When to Use This Endpoint">
  <ResponseField name="Onboarding Verification" type="use-case">
    Verify that store onboarding completed successfully across all platforms

    <Note>Essential checkpoint after initiating onboarding process</Note>
  </ResponseField>

  <ResponseField name="Operational Monitoring" type="use-case">
    Regular monitoring of store availability and platform health

    <Tip>Set up automated monitoring to detect issues quickly</Tip>
  </ResponseField>

  <ResponseField name="Issue Diagnosis" type="use-case">
    Investigate why a store might not be receiving orders

    <Warning>Offline platforms won't generate orders</Warning>
  </ResponseField>

  <ResponseField name="Status Dashboard" type="use-case">
    Building dashboards to show current store operational status

    <Info>Real-time data suitable for monitoring interfaces</Info>
  </ResponseField>
</Accordion>

<Info>
  **Real-time Status:** This endpoint provides real-time status information directly from delivery partner systems, ensuring accuracy for operational decisions.
</Info>

<Note>
  **Timezone Awareness:** The current\_local\_date parameter ensures status checks account for the store's local timezone, which is important for schedule-based operations.
</Note>