Skip to content
Bottle

Merge two customers

POST
/customers/{id}/merge
curl --request POST \
  --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/merge \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "intoId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }'

Addresses and orders move to the account being kept. The duplicate stays as a tombstone pointing at it, because an order taken against it this morning still has to resolve to something.

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
intoId
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

Responses

Section titled “Responses”

200

Section titled “200”

The account that was kept

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
tradingName
required
string
>= 1 characters <= 160 characters
kind
required
string
Allowed values: commercial domestic
legalName
required
string | null
<= 200 characters
email
required
string | null format: email
phone
required
string | null
/^\+?[\d\s()-]{7,20}$/
paymentTerms
required
string
Allowed values: prepaid on_account cash_on_delivery
paymentTermsDays
required
integer | null
<= 120
billingAddressId
required

UUID v7

string | null format: uuid
hireBillingPeriod
required
string | null
Allowed values: weekly monthly quarterly
hireBilledTo
required
string | null format: date
notes
required
string | null
<= 2000 characters
archivedAt
required
string | null format: date-time
mergedIntoId
required

UUID v7

string | null format: uuid
legalHold
required
boolean
erasedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "tradingName": "Camden Lock Grill",
  "kind": "commercial",
  "legalName": "Camden Lock Grill Ltd",
  "email": "orders@camdenlockgrill.co.uk",
  "phone": "07700 900123",
  "paymentTerms": "prepaid",
  "billingAddressId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "hireBillingPeriod": "weekly",
  "mergedIntoId": "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”

Cannot merge a customer into itself

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