all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
getStockUnitDetails |
|
Human Readable Name or Caption:
|
get stock unit details |
|
Page/Function Description:
|
This web service will return the main stock unit info and any photo info for the unit. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
eComm,stock/unit |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | CORP_KEY_ID | String | Pass in the corporation key. This is a combination of 3 letters from the corporation name, a dash, and then the actual corp id number. Ex: PLA-0053, XYZ-0123. As a note, the corporation ID may be padded with zeros. This is not required, but it will be added if the number is system-generated (the numbers will be stripped off later). | Yes | |||
| Arguments | STOCK | Numeric | 0 | Pass in the stock number. This helps with options after a successful database action. | Yes | ||
|
Results
|
||||||||||||||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||||||
| passed | success | This assumes that everything went well. | ||||||||||||||
|
||||||||||||||||
| noStockUnit | Unable to find the stock unit that you requested. | Use your back button and try again. | This is returned if the main query is unable to run. | |||||||||||||
| stockLogicProblem | Unable to connect to the database. Missing the stock unit details. | Use your back button and try again. | This is returned if the stock photo query is unable to run. | |||||||||||||
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"getstockunitdetails","STOCK":2,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","CORP_KEY_ID":"PLA-0053","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}
|