Expandable Web API - Customer Part, Query

Customer Part, Query

Queries existing Customer Parts using the provided criteria and returns a list of found Customer Parts.

URL

/api/customer-part-query

Request Method

POST

Expandable Program

Customer Part Editor (SOECP)

Required Fields

(at least one field to be used as query criteria)
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

{
  "LAST_SO_PRICE": ">100",
  "LAST_PRICE_CODE": "IN 'LP','PP'",
  "AUTH_TOKEN": ""
}

Full Request JSON

{
  "PART_ID": "",
  "CUSTOMER_ID": "",
  "CUST_PART_ID": "",
  "SALESMAN_ID": "",
  "CONTRACT": "",
  "SALE_STATUS": "",
  "REFERENCE": "",
  "SHIP_LT": "",
  "SO_DESC": "",
  "SO_UM": "",
  "SALE_CONV": "",
  "SO_ORDER_QTY": "",
  "ECN": "",
  "PARTIAL_SHIP": "",
  "DWG_REV": "",
  "DEF_STORES_CODE": "",
  "EARLY_SHIP": "",
  "SN_REQD": "",
  "TAX_CODE": "",
  "PRODUCT_LINE": "",
  "VAT_CODE": "",
  "DATE_LAST_QUOTE": "",
  "PRICE_CODE": "",
  "QUOTE_QTY": "",
  "CURR_CODE": "",
  "QUOTE_UNIT_PRIC": "",
  "ITEM_DISC_PCT": "",
  "PRICE_CHG": "",
  "LAST_SO_ENTERED": "",
  "DATE_LAST_SO": "",
  "LAST_SO_QTY": "",
  "LAST_SO_UM": "",
  "LAST_SO_PRICE": "",
  "LAST_DISC_PCT": "",
  "LAST_PRICE_CODE": "",
  "COMMENT_ID": "",
  "COMMENT_1": "",
  "COMMENT_2": "",
  "COMMENT_3": "",
  "COMMENT_4": "",
  "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": "",
  "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:

"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 Customer Parts which were found by the query:

[
  {
    "PART_ID": "",
    "CUSTOMER_ID": "",
    "CUST_PART_ID": "",
    "SALESMAN_ID": "",
    "CONTRACT": "",
    "SALE_STATUS": "",
    "REFERENCE": "",
    "SHIP_LT": "",
    "SO_DESC": "",
    "SO_UM": "",
    "SALE_CONV": "",
    "SO_ORDER_QTY": "",
    "ECN": "",
    "PARTIAL_SHIP": "",
    "DWG_REV": "",
    "DEF_STORES_CODE": "",
    "EARLY_SHIP": "",
    "SN_REQD": "",
    "TAX_CODE": "",
    "PRODUCT_LINE": "",
    "VAT_CODE": "",
    "DATE_LAST_QUOTE": "",
    "PRICE_CODE": "",
    "QUOTE_QTY": "",
    "CURR_CODE": "",
    "QUOTE_UNIT_PRIC": "",
    "ITEM_DISC_PCT": "",
    "PRICE_CHG": "",
    "LAST_SO_ENTERED": "",
    "DATE_LAST_SO": "",
    "LAST_SO_QTY": "",
    "LAST_SO_UM": "",
    "LAST_SO_PRICE": "",
    "LAST_DISC_PCT": "",
    "LAST_PRICE_CODE": "",
    "COMMENT_ID": "",
    "COMMENT_1": "",
    "COMMENT_2": "",
    "COMMENT_3": "",
    "COMMENT_4": "",
    "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": "",
    "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 Part query:

{
  "MESSAGE": "",
  "MESSAGE_CODE": ""
}

Try the API