Skip to content

List drivers who can hold an order cash payment

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

Drivers in this business

Media typeapplication/json
object
items
required
Array<object>
object
userId
required
string
name
required
string

Example generated

{
"items": [
{
"userId": "example",
"name": "example"
}
]
}

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