Skip to content
Bottle

Search the business

GET
/search
curl --request GET \
  --url 'https://example.com/search?q=example&limit=5' \
  --cookie bottle.session_token=<bottle.session_token>

Customers, delivery addresses, orders, invoices, products, people, vehicles and bases, by what a person remembers them by: a name, part of a name, a postcode, a phone number, an email, an invoice number (42 or INV-BTL00042) or a tracking reference. Every word must match somewhere, and near misses of four letters or more still match. Results are best first across every kind, each with the app page that shows it. Kinds the caller has no scope to read are left out: customers and addresses need customers:read, orders orders:read, invoices invoices:read, products products:read, people members:read, vehicles and bases rounds:write.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
required

What to look for: a name, postcode, phone, email, or an invoice or tracking number.

string
>= 2 characters <= 100 characters

What to look for: a name, postcode, phone, email, or an invoice or tracking number.

kinds

Only these kinds, comma separated: customer, address, order, invoice, product, person, vehicle, base. Every kind you may read, if left out.

string

Only these kinds, comma separated: customer, address, order, invoice, product, person, vehicle, base. Every kind you may read, if left out.

limit

Most results of each kind. 5 unless said.

integer
default: 5 >= 1 <= 20

Most results of each kind. 5 unless said.

Responses

Section titled “Responses”

200

Section titled “200”

Best first

Media typeapplication/json
object
items
required
Array<object>
object
kind
required
string
Allowed values: customer address order invoice product person vehicle base
id
required
string
title
required
string
detail
required
string | null
status
required
string | null
date
required
string | null format: date
archived
required
boolean
path
required
string
score
required
number
Example
{
  "items": [
    {
      "kind": "customer"
    }
  ]
}

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