all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
searchParts |
|
Human Readable Name or Caption:
|
Search Parts |
|
Page/Function Description:
|
This method will do a search for corporation parts. |
|
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_ID | Numeric | 0 | Pass in the corp id number. | Yes | ||
| Arguments | MATCH_PART | Numeric | 0 | Pass in a 1 for exact and 2 for like. | Yes | ||
| Arguments | PART_CATEGORY_ID | Numeric | 0 | Pass in the part category id number filter. | Yes | ||
| Arguments | PART_NUMBER | String | Pass in the part number. | Yes | |||
| Arguments | STORE_ID | Numeric | 0 | Pass in the location id filter. | Yes | ||
| Arguments | VENDOR_PAYEE_ID | String | 0 | Pass in the vendor payee id number or list of payee id numbers. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| corpSettings | Missing the correct corp-wide settings. Unable to proceed. | Use your back button and try again. | This is returned if no corp settings could be found associated with the CORP_ID. | |
| dbZero | Unable to get the required corp-wide settings. Missing some data. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. | |
| dataIn | Unable to search for the [default_part_name] requested. Missing some data. | Use your back button and try again. | This is returned if missing one or more of the following arguments: CORP_ID, MATCH_PART, PART_NUMBER, STORE_ID. | |
| db | Unable to connect to the database. Missing a list of [default_part_name] for your [default_corp_type]. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. | |
|
Samples
|
|
| Caption | Text |