v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Create customer

Create a new customer

post/v3/customer

Query parameters

echoboolean

Return results

Request body

merchantIdinteger required

Merchant id

namestring required

Customer's full name (display name)

firstNamestring required

Customer's first name

lastNamestring

Customer's last name

address1string

Street address

address2string

Apartment, suite, department

citystring

City

statestring

State

zipstring

Zip code

addressNamestring

Name for address, i.e. home, work

customerTypestring

Type of customer: Business or Person

emailstring

Customer's email address

mobilestring

Customer's cell phone number

phonestring

Customer's phone number

numberstring

Client provided customer number

isTaxExemptboolean

Is this customer tax exempt?

taxIdstring

Customer's SSN or EIN (9 digits) (Required for tax exempt customers)

spendProfilestring

Customer's spend profile

activeStatusboolean

Is the customer active?

selectedSpendProfilestring

Spend profile selected for customer

spendProfileOverrideboolean

If the spend profile was selected or sent manually, this would be true.

Response

201

idinteger

createdstring

namestring

firstNamestring

lastNamestring

numberstring

taxIdstring

visitsinteger

transactionCountinteger

spendstring

salesstring

refundsstring

lastActivitystring

allowPromotionsboolean

loyaltyStatusstring

loyaltyEnrolledstring

isVipboolean

spendProfilestring

spendProfileIconstring

addressNamestring

address1string

address2string

citystring

statestring

zipstring

customerTypestring

spendProfileOverrideboolean

isTaxExemptboolean

hasPaymentsboolean

hasContractsboolean

hasInvoicesboolean

displayColorstring

activeStatusboolean

Example response

{
  "id": 10696552,
  "created": "2018-01-30T15:02:09.547Z",
  "name": "Test Customer",
  "firstName": "Test",
  "lastName": "Customer",
  "number": "123",
  "taxId": "*****3334",
  "spend": "0",
  "sales": "0",
  "refunds": "0",
  "lastActivity": "2018-01-30T15:02:12.827Z",
  "loyaltyStatus": "Declined",
  "spendProfile": "New",
  "spendProfileIcon": "glyphicon-butterfly",
  "addressName": "Headquarters",
  "address1": "221 E Baker St",
  "address2": "Suite 2",
  "city": "Dallas",
  "state": "TX",
  "zip": "75252",
  "customerType": "Person",
  "spendProfileOverride": true,
  "displayColor": "A1BC3A",
  "activeStatus": true
}