api/StockStatus/Query (POST)

Queries existing Stock Statuses 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 Stock Statuses.

Request Information

Parameters

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

Query Single Stock Status Using Key Fields Example:
{
  "STORES_CODE": "MS",
  "PART_ID": "MOTOR003"
}
Returns 1 Stock Status if successful.
This is like 'Find' in Expandable.

Query Multiple Stock Statuses Using Other Fields Example:
{
  "ISSUES_MTD": "0",
  "MULTI_LOC": "Y"
}
Returns 1 or more Stock Statuses if successful.
This is like 'QBE' in Expandable.

Query Multiple Stock Statuses Using QBE Conditional Notation Example:
{
  "ON_HAND_QTY": "< 0",
  "DATE_LAST_ACT": "BETWEEN 1/1/2015 AND 2/1/2015"
}
Returns 1 or more Stock Statuses if successful.
This is like 'QBE' in Expandable.

Accepted Stock Status Fields:
ADJUSTMTS_MTD, ADJUSTMTS_YTD, BOOK_QTY, COUNT_DAYS, 
CREATED_BY, DATE_CREATED, DATE_LAST_ACT, DATE_LAST_ISSUE, 
DATE_LAST_PHY, DATE_LAST_PRINT, DATE_LAST_RECPT, DATE_LAST_UPDT, 
DATE_MODIFIED, ICFSS_USER_1, ICFSS_USER_10, ICFSS_USER_11, 
ICFSS_USER_12, ICFSS_USER_2, ICFSS_USER_3, ICFSS_USER_4, 
ICFSS_USER_5, ICFSS_USER_6, ICFSS_USER_7, ICFSS_USER_8, 
ICFSS_USER_9, ISSUES_MTD, ISSUES_YTD, KANBAN_FREQ, 
KANBAN_QTY, MO_BEG_QTY, MODIFIED_BY, MULTI_LOC, 
ON_HAND_QTY, OPERATOR_ID, PART_ID, PHYSICAL_QTY, 
PREV_YR_ISSUES, RECEIPTS_MTD, RECEIPTS_YTD, SAFETY_STOCK, 
STOCK_LOCATION, STORES_CODE, TIME_LAST_UPDT, YEAR_BEG_QTY

Define this parameter in the request body.

Response Information

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

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 Stock Status Fields:
ADJUSTMTS_MTD, ADJUSTMTS_YTD, BOOK_QTY, COUNT_DAYS, CREATED_BY, DATE_CREATED, DATE_LAST_ACT, DATE_LAST_ISSUE, DATE_LAST_PHY, DATE_LAST_PRINT, DATE_LAST_RECPT, DATE_LAST_UPDT, DATE_MODIFIED, ICFSS_USER_1, ICFSS_USER_10, ICFSS_USER_11, ICFSS_USER_12, ICFSS_USER_2, ICFSS_USER_3, ICFSS_USER_4, ICFSS_USER_5, ICFSS_USER_6, ICFSS_USER_7, ICFSS_USER_8, ICFSS_USER_9, ISSUES_MTD, ISSUES_YTD, KANBAN_FREQ, KANBAN_QTY, MO_BEG_QTY, MODIFIED_BY, MULTI_LOC, ON_HAND_QTY, OPERATOR_ID, PART_ID, PHYSICAL_QTY, PREV_YR_ISSUES, RECEIPTS_MTD, RECEIPTS_YTD, SAFETY_STOCK, STOCK_LOCATION, STORES_CODE, TIME_LAST_UPDT, YEAR_BEG_QTY