Skip to content
Bottle

Publish a page

POST
/storefront/pages/{id}/publish
curl --request POST \
  --url https://example.com/storefront/pages/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/publish \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Puts the page on the shop with its draft, when it has one, and clears the draft. A new address keeps the old one working. An address another page has taken since is 409, and nothing changes. With base (the page’s version the person was looking at), a page changed since somewhere else is 409 (draft_changed) and nothing is published.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Query Parameters

Section titled “Query Parameters”
base

The page’s version the person publishing was looking at.

string
<= 64 characters

The page’s version the person publishing was looking at.

Responses

Section titled “Responses”

200

Section titled “200”

The page, published

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
slug
required
string
title
required
string
sections
required
Array
One of:
object
id
required

Stable within the page. Lower-case letters, digits and dashes.

string
/^[a-z0-9-]{1,40}$/
width

How wide the section is on a wide screen, in parts of the page: full, threeQuarters, twoThirds, half, third or quarter. Absent: full. Each kind allows only some (see the help guide). Every section is full width on a phone.

string
Allowed values: full threeQuarters twoThirds half third quarter
type
required
string
Allowed values: banners
seoTitle
required
string
seoDescription
required
string
showInNav
required
boolean
status
required

Draft: only the business sees it, in the preview. published: on the shop.

string
Allowed values: draft published
draft
required
object
title
required
string
>= 1 characters <= 120 characters
slug
required

Lower-case letters, digits and single dashes. Not one of the shop’s own addresses (products, basket, account, blog and the like).

string
>= 1 characters <= 80 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/
seoTitle
required
string
<= 70 characters
seoDescription
required
string
<= 300 characters
showInNav
required
boolean
sections
required
Array
<= 30 items
One of:
object
id
required

Stable within the page. Lower-case letters, digits and dashes.

string
/^[a-z0-9-]{1,40}$/
width

How wide the section is on a wide screen, in parts of the page: full, threeQuarters, twoThirds, half, third or quarter. Absent: full. Each kind allows only some (see the help guide). Every section is full width on a phone.

string
Allowed values: full threeQuarters twoThirds half third quarter
type
required
string
Allowed values: banners
unpublishedChanges
required
boolean
assets
required
object
key
additional properties
object
alt
required
string | null
width
required
integer
height
required
integer
thumb
required
string
card
required
string
large
required
string
publishedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
oldSlugs
required
Array<string>
version
required
string

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "sections": [
    {
      "width": "full",
      "type": "banners"
    }
  ],
  "status": "draft",
  "draft": {
    "slug": "refills-and-swaps",
    "sections": [
      {
        "width": "full",
        "type": "banners"
      }
    ]
  }
}

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"
}

404

Section titled “404”

No such page

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

Another page has that address: one in use (storefrontSlugTaken), or one in the bin, which holds it until it is restored or deleted for good

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"
    }
  ]
}