api/Customer/Query (POST)

Queries existing Customers using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Customers.

Request Information

Parameters

NameDescriptionAdditional information
RequestData 
This is a JSON object containing Customer query data.

Query Single Customer Using Key Fields Example:
{
  "CUSTOMER_ID": "ABCCORP"
}
Returns 1 Customer if successful.
This is like 'Find' in Expandable.

Query Multiple Customers Using Other Fields Example:
{
  "COUNTRY": "USA",
  "STATE": "CA"
}
Returns 1 or more Customers if successful.
This is like 'QBE' in Expandable.

Query Multiple Customers Using QBE Conditional Notation Example:
{
  "COUNTRY": "USA",
  "STATE": "IN 'CA','NV'"
}
Returns 1 or more Customers if successful.
This is like 'QBE' in Expandable.

Accepted Customer Fields:
ADDRESS_1, ADDRESS_2, ADDRESS_3, AL_CUST_NAME, 
AR_CONTACT, AR_FIN_CHG_PCT, AR_MIN_FIN_CHG, AR_PHONE_NO, 
AR_REMIT_TO, AUTO_AR_INVOICE, AUTO_SO_HOLD, AVG_LATE_DAYS, 
AVG_PAY_DAYS, BANK_CODE, BILL_TO_CUST, CHANNEL, 
CITY, CLASS_CODE, COMMENT_1, COMMENT_2, 
COMMENT_3, COMMENT_4, COMMENT_5, COMMENT_6, 
COMMENT_7, COMMENT_8, COMMENT_ID, COMPANY_ID, 
COUNTRY, CREATED_BY, CREDIT_LIMIT, CREDIT_MGR, 
CREDIT_RATING, CURR_CODE, CURRENT_BALANCE, CURRENT_ORDERS, 
CUST_MARKET, CUSTOMER_ID, CUSTOMER_NAME, CUSTOMER_STATUS, 
CUSTOMER_TYPE, DATE_CREATED, DATE_HIGH_BAL, DATE_LAST_CHECK, 
DATE_LAST_INV, DATE_LAST_SO, DATE_LAST_STMT, DATE_LAST_UPDT, 
DATE_LIMIT_UPDT, DATE_MODIFIED, DEF_STORES_CODE, DISCOUNTS_YTD, 
DUNS_DATE, DUNS_NUM, DUNS_RATING, E_MAIL, 
EARLY_SHIP, FAX_NO, FIN_CHG_FLAG, FOB, 
FREIGHT_CODE, FRT_BILL_TO, GEO, HIGH_BALANCE, 
LANGUAGE, LAST_PAY_DAYS, LC_CURR_ORDERS, LC_CURRENT_BAL, 
LC_UNAPPLIED, MA_GEO, MODIFIED_BY, NAICS_CODE, 
OPERATOR_ID, ORDER_DISC_PCT, PARENT_ID, PARTIAL_SHIP, 
PR_YR_LATE_DAYS, PR_YR_PAY_DAYS, PRICE_CODE, PRICE_CODE_2, 
PRICE_CODE_3, RESALE_ID, RESALE_ID_2, SALES_ACCT, 
SALES_DEPT, SALES_LAST_YR, SALES_REGION, SALES_YTD, 
SALESMAN_ID, SEARCH_NAME, SHIP_METHOD, SIC_CODE, 
SLX_ACCOUNT, SLX_ID, SN_REQD, SO_CONTACT, 
SO_PHONE_NO, SOFCM_USER_1, SOFCM_USER_2, SOFCM_USER_3, 
SOFCM_USER_4, SOFCM_USER_5, SOFCM_USER_6, SOFCM_USER_7, 
SOFCM_USER_8, SOFCM_USER_9, SOFCM_USER_10, SOFCM_USER_11, 
SOFCM_USER_12, SOFCM_USER_13, SOFCM_USER_14, SOFCM_USER_15, 
SOFCM_USER_16, SOFCM_USER_17, SOFCM_USER_18, SOFCM_USER_19, 
SOFCM_USER_20, SOFCM_USER_21, SOFCM_USER_22, SOFCM_USER_23, 
SOFCM_USER_24, SOFCM_USER_25, SOFCM_USER_26, SOFCM_USER_27, 
SOFCM_USER_28, SOFCM_USER_29, SOFCM_USER_30, SOFCM_USER_31, 
SOFCM_USER_32, STATE, TAX_CODE, TERMS_CODE, 
TIME_LAST_UPDT, UNAPPLIED_AMT, YTD_AMT_PAID, YTD_DAYS_PAID, 
YTD_LATE_PAID, ZIP_CODE

Define this parameter in the request body.

Response Information

Success:
200/OK
Body contains JSON array with found Customers.

Error:
400/Request JSON is invalid.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.

Returned Customer Fields:
ATTACHMENTS, ADDRESS_1, ADDRESS_2, ADDRESS_3, AL_CUST_NAME, AR_CONTACT, AR_FIN_CHG_PCT, AR_MIN_FIN_CHG, AR_PHONE_NO, AR_REMIT_TO, AUTO_AR_INVOICE, AUTO_SO_HOLD, AVG_LATE_DAYS, AVG_PAY_DAYS, BANK_CODE, BILL_TO_CUST, CHANNEL, CITY, CLASS_CODE, COMMENT_1, COMMENT_2, COMMENT_3, COMMENT_4, COMMENT_5, COMMENT_6, COMMENT_7, COMMENT_8, COMMENT_ID, COMPANY_ID, COUNTRY, CREATED_BY, CREDIT_LIMIT, CREDIT_MGR, CREDIT_RATING, CURR_CODE, CURRENT_BALANCE, CURRENT_ORDERS, CUST_MARKET, CUSTOMER_ID, CUSTOMER_NAME, CUSTOMER_STATUS, CUSTOMER_TYPE, DATE_CREATED, DATE_HIGH_BAL, DATE_LAST_CHECK, DATE_LAST_INV, DATE_LAST_SO, DATE_LAST_STMT, DATE_LAST_UPDT, DATE_LIMIT_UPDT, DATE_MODIFIED, DEF_STORES_CODE, DISCOUNTS_YTD, DUNS_DATE, DUNS_NUM, DUNS_RATING, E_MAIL, EARLY_SHIP, FAX_NO, FIN_CHG_FLAG, FOB, FREIGHT_CODE, FRT_BILL_TO, GEO, HIGH_BALANCE, LANGUAGE, LAST_PAY_DAYS, LC_CURR_ORDERS, LC_CURRENT_BAL, LC_UNAPPLIED, MA_GEO, MODIFIED_BY, NAICS_CODE, NOTES, OPERATOR_ID, ORDER_DISC_PCT, PARENT_ID, PARTIAL_SHIP, PR_YR_LATE_DAYS, PR_YR_PAY_DAYS, PRICE_CODE, PRICE_CODE_2, PRICE_CODE_3, RESALE_ID, RESALE_ID_2, SALES_ACCT, SALES_DEPT, SALES_LAST_YR, SALES_REGION, SALES_YTD, SALESMAN_ID, SEARCH_NAME, SHIP_METHOD, SIC_CODE, SLX_ACCOUNT, SLX_ID, SN_REQD, SO_CONTACT, SO_PHONE_NO, SOFCM_USER_1, SOFCM_USER_2, SOFCM_USER_3, SOFCM_USER_4, SOFCM_USER_5, SOFCM_USER_6, SOFCM_USER_7, SOFCM_USER_8, SOFCM_USER_9, SOFCM_USER_10, SOFCM_USER_11, SOFCM_USER_12, SOFCM_USER_13, SOFCM_USER_14, SOFCM_USER_15, SOFCM_USER_16, SOFCM_USER_17, SOFCM_USER_18, SOFCM_USER_19, SOFCM_USER_20, SOFCM_USER_21, SOFCM_USER_22, SOFCM_USER_23, SOFCM_USER_24, SOFCM_USER_25, SOFCM_USER_26, SOFCM_USER_27, SOFCM_USER_28, SOFCM_USER_29, SOFCM_USER_30, SOFCM_USER_31, SOFCM_USER_32, STATE, TAX_CODE, TERMS_CODE, TIME_LAST_UPDT, UNAPPLIED_AMT, YTD_AMT_PAID, YTD_DAYS_PAID, YTD_LATE_PAID, ZIP_CODE