Customer, Query
Queries existing Customers using the provided criteria and returns a list of found Customers.
URL
/api/customer-query
Request Method
POST
Expandable Program
Customer Master Editor (SOECM)
Required Fields
(at least one field to be used as query criteria)
AUTH_TOKEN
AUTH_TOKEN
Auth Token
This API call requires an Authentication Token ("Auth Token") for the required field AUTH_TOKEN. Auth Tokens are obtained from Auth Token, Get.
Example Request JSON
{
"COUNTRY": "US",
"STATE": "IN 'CA','NV'",
"CURRENT_BALANCE": ">0",
"AUTH_TOKEN": ""
}Full Request JSON
{
"CUSTOMER_ID": "",
"CUSTOMER_NAME": "",
"SEARCH_NAME": "",
"SALESMAN_ID": "",
"AL_CUST_NAME": "",
"SALES_REGION": "",
"ADDRESS_1": "",
"ADDRESS_2": "",
"ADDRESS_3": "",
"CITY": "",
"STATE": "",
"COUNTRY": "",
"ZIP_CODE": "",
"E_MAIL": "",
"WEB_ADDRESS": "",
"LATITUDE": "",
"LONGITUDE": "",
"BILL_TO_CUST": "",
"FRT_BILL_TO": "",
"CUST_MARKET": "",
"PARENT_ID": "",
"SO_CONTACT": "",
"SO_PHONE_NO": "",
"FAX_NO": "",
"PRICE_CODE": "",
"PRICE_CODE_2": "",
"PRICE_CODE_3": "",
"TAX_CODE": "",
"ORDER_DISC_PCT": "",
"DEF_STORES_CODE": "",
"TAX_USAGE_TYPE": "",
"TAX_EXEMPT_NO": "",
"TAX_SRVC_VAT": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"NAICS_CODE": "",
"SIC_CODE": "",
"CLASS_CODE": "",
"SN_REQD": "",
"EARLY_SHIP": "",
"PARTIAL_SHIP": "",
"RESALE_ID": "",
"RESALE_ID_2": "",
"AR_CONTACT": "",
"AR_PHONE_NO": "",
"COMPANY_ID": "",
"SALES_DEPT": "",
"SALES_ACCT": "",
"TRANS_TYPE": "",
"DUNS_RATING": "",
"DUNS_DATE": "",
"DUNS_NUM": "",
"CREDIT_MGR": "",
"CREDIT_LIMIT": "",
"CREDIT_RATING": "",
"AR_REMIT_TO": "",
"TERMS_CODE": "",
"BANK_CODE": "",
"FIN_CHG_FLAG": "",
"AR_FIN_CHG_PCT": "",
"AR_MIN_FIN_CHG": "",
"CURR_CODE": "",
"LANGUAGE": "",
"CUSTOMER_TYPE": "",
"AUTO_SO_HOLD": "",
"AUTO_AR_INVOICE": "",
"CUSTOMER_STATUS": "",
"AGRMT_OFFSET": "",
"OFFSET_PERIOD": "",
"DATE_LAST_SO": "",
"DATE_LAST_INV": "",
"DATE_LAST_CHECK": "",
"DATE_LAST_STMT": "",
"DATE_LIMIT_UPDT": "",
"LAST_PAY_DAYS": "",
"YTD_AMT_PAID": "",
"HIGH_BALANCE": "",
"DATE_HIGH_BAL": "",
"SALES_YTD": "",
"SALES_LAST_YR": "",
"DISCOUNTS_YTD": "",
"CURRENT_ORDERS": "",
"LC_CURR_ORDERS": "",
"CURRENT_BALANCE": "",
"LC_CURRENT_BAL": "",
"UNAPPLIED_AMT": "",
"LC_UNAPPLIED": "",
"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": "",
"SLX_ACCOUNT": "",
"SLX_ID": "",
"COMMENT_ID": "",
"COMMENT_1": "",
"COMMENT_2": "",
"COMMENT_3": "",
"COMMENT_4": "",
"COMMENT_5": "",
"COMMENT_6": "",
"COMMENT_7": "",
"COMMENT_8": "",
"CHANNEL": "",
"GEO": "",
"MA_GEO": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": "",
"AUTH_TOKEN": ""
}QBE Notation
This query uses Expandable Query By Example (QBE) Notation. QBE Notation allows for conditional query criteria.
Not Equal To:
Greater Than:
Greater Than Or Equal To:
Less Than:
Less Than Or Equal To:
Between:
In:
Wildcard (any length):
Wildcard (single character):
Not Equal To:
"SO_STATUS": "<>X"Greater Than:
"ON_HAND_QTY": ">0"Greater Than Or Equal To:
"EFFECTIVE_DATE": ">=2016-01-01"Less Than:
"AMOUNT": "<100"Less Than Or Equal To:
"DATE_APPROVED": "<=2019-05-30"Between:
"ORDER_QTY": "BETWEEN 10 AND 100"In:
"LOT_STATUS": "IN A,C"Wildcard (any length):
"PART_ID": "MOTOR%"Wildcard (single character):
"SERIAL_NUMBER": "GC0000406_"Success Response
Returned HTTP status indicates success:
200/OK
Returned JSON contains the Customers which were found by the query:
200/OK
Returned JSON contains the Customers which were found by the query:
[
{
"CUSTOMER_ID": "",
"CUSTOMER_NAME": "",
"SEARCH_NAME": "",
"SALESMAN_ID": "",
"AL_CUST_NAME": "",
"SALES_REGION": "",
"ADDRESS_1": "",
"ADDRESS_2": "",
"ADDRESS_3": "",
"CITY": "",
"STATE": "",
"COUNTRY": "",
"ZIP_CODE": "",
"E_MAIL": "",
"WEB_ADDRESS": "",
"LATITUDE": "",
"LONGITUDE": "",
"BILL_TO_CUST": "",
"FRT_BILL_TO": "",
"CUST_MARKET": "",
"PARENT_ID": "",
"SO_CONTACT": "",
"SO_PHONE_NO": "",
"FAX_NO": "",
"PRICE_CODE": "",
"PRICE_CODE_2": "",
"PRICE_CODE_3": "",
"TAX_CODE": "",
"ORDER_DISC_PCT": "",
"DEF_STORES_CODE": "",
"TAX_USAGE_TYPE": "",
"TAX_EXEMPT_NO": "",
"TAX_SRVC_VAT": "",
"SHIP_METHOD": "",
"FOB": "",
"FREIGHT_CODE": "",
"NAICS_CODE": "",
"SIC_CODE": "",
"CLASS_CODE": "",
"SN_REQD": "",
"EARLY_SHIP": "",
"PARTIAL_SHIP": "",
"RESALE_ID": "",
"RESALE_ID_2": "",
"AR_CONTACT": "",
"AR_PHONE_NO": "",
"COMPANY_ID": "",
"SALES_DEPT": "",
"SALES_ACCT": "",
"TRANS_TYPE": "",
"DUNS_RATING": "",
"DUNS_DATE": "",
"DUNS_NUM": "",
"CREDIT_MGR": "",
"CREDIT_LIMIT": "",
"CREDIT_RATING": "",
"AR_REMIT_TO": "",
"TERMS_CODE": "",
"BANK_CODE": "",
"FIN_CHG_FLAG": "",
"AR_FIN_CHG_PCT": "",
"AR_MIN_FIN_CHG": "",
"CURR_CODE": "",
"LANGUAGE": "",
"CUSTOMER_TYPE": "",
"AUTO_SO_HOLD": "",
"AUTO_AR_INVOICE": "",
"CUSTOMER_STATUS": "",
"AGRMT_OFFSET": "",
"OFFSET_PERIOD": "",
"DATE_LAST_SO": "",
"DATE_LAST_INV": "",
"DATE_LAST_CHECK": "",
"DATE_LAST_STMT": "",
"DATE_LIMIT_UPDT": "",
"LAST_PAY_DAYS": "",
"YTD_AMT_PAID": "",
"HIGH_BALANCE": "",
"DATE_HIGH_BAL": "",
"SALES_YTD": "",
"SALES_LAST_YR": "",
"DISCOUNTS_YTD": "",
"CURRENT_ORDERS": "",
"LC_CURR_ORDERS": "",
"CURRENT_BALANCE": "",
"LC_CURRENT_BAL": "",
"UNAPPLIED_AMT": "",
"LC_UNAPPLIED": "",
"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": "",
"SLX_ACCOUNT": "",
"SLX_ID": "",
"COMMENT_ID": "",
"COMMENT_1": "",
"COMMENT_2": "",
"COMMENT_3": "",
"COMMENT_4": "",
"COMMENT_5": "",
"COMMENT_6": "",
"COMMENT_7": "",
"COMMENT_8": "",
"CHANNEL": "",
"GEO": "",
"MA_GEO": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": "",
"NOTES": "",
"ATTACHMENTS": ""
}
]Failure Response
Returned HTTP status indicates failure:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Customer query:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Customer query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}