Skip to main content
POST
Complete first-run setup

Body

application/json
setup_token
string
required

One-time token from the install output.

email
string<email>
required
Example:

"owner@example.com"

password
string
required
Example:

"Secret123!"

country_code
string
required

ISO 3166-1 alpha-2 country the store sells from. Determines the default market, the warehouse, the delivery zones and the currency.

Example:

"US"

password_confirmation
string
Example:

"Secret123!"

first_name
string
Example:

"Olivia"

last_name
string
Example:

"Owner"

store_name
string
Example:

"My Store"

locale
string

Storefront locale. Defaults to the country's own language.

Example:

"en"

currency
string

ISO 4217 currency. Defaults to the country's own currency — pass one only when the store prices in something else.

Example:

"USD"

sample_data
boolean

Load the demo catalog, customers and orders in the background once the admin account exists.

Example:

false

Response

setup completed