Skip to content
Bottle

Find an existing customer for this conversation

GET
/entry-drafts/customer-search
curl --request GET \
  --url 'https://example.com/entry-drafts/customer-search?q=example' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

Best active customer name matches

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
tradingName
required
string
address
required
string | null

Example generated

{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "tradingName": "example",
      "address": "example"
    }
  ]
}

401

Section titled “401”

Draft request refused

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

Draft request refused

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

404

Section titled “404”

Draft request refused

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

Draft request refused

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

Draft request refused

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

429

Section titled “429”

Draft request refused

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

503

Section titled “503”

Draft request refused

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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