Skip to content
Bottle

Find a customer from the van

GET
/rounds/{id}/customers
curl --request GET \
  --url 'https://example.com/rounds/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/customers?q=example' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

As much of the customer book as a driver selling from the van needs: a name to search, and back come a few matches with an address and whether they may buy on account. Nothing else about them. A driver may only search from their own round.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Query Parameters

Section titled “Query Parameters”
q
required
string
>= 2 characters <= 80 characters

Responses

Section titled “Responses”

200

Section titled “200”

Up to eight matches

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
tradingName
required
string
address
required
string | null
addresses
required
Array<object>
object
id
required

UUID v7

string format: uuid
label
required
string
onAccount
required
boolean
accountAccess
object
unpaidInvoices
required
boolean
newOrdersBlocked
required
boolean
deliveriesBlocked
required
boolean

Example 

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "addresses": [
        {
          "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "label": "Cellar door, 2 High Street, KT3 4BP"
        }
      ]
    }
  ]
}

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

404

Section titled “404”

Not found

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