Skip to content
Bottle

Preview the draft

POST
/storefront/preview
curl --request POST \
  --url https://example.com/storefront/preview \
  --cookie bottle.session_token=<bottle.session_token>

A link that opens the draft on the shop’s Bottle address ({slug}.shop.getbottle.app), for 30 minutes, without publishing it. The office’s editor shows it in a frame.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The link

Media typeapplication/json
object
url
required
string
expiresAt
required
string format: date-time
Examplegenerated
{
  "url": "example",
  "expiresAt": "2026-04-15T12:00:00Z"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

402

Section titled “402”

The plan does not include a shop

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The shop has not been switched on

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}