API Version 2
API Documentation

customers/create

Type Create
List Customers
URL http://{domain}/api/v2/customers/create.json
Accepts Filters No
Output Attributes
No


Create Customers

These parameters are used for creating Customers.
Data Points
Parameter Type Required Notes
Example
first string Yes Customer first name
Tom
last string Yes
Customer last name Smith
email string Yes
tom@smith.web
phone
string No Customer primary phone number
310-555-1212
fax string No Customer primary fax number 310-555-1234
company
string No Coffee Shop, Co. Tie customer to company
password string No Customer password
abxd9999
customer_type int No Customer Type. Defaults to 1 if not set.
1
lead boolean No Is this a lead or customer.
true
tax_exempt boolean No Flag only works if customer type is not flagged as tax exempt
default_order_notes string No

default_payment_notes string No

addresses
array No Array containing an additional array of each address.

Address Data Points
These are the values for Address info.
Parameter Type Required Notes
Example
full_name string Yes Customer full name for shipping
Tom Smith
address_1 string Yes Customer street address 5000 Parkway Ave.
address_2 string No Unit/Apartment Number #423
city string Yes
Los Angeles
subregion string
 Yes Customer state (abbr)
 CA
postal_code string
 Yes
90210
region string
 Yes Customer country United States
phone string
 No
310-555-9876
default_billing int
No Set address as default billing address 1
default_shipping int
No Set address as default shipping address 1
status int
No Set address status 0, 1, or 2

Request

Example cURL sent
curl --location --request POST 'https://{yourdomain}/api/v2/customers/create.json' 
--header 'Content-Type: application/x-www-form-urlencoded' 
--header '{yourkey}' 
--data-urlencode 'data={
   "inserts":[
      {
         "first":"Test",
         "last":"Customer",
       "email":"email@domain.com",
         "addresses":[
            {
               "full_name":"Test Customer",
               "address_1":"12345 Smith St.",
               "city":"San Diego",
               "subregion":"CA",
               "postal_code":92126,
               "region":"United States"
            }
         ]
      }
   ]
}'

Response

Example JSON returned
{
    "code": "200",
    "data": {
        "record": {
            "58": {
                "id": "58",
                "title": "Test Customer",
                "tag": "WEFZSRVHWJ31E7NF0TLBE8F8O"
            }
        }
    }
}
Sitemap
Resources
Help & Support
Subscribe to our Newsletter
Social

Start your free, no-risk trial today.

Close