Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
mixedCartSearch |
Human Readable Name or Caption:
|
Mixed Cart Search |
Page/Function Description:
|
This is the mixed cart search method. It will search barcodes for parts, flex grid tie-ins, recipe/builds, and my cart favorite buttons. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
parts,flex grid |
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 | PAYEE_ID | Numeric | 0 | Pass in the payee id number of the person doing the search. | Yes | ||
Arguments | SEARCH_TYPE_ID | Numeric | 5 | Pass in the value 4 for my cart favorites (standalone) or the value 5 for the mixed source barcode search. Most times it will be the value 5. | Yes | ||
Arguments | SEARCH_VALUE | String | Pass in the barcode value or general search string. | Yes | |||
Arguments | STORE_ID | Numeric | 0 | Pass in the store id (location id number). This will help with quantities on hand for that location. Any store id number under 2 will be skipped. The default is 0 (meaning skip it). We do recommend that you pass the real value if known... it will affect the quantities that are available. | Yes |
Results
|
||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
Samples
|
|
Caption | Text |
JSON |
{"API_URL_ENCODING":"AUTO","API_CURRENT_PAYEE_ID":3,"PAYEE_ID":3,"API_CORP_KEY_ID":"PLA-0053","API_USER_PASSWORD":1234,"CORP_ID":53,"API_CALL_FUNCTION_NAME":"mixedCartSearch","SEARCH_VALUE":"sn","API_INPUT_OUTPUT_TYPE":"JSON","STORE_ID":178,"SEARCH_TYPE_ID":5,"API_USER_NAME":"demo"}
|