Skip to main content
GET
/
stores
/
onboarding
/
{onboarding_id}
Get Onboarding by ID
curl --request GET \
  --url https://api-staging.luladelivery.store/stores/onboarding/{onboarding_id}
{
  "onboarding_id": "<string>",
  "store_id": "<string>",
  "company_id": "<string>",
  "onboarding_status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "completed_at": "<string>",
  "platform_status": {
    "UberEats": {
      "status": "<string>",
      "activated_at": "<string>",
      "partner_store_id": "<string>"
    },
    "DoorDash": {},
    "GrubHub": {}
  },
  "onboarding_steps": [
    {
      "step_name": "<string>",
      "status": "<string>",
      "completed_at": "<string>",
      "notes": "<string>"
    }
  ]
}
This endpoint allows you to fetch detailed onboarding information using a specific onboarding ID. This is typically used when tracking onboarding processes or when you need to retrieve onboarding details from a stored reference.

​
Path Parameters

​
onboarding_id
string
required
The unique identifier of the onboarding record to retrieve

​
Response

​
onboarding_id
string
The unique identifier for this onboarding record
​
store_id
string
The store ID associated with this onboarding
​
company_id
string
The company ID that owns the store
​
onboarding_status
string
Current status of the onboarding process
Common statuses: “pending”, “in_progress”, “completed”, “failed”
​
created_at
string
When the onboarding process was initiated (ISO 8601 format)
​
updated_at
string
When the onboarding record was last updated
​
completed_at
string
When the onboarding process was completed (null if not completed)
​
platform_status
object
Status breakdown for each delivery platform
​
onboarding_steps
array
Array of completed onboarding steps

​
Response Example

{
    "onboarding_id": "ob_7669f473-6c40-45ee-8737-43c667407b3a",
    "store_id": "7669f473-6c40-45ee-8737-43c667407b3a",
    "company_id": "1000022",
    "onboarding_status": "completed",
    "created_at": "2023-09-20T13:27:11.318Z",
    "updated_at": "2023-09-20T14:15:22.456Z",
    "completed_at": "2023-09-20T14:15:22.456Z",
    "platform_status": {
        "UberEats": {
            "status": "active",
            "activated_at": "2023-09-20T14:10:15.123Z",
            "partner_store_id": "15be0357-9b4d-4f05-9a5a-9485b5f783e5"
        },
        "DoorDash": {
            "status": "active",
            "activated_at": "2023-09-20T14:12:30.789Z",
            "partner_store_id": "b1015bdb-e831-42ef-b6f8-720fab19321f"
        },
        "GrubHub": {
            "status": "active",
            "activated_at": "2023-09-20T14:15:22.456Z",
            "partner_store_id": "1240569280"
        }
    },
    "onboarding_steps": [
        {
            "step_name": "store_setup_validation",
            "status": "completed",
            "completed_at": "2023-09-20T13:30:00.000Z",
            "notes": "All required store information validated"
        },
        {
            "step_name": "menu_configuration",
            "status": "completed",
            "completed_at": "2023-09-20T13:45:00.000Z",
            "notes": "Initial menu items configured"
        },
        {
            "step_name": "platform_activation",
            "status": "completed",
            "completed_at": "2023-09-20T14:15:22.456Z",
            "notes": "All platforms successfully activated"
        }
    ]
}

​
Use Cases

​
Progress Tracking
use-case
Monitor the progress of ongoing onboarding processes
Check status periodically during onboarding to track progress
​
Troubleshooting
use-case
Investigate onboarding issues or failures
Step-by-step status helps identify where problems occurred
​
Audit Trail
use-case
Maintain records of when stores were onboarded and activated
Useful for compliance and business analytics
​
Integration Sync
use-case
Synchronize onboarding status with external systems
Ensure external systems reflect current onboarding state

​
Error Scenarios

​
Onboarding Not Found
error
The specified onboarding_id doesn’t existStatus Code: 404Solution: Verify the onboarding ID or check if onboarding was initiated
​
Access Denied
error
User doesn’t have permission to view this onboarding recordStatus Code: 403Solution: Ensure user has appropriate permissions for the associated company
​
Onboarding Corrupted
error
Onboarding record exists but data is inconsistentStatus Code: 500Solution: Contact support for data recovery
Real-time Data: Onboarding information is updated in real-time as processes complete, providing accurate current status.
Data Retention: Onboarding records are preserved for audit and troubleshooting purposes, even after completion.