Customers

API for browsing, adding, editing and deleting Customers.

URLs

GET /customers
Return a list of Customers.
GET /customers/{Id}
Return a specific Customer.
POST /customers
Create a new Customer.
PUT /customers/{Id}
Update an existing Customer.
DELETE /customers/{Id}
Delete the specified Customer.

References

Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource

Notes

Customer Object

{
  "CustomerId": 0,
  "Customer": "",
  "FirstName": "",
  "LastName": "",
  "Company": "",
  "Address1": "",
  "Address2": "",
  "City": "",
  "StateRegion": "",
  "PostalCode": "",
  "Country": "",
  "LocalPhone": "",
  "Fax": "",
  "EMail": "",
  "DateOfBirth": "",
  "SignupDate": "",
  "LoginName": "",
  "LoginPassword": "",
  "CCNumber": "",
  "CCExpireDate": "",
  "CCVCode": "",
  "CCName": "",
  "CCAddress1": "",
  "CCAddress2": "",
  "CCCity": "",
  "CCStateRegion": "",
  "CCCountry": "",
  "CCPostalCode": "",
  "Notes": "",
  "User1": "",
  "User2": "",
  "User3": "",
  "User4": "",
  "User5": "",
  "User6": "",
  "User7": "",
  "User8": "",
  "User9": "",
  "User10": "",
  "PublicCustomer": false
}

Table Definition

CUSTOMERS

This table stores account ownership information and is linked to the ACCOUNTS table via the ACCOUNTS.CUSTOMER_ID CUSTOMERS.CUSTOMER_ID field. This table reduces database storage requirements in situations where account holders are typically anonymous to prevent having to store fields in the account table that for the most part would remain blank or NULL.

Field Name	Type	Size	Description
CUSTOMER_ID	bigint	8	Primary key.
CUSTOMER	varchar	40	Customer’s common name.
FIRST_NAME	varchar	25	Customer’s first name.
LAST_NAME	varchar	25	Customer’s last name.
COMPANY	varchar	40	Company name.
ADDRESS1	varchar	80	Customer’s street address.
ADDRESS2	varchar	40	Customer’s address part 2.
CITY	varchar	25	Customer’s city.
STATE_REGION	varchar	25	Customer’s state or region.
POSTAL_CODE	varchar	20	Customer’s postal code.
COUNTRY	varchar	25	Customer’s country name (e.g. ).
LOCAL_PHONE	varchar	24	Customer’s local phone number.
FAX	varchar	24	Customer’s complete fax number.
E_MAIL	varchar	80	Customer’s email address.
DATE_OF_BIRTH	smalldatetime	4	Customer’s date of birth.
SIGNUP_DATE	smalldatetime	4	Date user signed up for service.
LOGIN_NAME	varchar	20	Account login name for Web Interface.
LOGIN_PASSWORD	varchar	20	Account login password for Web Interface.
CC_NUMBER	varchar	75	Credit card Number.
CC_EXP_DATE	varchar	10	Credit card expiration date.
CC_NAME	varchar	40	Credit card holder’s name (as it appears on the card).
CC_ADDRESS1	varchar	80	Credit card holder’s billing street address (for AVS).
CC_ADDRESS2	varchar	40	Credit card holder’s billing address 2nd line.
CC_CITY	varchar	25	Credit card holder’s billing city.
CC_COUNTRY	varchar	25	Credit card holder’s billing country.
CC_STATE_REGION	varchar	25	Credit card holder’s billing state or region.
CC_POSTAL_CODE	varchar	20	Credit card holder’s billing postal code.
NOTES	varchar	1024	Notes about customer’s account activity etc.
USER_1	varchar	50	User defined field.
USER_2	varchar	50	User defined field.
USER_3	varchar	50	User defined field.
USER_4	varchar	50	User defined field.
USER_5	varchar	50	User defined field.
USER_6	varchar	50	User defined field.
USER_7	varchar	50	User defined field.
USER_8	varchar	50	User defined field.
USER_9	varchar	50	User defined field.
USER_10	varchar	50	User defined field.
CCV	varchar	10	User’s CVV2 number on the back of their credit card.
PUBLIC_CUSTOMER	bit	1	Denotes whether this entry is associated with only a single account or is available for assignment to other accounts.