Creating Customers

Prerequisite for other guides: A customer must exist before you can create quotes or create orders.

External parties: Customers created via this endpoint are external parties under your parent account — for example, a dealer or auction you manage. When creating an order that bills an external party, reference them with customer_id or the inline customer object. To bill your own account, use top-level provider_id on the order request instead. See Customer Identification.

Endpoint

POST /api/customers

Requires a Sanctum token with PUBLIC_API permission.

Required Fields

Field	Type	Notes
name	string	Required. Max 255 characters.
address	string	Required. Max 255 characters.
address_2	string	Optional. Max 255 characters.
city	string	Required. Max 255 characters.
state	string	Required. Exactly 2 characters (e.g., GA, CA).
postal_code	string	Required. 5-10 digits.
contact_firstname	string	Required. Max 255 characters.
contact_lastname	string	Required. Max 255 characters.
phone_number	string	Required. US/CA/PR phone number.
email	string	Required. Valid email address.
type	string	Required. See customer types below.
send_welcome_email	boolean	Optional. Defaults to `true`. Set to `false` to prevent the welcome email from being sent to the new customer. Availability is being rolled out per account; until enabled for your account the welcome email is always sent.

Customer Types

auction, independent_dealer, franchise_dealer, digital_platform, finance_insurance, upfitter, pov, fleet, rental_company

Example

POST /api/customers
Content-Type: application/json
Authorization: Bearer your-api-token

{
  "name": "Acme Auto Sales",
  "address": "123 Main Street",
  "city": "Atlanta",
  "state": "GA",
  "postal_code": "30301",
  "contact_firstname": "John",
  "contact_lastname": "Doe",
  "phone_number": "+14045551234",
  "email": "john@acmeauto.com",
  "type": "independent_dealer",
  "send_welcome_email": false
}

Response (201 Created)

{
  "status": true,
  "status_code": 201,
  "data": {
    "id": "a1b2c3d4e5f6",
    "name": "Acme Auto Sales",
    "address": "123 Main Street",
    "city": "Atlanta",
    "state": "GA",
    "postal_code": "30301",
    "contact_firstname": "John",
    "contact_lastname": "Doe",
    "phone_number": "+14045551234",
    "email": "john@acmeauto.com",
    "type": "independent_dealer"
  }
}

Other Customer Endpoints

Method	Endpoint	Description
GET	/api/customers/{id}	Get a customer by slug.
GET	/api/customers	List customers for your organization (paginated).

Next Steps

→ Create a quote to get pricing estimates
→ Create an order to submit a transport request