all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
quickPartQuantity
Human Readable Name or Caption:
Quick Part Quantity
Page/Function Description:
This is a quick and dirty parts quantity check for one or more items at a time.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,parts
Extra Page/Function Notes:
As a note, all quantities are tied to an item per location. Also, the inventory date allows you to go back in time if needed.


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORP_ID Numeric 0 Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. Yes
Arguments INVENTORY_DATE String Pass in the inventory look-up date. Most times it is the current date. If an older date is used, the system only looks for quantities and transaction from that date back. Yes
Arguments PART_ID_LIST String Pass in one or more part id numbers separated with a comma in a list form. The part id is the system-assigned auto id number for the item or part. Yes
Arguments SHOW_GROUPS Numeric 0 Pass in a 1 for yes and a 0 for no. If 1, grab all locations and all quantities. No
Arguments STORE_ID Numeric 0 Pass in the store or location id number. This value is corporation specific and can be looked up by going to the getGeneralLookupValues method. You'll be looking for the QRY_LOCATION_INFO_ARRAY data. This is a huge part of how we track quantities per location. If you have multiple locations, this is extremely important. No


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well.
Name Type Description Notes
QRY_QUICK_QUANTITIES_ARRAY Array This array grabs the quick quantities. See description.
QRY_ALL_QUANTITIES_ARRAY Array This array grabs the quick quantities and groups them by the part id and store id numbers. See description.
QRY_QUANTITY_LOCATIONS_ARRAY Array This array contains all the location information. This holds data like store id, store initials, store name, and store status.
QRY_QUANTITY_TOTALS_ARRAY Array This array holds the total quantities per part number. See description.
SHOW_GROUPS Boolean This returns a 1 or 0 for whether the groups should be shown. See description.
dataIn Unable to run the get quick quantities function. Missing some data. Use your back button and try again. This is returned if you're missing the required arguments (corp id or part id list).
dataIn2 Unable to run the get quick quantities function. Missing the inventory date value. Use your back button and try again. This is returned if the "inventory date" value is not a date.
corpSettings Missing the correct corp-wide settings. Unable to proceed. Use your back button and try again. This is returned if no corp-wide settings are found for your corp id.
db Unable to connect to the database. Missing the quick [name] quantities that were requested. Use your back button and try again. There was an error querying values for the selected corp id or store id.


Samples
Caption Text
JSON
{"API_URL_ENCODING":"AUTO","PART_ID_LIST":"49626, 49729","SHOW_GROUPS":1,"API_CURRENT_PAYEE_ID":3,"API_CORP_KEY_ID":"PLA-0053","API_USER_PASSWORD":1234,"CORP_ID":53,"API_CALL_FUNCTION_NAME":"quickPartQuantity","API_INPUT_OUTPUT_TYPE":"JSON","INVENTORY_DATE":"05/30/16","STORE_ID":178,"API_USER_NAME":"demo"}