Skip to content
Bottle

How far setup has got

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

Every step with whether it is done, worked out from the business itself (a product exists, a payment provider is ready), or skipped for now. next is the first step neither done nor skipped.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Where it stands

Media typeapplication/json
object
activationDone
required
boolean
activationCompletedAt
required
string | null format: date-time
steps
required
Array<object>
object
key
required
string
Allowed values: business invoices vat bases gasTypes products cylinderCharges delivery vehicles people patches shiftPatterns closedDays timeOff planning payments accounting reminders customers standingOrders shop
level
required
string
Allowed values: open sell fleet week automate customers
done
required
boolean
skipped
required
boolean
skippable
required
boolean
required
required
boolean
sticky
required
boolean
answerable
required
boolean
count
required
integer | null
settled
required
integer
total
required
integer
> 0
complete
required
boolean
requiredDone
required
boolean
dismissed
required
boolean
closed
required
boolean
next
required
string | null
Allowed values: business invoices vat bases gasTypes products cylinderCharges delivery vehicles people patches shiftPatterns closedDays timeOff planning payments accounting reminders customers standingOrders shop
levels
required
Array<object>
object
key
required
string
Allowed values: open sell fleet week automate customers
number
required
integer
> 0
steps
required
Array<string>
done
required
boolean
doneCount
required
integer
total
required
integer
> 0
required
required
boolean
currentLevel
required
string | null
Allowed values: open sell fleet week automate customers
awards
required
Array<object>
object
key
required
string
kind
required
string
Allowed values: level first
earned
required
boolean
seen
required
boolean

Example 

{
  "steps": [
    {
      "key": "business",
      "level": "open"
    }
  ],
  "next": "business",
  "levels": [
    {
      "key": "open"
    }
  ],
  "currentLevel": "open",
  "awards": [
    {
      "kind": "level"
    }
  ]
}

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