Skip to content

Order counts for the day

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

What the orders page opens on: going out today, late, still owing money, and delivered today.

Counts

Media typeapplication/json
object
today
required
integer
late
required
integer
awaitingPayment
required
integer
deliveredToday
required
integer

Example generated

{
"today": 1,
"late": 1,
"awaitingPayment": 1,
"deliveredToday": 1
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

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

Validation failed, or a line names something not sold

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