Skip to main content
PUT
Start Onboarding
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

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

Request Body

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

Request Example

Response

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

Response Example

Onboarding Prerequisites

prerequisite
Ensure all basic store information is configured
Name, addresses, contact information must be complete
prerequisite
Store menu should be configured with available items
Stores without menu items may not accept orders properly
prerequisite
Delivery service partner accounts should be set up
Partner integrations are automatically created during store creation
prerequisite
Billing and payment processing should be configured
Verify bill_vendor_id is set during store creation
prerequisite
Ensure staff is trained on order fulfillment processes
Orders will start coming immediately after activation

Post-Onboarding Actions

action
Watch for incoming orders to verify system is working
Orders typically start within minutes of going live
action
Check that store appears correctly on each delivery platform
It may take a few minutes for stores to appear in customer apps
action
Place test orders to ensure fulfillment process works smoothly
Use test accounts to avoid affecting real customers
action
Set up regular operating hours if not already configured
Initial activation may use default hours
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.