Get onboarding checklist

const options = {
  method: 'GET',
  headers: {'X-Spree-Seller-Id': '<x-spree-seller-id>', Authorization: 'Bearer <token>'}
};

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

{
  "status": "approved",
  "progress": {
    "done": 0,
    "total": 0
  },
  "requirements": []
}

{
  "error": {
    "code": "access_denied",
    "message": "You do not have access to this seller."
  }
}

Get onboarding checklist

What this marketplace asks of the seller before it will admit them.

Singular: the checklist is always the acting seller’s. Every answer is computed server-side by the same evaluator the operator’s own view uses, so the panel and the operator can never show different progress.

progress counts optional requirements too — it is how far along the checklist is, not how close to approval. Read blocking on each requirement for that.

Each requirement’s id is what a submission is posted against. A marketplace that asks for nothing returns an empty list, which is a complete answer rather than a missing one.

GET

api

seller

onboarding

Get onboarding checklist

const options = {
  method: 'GET',
  headers: {'X-Spree-Seller-Id': '<x-spree-seller-id>', Authorization: 'Bearer <token>'}
};

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

{
  "status": "approved",
  "progress": {
    "done": 0,
    "total": 0
  },
  "requirements": []
}

{
  "error": {
    "code": "access_denied",
    "message": "You do not have access to this seller."
  }
}

Authorizations

Authorization

string

header

required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id

string

required

Response

checklist returned

What the marketplace asks of this seller before it will admit them

status

string

required

The seller's lifecycle status

Example:

"onboarding"

progress

object

required

How far along the checklist is — not how close to approval, since optional requirements count towards it too.

Deliberately just the two counts. A percentage is arithmetic over them, which a client can do and which would otherwise be a second definition of the same fact.

Show child attributes

requirements

object[]

required

Show child attributes

⌘I

API basics

Endpoints

Get onboarding checklist

Authorizations

Headers

Response