all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
mycartfavoriteslookup
Human Readable Name or Caption:
my cart favorites lookup
Page/Function Description:
This page will allow for the cart favorites to be looked up for use in an api setting. This method is actually being phased out. Please refer to this: getMyCartFavorites
Page/Function Output Type:
API - JSON or WDDX
Categories:
parts
Extra Page/Function Notes:
Created by Chris Dunsey


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORPID 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 CARTFAVORITESTATUS String 1 Pass in the string all for all, 1 for active, or 0 for inactive. Yes
Arguments CARTGROUPID Numeric 0 Pass in a 0 for all, a 1 for top/base level, or another numeric value as a filter. Yes
Arguments CARTMAKEPUBLIC String 1 Pass in the string all for all, 1 for active or public, or 0 for inactive or private. Yes
Arguments CUSTOMERTYPEID String 1 Pass in the customer type id filter. This may be a list of id numbers. Yes
Arguments FILTERBYPARTNUMBER String Pass in the optional part number or barcode filter. This only applies to the smart groups and what we call assignments. Yes
Arguments PAYEEID Numeric 0 Pass in the payee id number. Yes


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well.
Name Type Description Notes
ASSIGNMENTPARTID_LIST String Part id assignment list. Part id assignment list for smart groups and cart favorites.
MASTERCATEGORYID_LIST String Master category id list. Master category id list from cart favorites.
MASTERCATEGORYNAME_LIST String Master category name list. Master category name list from cart favorites.
MASTERPARTID_LIST String Master part id list. Master part id list from my cart favorites.
QRYGETASSIGNMENTPARTSDATA_ARRAY Array Assignment parts data array. Parts and vendor information array.
QRYGETSMARTGROUPRULES_ARRAY Array Smart group rules array. Smart group rules, prices, and tax category array.
QRY_FAVORITES_ARRAY Array Favorites array. My cart favorites array.
QRY_GROUPCUSTOMERS_ARRAY Array Group customers array. Group customer type array.
QRY_PARTS_ARRAY Array Parts array. Parts price information array.
dataIn Unable to get the requested my cart favorites. Missing some data. Use your back button and try again. This is returned if missing one or more of the required arguments (CARTFAVORITESTATUS, CARTGROUPID, CARTMAKEPUBLIC, CORP_ID, CUSTOMERTYPEID, FILTERBYPARTNUMBER and API_CURRENT_PAYEE_ID).
db Unable to connect to the database. Missing a list of requested my cart favorites. Use your back button and try again. This is a catch for any errors that occur while accessing the database.


Samples
Caption Text
JSON
{"API_URL_ENCODING": "AUTO","API_CURRENT_PAYEE_ID": 3,"CART_MAKE_PUBLIC": "all","API_CORP_KEY_ID": "use-53","API_USER_PASSWORD": 1234,"CORP_ID": 53,"API_CALL_FUNCTION_NAME": "mycartfavoriteslookup","CUSTOMER_TYPE_ID": 1,"API_INPUT_OUTPUT_TYPE": "JSON","CART_GROUP_ID": 0,"FILTER_BY_PART_NUMBER": "","API_USER_NAME": "demo"}