PUT
/
stores
/
{store_id}
/
status
Start Onboarding
curl --request PUT \
  --url https://api-staging.luladelivery.store/stores/{store_id}/status \
  --header 'Content-Type: application/json' \
  --data '{
  "dsp_name": "<string>",
  "is_active": true,
  "end_time": "<string>"
}'
{
  "success": true,
  "status": {
    "current_pause": "<string>",
    "is_close": true,
    "UberEats": [
      {
        "success": true,
        "is_open": true,
        "status": "<string>",
        "status_changed_from": true,
        "partner_store_id": "<string>",
        "name": "<string>"
      }
    ],
    "DoorDash": [
      {}
    ],
    "GrubHub": [
      {}
    ]
  }
}
This endpoint starts the store onboarding process by activating the store across all delivery platforms simultaneously. This operation transitions the store from setup/configuration mode to live operational status.

​
Path Parameters

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

​
Request Body

​
dsp_name
string
required
Must be set to “All” to activate all delivery service platforms
​
is_active
boolean
required
Must be set to true to open the store
​
end_time
string
Optional end time for temporary activation. Format: ISO 8601 with timezoneExample: “2024-11-15T23:59:00-07:00”

​
Request Example

{
    "dsp_name": "All",
    "is_active": true,
    "end_time": "2024-11-15T23:59:00-07:00"
}

​
Response

​
success
boolean
Indicates whether the onboarding activation was successful
​
status
object
Detailed status information showing the result of activating each platform

​
Response Example

{
    "success": true,
    "status": {
        "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",
                "status_changed_from": true
            }
        ],
        "DoorDash": [
            {
                "success": true,
                "is_open": true,
                "status": "ONLINE",
                "end_time": null,
                "current_pause": null,
                "description": [],
                "id": "1704fecd-e6ca-45bb-b1b5-776aee294af8",
                "partner_store_id": "b1015bdb-e831-42ef-b6f8-720fab19321f",
                "name": "Lula Convenience Store",
                "status_changed_from": true
            }
        ],
        "GrubHub": [
            {
                "success": true,
                "is_open": true,
                "status": "ONLINE",
                "end_time": null,
                "current_pause": null,
                "description": [
                    {
                        "merchant_status": "PT_PREMIUM",
                        "merchant_status_descriptor": "Premium",
                        "pos_merchant_status": "online",
                        "holds_active_account": true,
                        "accepting_phone_orders": true,
                        "accepting_online_orders": true
                    }
                ],
                "id": "d0b3e829-299f-42cc-a768-2f9a908f3355",
                "partner_store_id": "1240569280",
                "name": "Lula Convenience Store",
                "status_changed_from": true
            }
        ]
    }
}

​
Onboarding Prerequisites

​
Post-Onboarding Actions

Immediate Effect: Once successfully activated, the store will immediately start receiving orders from customers on all platforms.
Irreversible Process: Onboarding makes the store live to customers. Ensure all prerequisites are met before activation.
Support Contact: If any platform fails to activate, contact technical support with the specific platform error details from the response.