v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get a customer

Get a specific customer

get/v3/customer/{customerId}

Path parameters

customerIdinteger required

Id of customer

Response

200

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
}