all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getMyCartFavorites
Human Readable Name or Caption:
Get My Cart Favorites
Page/Function Description:
This page will allow for the cart favorites to be looked up for use in an api setting
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,parts
Extra Page/Function Notes:
Adapted from myCartFavoritesLookup.cfm created by Chris Dunsey


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CART_FAVORITE_STATUS String 1 Pass in the string all for all, 1 for active, or 0 for inactive. No
Arguments CART_GROUP_ID Numeric 0 Pass in a 0 for all, a 1 for top/base level, or another numeric value as a filter. As a note, if you pass in another numeric value, it's actually the primary key for another button. This is how the buttons are potentially stacked or grouped. For example, say you had a top level button with a button id of 5 called "desserts," and underneath that you had other buttons like pies, cakes, ice cream, etc. Basically you would pass in the number 5 to get to that second tier of buttons. No
Arguments CART_MAKE_PUBLIC String 1 Pass in the string all for all, 1 for active or public, or 0 for inactive or private. This argument is used internally when we allow users to copy each others buttons. Often we will only show the ones marked as public. No
Arguments CORP_ID 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 CUSTOMER_TYPE_ID String 1 Pass in the customer type id filter. This may be a list of id numbers. This is set per corporation. You must look these values up. See the getLookUpValues method for details. As a note, certain buttons actually have certain pricing structures based on what kind of client is being serviced. For example, you may have a certain pricing for VIP's, certain pricing for family members, and a certain price for walk-in customers. This filter allows you to only search for the buttons associated with the customer type you are looking for. Once again, this is an optional param or filter and is not required. No
Arguments FILTER_BY_PART_NUMBER String Pass in the optional part number or barcode filter. This only applies to button types that we call smart groups. Each smart group button has a number of assignments and special rules, aka tiered pricing, that apply to the smart group button. No
Arguments PAYEE_ID Numeric 0 Pass in the payee id number. Internally, this is the person whose buttons they are that you're trying to use. For example, if Sammy has payee id #777 and you want to use his buttons, you need to pass in 777 as the payee id. If you want to use yours, and your id is 212, use that 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_CALL_FUNCTION_NAME":"getmycartfavorites","CART_GROUP_ID":1,"API_USER_PASSWORD":1234,"API_URL_ENCODING":"AUTO","API_INPUT_OUTPUT_TYPE":"JSON","CORP_ID":53,"API_CURRENT_PAYEE_ID":3,"PAYEE_ID":2,"API_USER_NAME":"demo","CART_FAVORITE_STATUS":1,"API_CORP_KEY_ID":"use-53","CUSTOMER_TYPE_ID":1,"CART_MAKE_PUBLIC":"all","FILTER_BY_PART_NUMBER":""}