Skip to content
Bottle

Which filters show on the shop

GET
/storefront/filters
curl --request GET \
  --url https://example.com/storefront/filters \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

For every filter the shop could offer, switched on or not, whether it would show on All products with the products published now and the draft settings, and if not, why not. A filter only shows where it splits the products: some yes and some not, two different options, or two different numbers.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Each filter, in the shop’s order

Media typeapplication/json
object
filters
required
Array<object>
object
id
required
string
split
required

Shows: the filter shows on All products. noProducts: nothing is on the shop. unset: no product on the shop has it. same: every product has the same answer or number. oneOption: the products have one option between them.

string
Allowed values: shows noProducts unset same oneOption

Example 

{
  "filters": [
    {
      "id": "gasType",
      "split": "shows"
    }
  ]
}

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