Skip to content
Bottle

Create a customer

POST
/customers
curl --request POST \
  --url https://example.com/customers \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "tradingName": "Camden Lock Grill", "paymentTerms": "prepaid", "paymentTermsDays": 1, "kind": "commercial", "hireBillingPeriod": "weekly", "legalName": "Camden Lock Grill Ltd", "email": "orders@camdenlockgrill.co.uk", "phone": "07700 900123", "notes": "example", "address": { "name": "example", "line1": "example", "line2": "example", "city": "example", "postcode": "example", "notes": "example", "leaveInstruction": "none", "leaveDetail": "example" } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
tradingName
required
string
>= 1 characters <= 160 characters
Example
Camden Lock Grill
paymentTerms
string
Allowed values: prepaid on_account cash_on_delivery
paymentTermsDays
integer | null
<= 120
kind
string
Allowed values: commercial domestic
hireBillingPeriod
string | null
Allowed values: weekly monthly quarterly
legalName
string | null
<= 200 characters
Example
Camden Lock Grill Ltd
email
string | null format: email
Example
orders@camdenlockgrill.co.uk
phone
string | null
/^\+?[\d\s()-]{7,20}$/
Example
07700 900123
notes
string | null
<= 2000 characters
address
object
name
string | null
<= 80 characters
line1
required
string
>= 1 characters <= 200 characters
line2
string | null
<= 200 characters
city
string | null
<= 120 characters
postcode
string | null
<= 12 characters
notes
string | null
<= 2000 characters
leaveInstruction
string | null
Allowed values: none neighbour safe_place
leaveDetail
string | null
<= 500 characters

Responses

Section titled “Responses”

201

Section titled “201”

Created

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

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