Skip to content
Bottle

List the blog’s posts

GET
/storefront/posts
curl --request GET \
  --url 'https://example.com/storefront/posts?status=published&changes=true&sort=updated&dir=asc' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

The posts the business has written, without bodies: every one not in the bin, newest first with drafts not dated yet at the top, or searched (q: title, address, short description, words and author), filtered (status published, draft or bin; from and to, the days it is dated between; author), sorted (updated, title, published; dir) and paged (limit up to 100, offset). With total, how many match, counts, how many on each of published, draft and bin for the same search, and authors, every name posts are written by. A post in the bin carries bin: when, by whom, the days left and the entry to restore it with.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q

Words to look for in the title, the address and the words.

string
<= 200 characters

Words to look for in the title, the address and the words.

status

Published: on the shop. draft: not on the shop. bin: deleted in the last 90 days. Left out: every one not in the bin.

string
Allowed values: published draft bin

Published: on the shop. draft: not on the shop. bin: deleted in the last 90 days. Left out: every one not in the bin.

changes

Pages only: true for those with changes not published.

string
Allowed values: true false

Pages only: true for those with changes not published.

sort

Updated (the default): last changed first. title: A to Z. published: newest first. With dir to turn it round.

string
Allowed values: updated title published

Updated (the default): last changed first. title: A to Z. published: newest first. With dir to turn it round.

dir
string
Allowed values: asc desc
limit

Up to 100. Left out: all of them.

integer
>= 1 <= 100

Up to 100. Left out: all of them.

offset
integer | null
from

Posts only: dated this day or after.

string format: date

Posts only: dated this day or after.

to

Posts only: dated this day or before.

string format: date

Posts only: dated this day or before.

author

Posts only: written by this name, as the post shows it.

string
<= 120 characters

Posts only: written by this name, as the post shows it.

Responses

Section titled “Responses”

200

Section titled “200”

The posts

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
slug
required
string
title
required
string
excerpt
required
string
coverKey
required
string | null
coverAlt
required
string
cover
required
object
alt
required
string | null
width
required
integer
height
required
integer
thumb
required
string
card
required
string
large
required
string
authorName
required
string
publishedOn
required
string | null format: date
tags
required
Array<string>
seoTitle
required
string
seoDescription
required
string
status
required

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

string
Allowed values: draft published
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
bin
object
entryId
required
string | null format: uuid
deletedAt
required
string format: date-time
goneAt
required
string format: date-time
daysLeft
required
integer
deletedBy
required
object
kind
required
string
Allowed values: person key assistant support
name
required
string
wasPublished
required
boolean
total
required
integer
counts
required
object
published
required
integer
draft
required
integer
bin
required
integer
authors
required
Array<string>

Example 

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "status": "draft",
      "bin": {
        "deletedBy": {
          "kind": "person"
        }
      }
    }
  ]
}

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

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