all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getWebInventory
Human Readable Name or Caption:
Get Web Inventory
Page/Function Description:
This web service will return web inventory data and information for stock units. A stock unit is a big-ticket item. For example: a trailer, a Jeep Grand Cherokee, a modular home, jewelry, etc. Something that has a serialized inventory value.
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). If more than one, separate with a comma. Example: PLA-0053 or PLA-0053,ASP-0057. Yes
Arguments INVENTORY_TYPE_ID String Pass in the inventory type id filter. Ok to leave blank. Can comma separate for multiple values. Use 2=Trailer, 3=Vehicle, 4=Topper, 5=Items/Parts, 6=Flatbeds, 7=Labor/Services, 8=Specific Unit, 9=Rental, 10=Balance Sheet Items. No
Arguments LOCATION_ID String Pass in the store/location id filter. OK to leave blank. May comma separate. No
Arguments MAKE_ID String Pass in the make id filter. OK to leave blank. May comma separate. To get a list of makes, see this method: getGeneralLookupValues. No
Arguments MODEL String Pass in the model filter. OK to leave blank or All. May comma separate. This is a text value instead of an id number. For example, if you're looking at a Jeep, the model might be "Cherokee." No
Arguments PAGE_NUMBER Numeric 1 Pass in the page number. Must be positive. No
Arguments SHOW_PER_PAGE Numeric 25 Pass in the show per page number. Must be positive. No
Arguments SUB_INVENTORY_TYPE_ID String Pass in the sub inventory type id filter. OK to leave blank. Can comma separate. Sub inventories are things such as SUV's, trucks, auto, RV's, open utility trailers, cargo trailers, etc. As a note, each of these sub inventory types has an ID that needs to be passed in behind the scenes. Go here to look it up: getGeneralLookupValues. No


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
passed success This will be the main success message. This is what you are looking for if all is well.
Name Type Description Notes
QRY_GENERAL_INVENTORY_ARRAY Array This is the main data array. This returns extensive stock and inventory information including descriptions, dates, and prices.
zeroStockData Unable to find any stock units that match your search. Use your back button and try again. No stock units that match your search.
pageNumberProblem Unable to show the page. There was an error in showing the page number you requested. Go back to the main [search web inventory} page or use your back button and try again. Pagination problem.
startProblem Sorry, the page can not find a suitable starting point. Go back to the main [search web inventory] page or use your back button and try again. Starting page value for pagination was not found.
searchLogicProblem Unable to connect to the database. Missing a list of stock units that matched your search. Use your back button and try again. Missing a list of stock units that matched your search.
priceProblem Unable to connect to the database. Missing a list of unit prices. Use your back button and try again Missing a list of unit prices.


Samples
Caption Text
JSON
{"API_URL_ENCODING": "AUTO", "API_CURRENT_PAYEE_ID": 3,"API_CORP_KEY_ID": "PLA-0053","API_USER_PASSWORD": 1234,"API_CALL_FUNCTION_NAME": "getWebInventory","PAGE_NUMBER": 1,"API_INPUT_OUTPUT_TYPE": "JSON","CORP_KEY_ID": "PLA-0053","INVENTORY_TYPE_ID": "","LOCATION_ID": "","MAKE_ID": "","MODEL": "","API_USER_NAME": "demo","SHOW_PER_PAGE": 25,"SUB_INVENTORY_TYPE_ID": ""}