Stock Status, Query
Queries existing Stock Statuses using the provided criteria and returns a list of found Stock Statuss.
URL
/api/stock-status-query
Request Method
POST
Expandable Program
Stock Status Editor (ICESS)
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
{
"STORES_CODE": "MS",
"PART_ID": "MOTOR003",
"ON_HAND_QTY": "> 0",
"DATE_LAST_ACT": "BETWEEN 2015-01-01 AND 2015-02-01",
"AUTH_TOKEN": ""
}Full Request JSON
{
"STORES_CODE": "",
"PART_ID": "",
"STOCK_LOCATION": "",
"MULTI_LOC": "",
"SAFETY_STOCK": "",
"COUNT_DAYS": "",
"MO_BEG_QTY": "",
"YEAR_BEG_QTY": "",
"RECEIPTS_MTD": "",
"DATE_LAST_RECPT": "",
"RECEIPTS_YTD": "",
"ISSUES_MTD": "",
"DATE_LAST_ISSUE": "",
"ISSUES_YTD": "",
"PREV_YR_ISSUES": "",
"ADJUSTMTS_MTD": "",
"ADJUSTMTS_YTD": "",
"ON_HAND_QTY": "",
"DATE_LAST_ACT": "",
"BOOK_QTY": "",
"PHYSICAL_QTY": "",
"BATCH_NUMBER": "",
"DATE_LAST_PHY": "",
"DATE_LAST_PRINT": "",
"TXNS_ACCEPTED": "",
"KANBAN_FREQ": "",
"KANBAN_QTY": "",
"ICFSS_USER_1": "",
"ICFSS_USER_2": "",
"ICFSS_USER_3": "",
"ICFSS_USER_4": "",
"ICFSS_USER_5": "",
"ICFSS_USER_6": "",
"ICFSS_USER_7": "",
"ICFSS_USER_8": "",
"ICFSS_USER_9": "",
"ICFSS_USER_10": "",
"ICFSS_USER_11": "",
"ICFSS_USER_12": "",
"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 Stock Statuses which were found by the query:
200/OK
Returned JSON contains the Stock Statuses which were found by the query:
[
{
"STORES_CODE": "",
"PART_ID": "",
"STOCK_LOCATION": "",
"MULTI_LOC": "",
"SAFETY_STOCK": "",
"COUNT_DAYS": "",
"MO_BEG_QTY": "",
"YEAR_BEG_QTY": "",
"RECEIPTS_MTD": "",
"DATE_LAST_RECPT": "",
"RECEIPTS_YTD": "",
"ISSUES_MTD": "",
"DATE_LAST_ISSUE": "",
"ISSUES_YTD": "",
"PREV_YR_ISSUES": "",
"ADJUSTMTS_MTD": "",
"ADJUSTMTS_YTD": "",
"ON_HAND_QTY": "",
"DATE_LAST_ACT": "",
"BOOK_QTY": "",
"PHYSICAL_QTY": "",
"BATCH_NUMBER": "",
"DATE_LAST_PHY": "",
"DATE_LAST_PRINT": "",
"TXNS_ACCEPTED": "",
"KANBAN_FREQ": "",
"KANBAN_QTY": "",
"ICFSS_USER_1": "",
"ICFSS_USER_2": "",
"ICFSS_USER_3": "",
"ICFSS_USER_4": "",
"ICFSS_USER_5": "",
"ICFSS_USER_6": "",
"ICFSS_USER_7": "",
"ICFSS_USER_8": "",
"ICFSS_USER_9": "",
"ICFSS_USER_10": "",
"ICFSS_USER_11": "",
"ICFSS_USER_12": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": ""
}
]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 Stock Status 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 Stock Status query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}