Request password reset

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'seller@acme.test',
    redirect_url: 'https://sellers.your-store.com/reset-password'
  })
};

fetch('http://{defaultHost}/api/v3/seller/auth/password_resets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url http://{defaultHost}/api/v3/seller/auth/password_resets \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "seller@acme.test",
  "redirect_url": "https://sellers.your-store.com/reset-password"
}
'

{
  "message": "If an account exists for that email, password reset instructions have been sent."
}

Request password reset

Requests a password reset email for a seller.

Unauthenticated. Always answers 202, whether or not the address belongs to a seller, so this cannot be used to discover which accounts exist. A store staff member who runs no seller is treated as no match: they have no seller panel to be sent to.

redirect_url is where the emailed link should point, with the reset token appended as a token query param. It is honoured only when it matches one of the store’s allowed origins; otherwise it is silently ignored and the server resolves the seller panel origin itself. The email is delivered by Spree via the seller_user.password_reset_requested event, which is never forwarded to webhook endpoints.

POST

api

seller

auth

password_resets

Request password reset

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'seller@acme.test',
    redirect_url: 'https://sellers.your-store.com/reset-password'
  })
};

fetch('http://{defaultHost}/api/v3/seller/auth/password_resets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url http://{defaultHost}/api/v3/seller/auth/password_resets \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "seller@acme.test",
  "redirect_url": "https://sellers.your-store.com/reset-password"
}
'

{
  "message": "If an account exists for that email, password reset instructions have been sent."
}

Body

application/json

string<email>

required

Example:

"seller@acme.test"

redirect_url

string

Must match an allowed origin of the store; ignored otherwise.

Example:

"https://sellers.your-store.com/reset-password"

Response

202 - application/json

reset requested

⌘I

API basics

Endpoints

Request password reset

Body

Response