Skip to content

Open a store to the public

POST
/stores/{storeRef}/open
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/open \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "delete_sample_products": true }'

Takes the store off the coming soon page so visitors can see the storefront. It fails with 409 SETUP_INCOMPLETE until the setup guide’s can_open is true. Set delete_sample_products to remove untouched sample products first. The first time a store opens, the store-ready email is sent to the owner. Returns the updated setup guide.

Required scopes: write:settings

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
delete_sample_products
required

Delete the sample products nobody has edited before opening

boolean

Example generated

{
"delete_sample_products": true
}
Media typeapplication/json
object
first_opened_at
required

When the store was first opened, as an ISO 8601 timestamp, or null.

string
nullable
closed_at
required

When setup was ended without opening, as an ISO 8601 timestamp, or null.

string
nullable
steps
required

The setup steps and which are done.

Array<object>
object
id
required

product, shipping, payment, theme or domain.

string
Allowed values: product shipping payment theme domain
required
required

Whether the step must be done before the store can open.

boolean
done
required

Whether the step is done.

boolean
shipping_summary
required

Summary of the shipping rates.

object
national_rate
required

The nationwide rate as a decimal string, or null.

string
nullable
free_over
required

The order amount above which shipping is free, as a decimal string, or null.

string
nullable
rate_count
required

Number of shipping rates.

number
payment_methods_enabled
required

The payment methods that are turned on.

Array<string>
custom_domain
required

The store’s custom domain, or null.

string
nullable
live_theme_id
required

ID of the live theme, or null.

string
nullable
live_theme_name
required

Name of the live theme, or null.

string
nullable
live_theme_source
required

The starter theme the live theme was copied from, meridian or default, or null.

string
nullable
Allowed values: meridian default
coming_soon
required

True while visitors see the coming soon page.

boolean
hidden
required

Whether the guide is hidden in the dashboard.

boolean
required_left
required

Number of required steps still to do.

number
can_open
required

Whether the store can be opened now.

boolean
sample_product_count
required

Number of untouched sample products.

number
own_active_product_count
required

Number of active products the merchant added.

number

Example

{
"steps": [
{
"id": "product"
}
],
"live_theme_source": "meridian"
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The request conflicts with the resource’s current state.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}