api/CustomerPart/Query (POST)
Queries existing Customers Parts 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 Customer Parts.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing Customer Part query data.
Query Single Customer Part Using Key Fields Example:
{
"PART_ID": "PUMP002",
"CUSTOMER_ID": "ABCCORP",
"CUST_PART_ID": "LARGE-HYDRAULIC-PUMP"
}
Returns 1 Customer Part if successful.
This is like 'Find' in Expandable.
Query Multiple Customer Parts Using Other Fields Example:
{
"CONTRACT": "ABCCORP-001",
"SALE_STATUS": "A"
}
Returns 1 or more Customer Parts if successful.
This is like 'QBE' in Expandable.
Query Multiple Customer Parts Using QBE Conditional Notation Example:
{
"LAST_SO_PRICE": ">100",
"LAST_PRICE_CODE": "IN 'LP','PP'"
}
Returns 1 or more Customer Parts if successful.
This is like 'QBE' in Expandable.
Accepted Customer Part Fields:
COMMENT_1, COMMENT_2, COMMENT_3, COMMENT_4,
COMMENT_ID, CONTRACT, CREATED_BY, CURR_CODE,
CUST_PART_ID, CUSTOMER_ID, DATE_CREATED, DATE_LAST_QUOTE,
DATE_LAST_SO, DATE_LAST_UPDT, DATE_MODIFIED, DEF_STORES_CODE,
DWG_REV, EARLY_SHIP, ECN, ITEM_DISC_PCT,
LAST_DISC_PCT, LAST_PRICE_CODE, LAST_SO_ENTERED, LAST_SO_PRICE,
LAST_SO_QTY, LAST_SO_UM, MODIFIED_BY, OPERATOR_ID,
PART_ID, PARTIAL_SHIP, PRICE_CHG, PRICE_CODE,
PRODUCT_LINE, QUOTE_QTY, QUOTE_UNIT_PRIC, REFERENCE,
SALE_CONV, SALE_DEC, SALE_STATUS, SALESMAN_ID,
SHIP_LT, SHIP_TO_CUST, SN_REQD, SO_DESC,
SO_ORDER_QTY, SO_UM, SOFCP_USER_1, SOFCP_USER_2,
SOFCP_USER_3, SOFCP_USER_4, SOFCP_USER_5, SOFCP_USER_6,
SOFCP_USER_7, SOFCP_USER_8, SOFCP_USER_9, SOFCP_USER_10,
SOFCP_USER_11, SOFCP_USER_12, SOFCP_USER_13, SOFCP_USER_14,
TAX_CODE, TIME_LAST_UPDT, VAT_CODE |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON array with found Customer Parts.
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 Part Fields:
ATTACHMENTS, COMMENT_1, COMMENT_2, COMMENT_3, COMMENT_4, COMMENT_ID, CONTRACT, CREATED_BY, CURR_CODE, CUST_PART_ID, CUSTOMER_ID, DATE_CREATED, DATE_LAST_QUOTE, DATE_LAST_SO, DATE_LAST_UPDT, DATE_MODIFIED, DEF_STORES_CODE, DWG_REV, EARLY_SHIP, ECN, ITEM_DISC_PCT, LAST_DISC_PCT, LAST_PRICE_CODE, LAST_SO_ENTERED, LAST_SO_PRICE, LAST_SO_QTY, LAST_SO_UM, MODIFIED_BY, NOTES, OPERATOR_ID, PART_ID, PARTIAL_SHIP, PRICE_CHG, PRICE_CODE, PRODUCT_LINE, QUOTE_QTY, QUOTE_UNIT_PRIC, REFERENCE, SALE_CONV, SALE_DEC, SALE_STATUS, SALESMAN_ID, SHIP_LT, SHIP_TO_CUST, SN_REQD, SO_DESC, SO_ORDER_QTY, SO_UM, SOFCP_USER_1, SOFCP_USER_2, SOFCP_USER_3, SOFCP_USER_4, SOFCP_USER_5, SOFCP_USER_6, SOFCP_USER_7, SOFCP_USER_8, SOFCP_USER_9, SOFCP_USER_10, SOFCP_USER_11, SOFCP_USER_12, SOFCP_USER_13, SOFCP_USER_14, TAX_CODE, TIME_LAST_UPDT, VAT_CODE