Skip to content
Bottle

List possible duplicates of a customer

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

Matched on a normalised email or phone number, so +44 7700 900123 and 07700 900123 are the same number. Never on a name. Always a suggestion: one office phone can cover four pubs.

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

Responses

Section titled “Responses”

200

Section titled “200”

Suggestions, strongest evidence first

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

UUID v7

string format: uuid
tradingName
required
string
email
required
string | null
phone
required
string | null
createdAt
required
string format: date-time
matchedOn
required
string
Allowed values: email phone
keep
required

UUID v7

string format: uuid
orders
required
object
subject
required
integer
candidate
required
integer
Example
{
  "items": [
    {
      "customer": {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      },
      "matchedOn": "email",
      "keep": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

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 of that tenant

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