all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getPartNumberDetails
Human Readable Name or Caption:
Get Part Number Details
Page/Function Description:
This web service will return the main part number info and any photo info for the item. Use this method to get basic web inventory details for a single item.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,parts
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 PART_ID Numeric 0 Pass in the part id number. This is the system-assigned auto id number for the item or part. Example: 225446 Yes


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
passed success
Name Type Description Notes
QRY_PART_INFO_ARRAY Array This array contains details about the part number. This has information like inventory type, cost, part description, part number, web price, part category, etc.
QRY_PHOTO_INFO_ARRAY Array This array contains the part photos if there are any. This contains the image caption, number, sort information, part id, and photographer information.
partIdProblem The part id number must be a positive number. Unable to proceed. Use your back button and try again. This is returned if the part id number is less than 1.
noPart Unable to find the part number that you requested. Use your back button and try again. This is returned if the query couldn't find any data for the requested part number.
partLogicProblem Unable to connect to the database. Missing the part number details. Use your back button and try again. This is a catch for any errors that occur while querying for part number details.


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":"getPartNumberDetails","PART_ID":225446,"API_INPUT_OUTPUT_TYPE":"JSON","CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo"}