Skip to content
Bottle

Set a new password

POST
/storefront/sites/{host}/account/reset
curl --request POST \
  --url https://example.com/storefront/sites/northgate.shop.getbottle.app/account/reset \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example", "password": "example" }'

Deliberately without a staff session: a shopper on the business’s own shop. Spends the link from the forgotten-password email, sets the password, signs every other browser out and signs this one in (half way, when an authenticator is on). The link proves the email too.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
host
required
string
Example
northgate.shop.getbottle.app

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
token
required
string
>= 10 characters <= 200 characters
password
required
string
>= 10 characters <= 200 characters
Examplegenerated
{
  "token": "example",
  "password": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Signed in, or half way

Media typeapplication/json
object
twoFactor
required
boolean
Examplegenerated
{
  "twoFactor": true
}

400

Section titled “400”

Refused: the message says why

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

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

403

Section titled “403”

Not from the shop itself, or the email is not confirmed yet

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

404

Section titled “404”

Not a shop. No body.

409

Section titled “409”

A real shop not selling now (shop_closed)

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

429

Section titled “429”

Too many tries

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