Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
getSubInventoryById |
Human Readable Name or Caption:
|
Get Sub Inventory By ID |
Page/Function Description:
|
This method gets a single package or piece of sub inventory by the id number. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
parts |
Extra Page/Function Notes:
|
Parameters
|
|||||||
Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
Arguments | CORP_ID | Numeric | 0 | Pass in the corp id number. | Yes | ||
Arguments | PART_ID | Numeric | 0 | Pass in the parent part id number if known. If unknown, use a 0. | Yes | ||
Arguments | SUB_INVENTORY_ID | String | 0 | Pass in the sub inventory id number or a list of sub inventory id numbers. | Yes |
Results
|
||||||||||||||||||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||||||||||
ok | success | This indicates a valid response. There are a number of possible sub arrays that will also be passed back. More information is listed below. | ||||||||||||||||||
|
||||||||||||||||||||
dataIn | Unable to look-up sub inventory. Missing some data. | Use your back button and try again. | You will get this message if the inbound values do not meet the minimum criteria. | |||||||||||||||||
db | Something went wrong with the sub inventory look ups. Unable to proceed. | Use your back button and try again. | This message is a global catch for the method. If something happens mid stream in the process, you may get this message. |
Samples
|
|
Caption | Text |
JSON |
{"API_URL_ENCODING":"AUTO","API_CURRENT_PAYEE_ID":3,"API_CORP_KEY_ID":"PLA-0053","API_USER_PASSWORD":1234,"CORP_ID":53,"API_CALL_FUNCTION_NAME":"getSubInventoryById","PART_ID":225446,"API_INPUT_OUTPUT_TYPE":"JSON","SUB_INVENTORY_ID":58,"API_USER_NAME":"demo"}
|
Sample response with a copule of values |
{"QRY_SUB_INVENTORY_BY_ID_ARRAY":[{"SUB_QUANTITY":200.00000,"SUB_COST":0.50000,"SUB_RFID_TAG_NUMBER":"","INVOICE_NUMBER":0,"CORP_ID":53,"PART_ID":233903,"SPECIAL_DESCRIPTION":"Movie gum drops","SUB_INVENTORY_DATE":"2019-06-17","PART_NUMBER":"Dots","PO_INVOICE_LINE_ID":954,"PO_NUMBER":42,"SUB_UNIT_OF_MEASURE_ID":1,"SUB_DISABLED":0,"SUB_PRICE":0.85000,"SUB_REFERENCE_ID":2,"TIME_ID":0,"SUB_INVENTORY_ID":2,"RUNNING_SUB_QUANTITY":170.00000,"STORE_ID":178,"SUB_ATTRIBUTES":[{"ATTRIBUTE_NAME":"Count Per","ATTRIBUTE_TYPE":"number","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":1,"ATTRIBUTE_VALUE":1.00000},{"ATTRIBUTE_NAME":"Extras","ATTRIBUTE_TYPE":"text","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":2,"ATTRIBUTE_VALUE":"Blue"},{"ATTRIBUTE_NAME":"Holiday","ATTRIBUTE_TYPE":"select","ATTRIBUTE_COLUMN":2,"ATTRIBUTE_ID":3,"ATTRIBUTE_VALUE":"Easter"},{"ATTRIBUTE_NAME":"Best By Date","ATTRIBUTE_TYPE":"date","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":4,"ATTRIBUTE_VALUE":""}],"SUB_INVENTORY_STATUS":1,"SUB_BAR_CODE":"b-2","VENDOR_PAYEE_ID":28591}],"RET_SECOND_MESSAGE":"","QRY_SUB_INVENTORY_ATTRIBUTES_ARRAY":[{"ATTRIBUTE_REQUIRED":0,"ATTRIBUTE_TYPE":"number","COLUMN_NUMBER":1,"DATA_TYPE_TABLE":"custom_numerics","ATTRIBUTE_STATUS":1,"CORP_ID":53,"WEB_SEARCH_BY_ATTRIBUTE":0,"LABEL_POSITION":"","PART_CATEGORY_ID":2741,"ATTRIBUTE_VALUES":"1","ATTRIBUTE_NAME":"Count Per","SUB_INVENTORY_ATTRIBUTE_ID":1,"ATTRIBUTE_COLUMN":"n1","WEB_SHOW_ATTRIBUTE":1,"WEB_SORT_BY_ATTRIBUTE":0,"ATTRIBUTE_SORT":100,"ATTRIBUTE_HIDE":0},{"ATTRIBUTE_REQUIRED":0,"ATTRIBUTE_TYPE":"text","COLUMN_NUMBER":1,"DATA_TYPE_TABLE":"custom_text","ATTRIBUTE_STATUS":1,"CORP_ID":53,"WEB_SEARCH_BY_ATTRIBUTE":0,"LABEL_POSITION":"","PART_CATEGORY_ID":2741,"ATTRIBUTE_VALUES":"","ATTRIBUTE_NAME":"Extras","SUB_INVENTORY_ATTRIBUTE_ID":2,"ATTRIBUTE_COLUMN":"t1","WEB_SHOW_ATTRIBUTE":1,"WEB_SORT_BY_ATTRIBUTE":0,"ATTRIBUTE_SORT":100,"ATTRIBUTE_HIDE":0},{"ATTRIBUTE_REQUIRED":0,"ATTRIBUTE_TYPE":"select","COLUMN_NUMBER":2,"DATA_TYPE_TABLE":"custom_text","ATTRIBUTE_STATUS":1,"CORP_ID":53,"WEB_SEARCH_BY_ATTRIBUTE":0,"LABEL_POSITION":"","PART_CATEGORY_ID":2741,"ATTRIBUTE_VALUES":"Christmas|Halloween|Easter|Thanksgiving|4th of July|Other","ATTRIBUTE_NAME":"Holiday","SUB_INVENTORY_ATTRIBUTE_ID":3,"ATTRIBUTE_COLUMN":"t2","WEB_SHOW_ATTRIBUTE":1,"WEB_SORT_BY_ATTRIBUTE":0,"ATTRIBUTE_SORT":100,"ATTRIBUTE_HIDE":0},{"ATTRIBUTE_REQUIRED":0,"ATTRIBUTE_TYPE":"date","COLUMN_NUMBER":1,"DATA_TYPE_TABLE":"custom_dates","ATTRIBUTE_STATUS":1,"CORP_ID":53,"WEB_SEARCH_BY_ATTRIBUTE":0,"LABEL_POSITION":"","PART_CATEGORY_ID":2741,"ATTRIBUTE_VALUES":"","ATTRIBUTE_NAME":"Best By Date","SUB_INVENTORY_ATTRIBUTE_ID":4,"ATTRIBUTE_COLUMN":"d1","WEB_SHOW_ATTRIBUTE":1,"WEB_SORT_BY_ATTRIBUTE":0,"ATTRIBUTE_SORT":100,"ATTRIBUTE_HIDE":0}],"QRY_SUB_INVENTORY_TEMPLATE_ARRAY":[{"SUB_TEMPLATE_DESCRIPTION":"This category will be used for Candy.","SUB_TEMPLATE_NAME":"Candy","SUB_TEMPLATE_LOCKED":0,"USE_SUB_INVENTORY":1}],"RET_STATUS":"ok","RET_MAIN_MESSAGE":"success","RET_TYPE":"success"}
|
Outside Links |
If you want to see this JSON response in a more readable format - we recommend copying the JSON portion into something like https://jsonlint.com/ and then reading it from there. Also, some of the output may look pretty intense due to normal URL encoding. We often have to flatten certain strings to send them over the web (spaces, special characters, etc.). If you need a visual URL decoder page, see the following small adilas tool for URL encoding - https://www.adilas.biz/web/url_encoder.cfm (this tool goes from web URL encoding back to normal English - back and forth).
|