Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
getWebInventoryByEditDate |
Human Readable Name or Caption:
|
Get web inventory by edit date |
Page/Function Description:
|
This web service will return general web inventory data and information for parts, items, and services and will filter by edit date. This is the general parts or item search method. Results also include basic information for sub inventory (child items) and special tiered pricing. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
eComm,parts |
Extra Page/Function Notes:
|
also pulls sub inventory |
Parameters
|
|||||||
Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
Arguments | CORP_KEY_ID | String | Pass in the corporation key. If more than one, separate with a comma. Example: PLA-0053 or PLA-0053,ASP-0057 | Yes | |||
Arguments | PAGE_NUMBER | Numeric | 1 | Pass in the page number. Must be positive. Use 1 by default to get started. Use any other number if you are advancing the ball to other pages. As a note, the values TOTAL_PAGES and TOTAL_RECORDS will be returned with the record sets to show pagination options. | Yes | ||
Arguments | PART_CATEGORY_ID | String | All | Pass in the part category id number filter. This filter may be the string All, a real numeric value, or a list of numeric values. See the method getAllPartsCategories to help get possible part categories. | Yes | ||
Arguments | PART_NUMBER | String | All | Pass in the part number and/or description filter. The default is the string All. This filter, if used, will actually search 5 different fields at the same time. They are the part number, part id, description, reference number, and the barcode field. | Yes | ||
Arguments | SHOW_PER_PAGE | Numeric | 25 | Pass in the show per page number. Must be positive. It does cap out at 1000, but most normal values should be somewhere between 5-250 records per page. | Yes | ||
Arguments | SHOW_UNLIMITED | String | NO | The default is "no" which will just include your normal items. Pass in yes to show the unlimited items in the search results. As a hint: if you only want your special line items, change the part category to "2" and this value to "yes". | Yes | ||
Arguments | LAST_EDIT_DATE | Date | All | Pass in the last edit date or "All". All of the parts that have been created or edited since the last edit date will be shown. You can also pass in a date/time such as "7/6/2020 4:30 pm". | Yes |
Results
|
||||||||||||||||||||||||||||||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||||||||||||||||||||||
ok | success | This will be the main success message. This is what you are looking for if all is well. | ||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
searchLogicProblem | Unable to connect to the database. Missing a list of general inventory items that matched your search. | Use your back button and try again. | Not a list of general inventory items that matched your search. | |||||||||||||||||||||||||||||
zeroPartData | Unable to find any general inventory items that match your search criteria. | Use your back button and try again. | Not any general inventory items that match your search criteria. | |||||||||||||||||||||||||||||
startProblem | Sorry, the page can not find a suitable starting point. | Go back to the main [search web inventory] page or use your back button and try again. | Problems with start value in pagination. | |||||||||||||||||||||||||||||
pageNumberProblem | Unable to show the page. There was an error in showing the page number you requested. | Go back to the main [search web inventory] page or use your back button and try again. | Pagination error. | |||||||||||||||||||||||||||||
zeroParts | Unable to find any general inventory items that match your search. | Use your back button and try again. | No parts records. |
Samples
|
|
Caption | Text |
JSON |
{"API_CALL_FUNCTION_NAME":"getWebInventoryByEditDate","API_USER_PASSWORD":1234,"API_URL_ENCODING":"AUTO","API_INPUT_OUTPUT_TYPE":"JSON","SHOW_PER_PAGE":50,"API_CURRENT_PAYEE_ID":3,"PART_CATEGORY_ID":2741,"API_USER_NAME":"demo","PART_NUMBER":"All","SHOW_UNLIMITED":false,"API_CORP_KEY_ID":"PLA-0053","PAGE_NUMBER":1,"LAST_EDIT_DATE":"All","CORP_KEY_ID":"PLA-0053"}
|
Possible Response with sub inventory and tiered pricing |
{"RET_SECOND_MESSAGE":"","END_VALUE":4,"TOTAL_RECORDS":4,"CORP_IMAGE_FOLDER":"corp53_5FC2B3D1C9","START_VALUE":1,"TOTAL_PAGES":1,"RET_STATUS":"ok","RET_MAIN_MESSAGE":"success","RET_TYPE":"success","QRY_GENERAL_INVENTORY_ARRAY":[{"PHOTOCOUNT":0,"UOMDESCRIPTION":"Each","VENDORPAYEEID":28591,"PARTMARKUP":2.25,"PARTSALEPRICE":0.85000,"PARTWEIGHT":"","MARKEDUPPRICE":1.1250000,"TAXCATEGORYID":2,"WEB_SPECS":"","PARENT_ATTRIBUTES_ARRAY":[{"ATTRIBUTE_GROUP_ID":2,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Candy Attributes","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":4,"VALUE":"Fruity","TYPE":"select","NAME":"Flavor"},{"ID":3,"VALUE":50,"TYPE":"number","NAME":"Pieces Per Package"},{"ID":2,"VALUE":"Gummy","TYPE":"select","NAME":"Shape/Form"}]},{"ATTRIBUTE_GROUP_ID":3,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Distributors","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":5,"VALUE":"Yes","TYPE":"toggle","NAME":"Allow Discounts"},{"ID":6,"VALUE":10,"TYPE":"number","NAME":"Discount Amount"},{"ID":7,"VALUE":"Cosco","TYPE":"text","NAME":"Vendors"}]}],"CORPID":53,"PARTNUMBER":"Dots","PARTCATEGORYNAME":"Candy","WEB_VIDEO_LINK":"","WEB_REVIEWS":"","PARTDESCRIPTION":"Movie gum drops","PHOTOLIST":"","USEMARKUP":0,"WEBPRICESETTINGID":1,"THUMBNAIL":"default_th","PRICESETTINGSHORT":"Price","INVENTORYTYPEID":5,"WEB_ALTERNATE_MESSAGE":"","SMART_GROUP_COUNT":0,"SUB_CHILD_INVENTORY_ARRAY":[{"SUB_COST":0.50000,"SUB_PRICE":0.00000,"SUB_DISABLED":0,"SUB_ID":1,"TIME_ID":0,"SUB_QTY":480,"SUB_DESCRIPTION":"Movie gum drops","SUB_RFID":"","SUB_ATTRIBUTES":[{"ATTRIBUTE_NAME":"Count Per","ATTRIBUTE_TYPE":"number","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":1,"ATTRIBUTE_VALUE":1.00000},{"ATTRIBUTE_NAME":"Extras","ATTRIBUTE_TYPE":"text","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":2,"ATTRIBUTE_VALUE":"No Extras"},{"ATTRIBUTE_NAME":"Holiday","ATTRIBUTE_TYPE":"select","ATTRIBUTE_COLUMN":2,"ATTRIBUTE_ID":3,"ATTRIBUTE_VALUE":"Christmas"},{"ATTRIBUTE_NAME":"Best By Date","ATTRIBUTE_TYPE":"date","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":4,"ATTRIBUTE_VALUE":""}],"SUB_BAR_CODE":"b-1"},{"SUB_COST":0.50000,"SUB_PRICE":0.85000,"SUB_DISABLED":0,"SUB_ID":2,"TIME_ID":0,"SUB_QTY":170,"SUB_DESCRIPTION":"Movie gum drops","SUB_RFID":"","SUB_ATTRIBUTES":[{"ATTRIBUTE_NAME":"Count Per","ATTRIBUTE_TYPE":"number","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":1,"ATTRIBUTE_VALUE":1.00000},{"ATTRIBUTE_NAME":"Extras","ATTRIBUTE_TYPE":"text","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":2,"ATTRIBUTE_VALUE":"Blue"},{"ATTRIBUTE_NAME":"Holiday","ATTRIBUTE_TYPE":"select","ATTRIBUTE_COLUMN":2,"ATTRIBUTE_ID":3,"ATTRIBUTE_VALUE":"Easter"},{"ATTRIBUTE_NAME":"Best By Date","ATTRIBUTE_TYPE":"date","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":4,"ATTRIBUTE_VALUE":""}],"SUB_BAR_CODE":"b-2"},{"SUB_COST":0.50000,"SUB_PRICE":0.85000,"SUB_DISABLED":1,"SUB_ID":3,"TIME_ID":0,"SUB_QTY":200,"SUB_DESCRIPTION":"Movie gum drops","SUB_RFID":"","SUB_ATTRIBUTES":[{"ATTRIBUTE_NAME":"Count Per","ATTRIBUTE_TYPE":"number","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":1,"ATTRIBUTE_VALUE":1.00000},{"ATTRIBUTE_NAME":"Extras","ATTRIBUTE_TYPE":"text","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":2,"ATTRIBUTE_VALUE":"Fun"},{"ATTRIBUTE_NAME":"Holiday","ATTRIBUTE_TYPE":"select","ATTRIBUTE_COLUMN":2,"ATTRIBUTE_ID":3,"ATTRIBUTE_VALUE":"Halloween"},{"ATTRIBUTE_NAME":"Best By Date","ATTRIBUTE_TYPE":"date","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":4,"ATTRIBUTE_VALUE":"6/29/2020"}],"SUB_BAR_CODE":"b-3"},{"SUB_COST":0.50000,"SUB_PRICE":0.85000,"SUB_DISABLED":1,"SUB_ID":4,"TIME_ID":0,"SUB_QTY":100,"SUB_DESCRIPTION":"Movie gum drops","SUB_RFID":"","SUB_ATTRIBUTES":[{"ATTRIBUTE_NAME":"Count Per","ATTRIBUTE_TYPE":"number","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":1,"ATTRIBUTE_VALUE":2.00000},{"ATTRIBUTE_NAME":"Extras","ATTRIBUTE_TYPE":"text","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":2,"ATTRIBUTE_VALUE":"Fun"},{"ATTRIBUTE_NAME":"Holiday","ATTRIBUTE_TYPE":"select","ATTRIBUTE_COLUMN":2,"ATTRIBUTE_ID":3,"ATTRIBUTE_VALUE":"Other"},{"ATTRIBUTE_NAME":"Best By Date","ATTRIBUTE_TYPE":"date","ATTRIBUTE_COLUMN":1,"ATTRIBUTE_ID":4,"ATTRIBUTE_VALUE":""}],"SUB_BAR_CODE":"b-4"}],"PARTID":233903,"WEB_LONG_DESCRIPTION":"","WEBPRICE":0.00000,"PARTCATEGORYBUFFER":0,"PRICESETTINGTEXT":"Current Price (default)","SMART_GROUP_OPTIONS":[],"PARTCATEGORYID":2741,"UOMINITIALS":"ea.","PARTCOST":0.50000,"RFIDTAGNUMBER":"","WEB_RELATED_PARTS":""},{"PHOTOCOUNT":1,"UOMDESCRIPTION":"Each","VENDORPAYEEID":28591,"PARTMARKUP":1.87,"PARTSALEPRICE":0.85000,"PARTWEIGHT":"","MARKEDUPPRICE":0.8415000,"TAXCATEGORYID":2,"WEB_SPECS":"","PARENT_ATTRIBUTES_ARRAY":[{"ATTRIBUTE_GROUP_ID":2,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Candy Attributes","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":4,"VALUE":"Cinnamon","TYPE":"select","NAME":"Flavor"},{"ID":3,"VALUE":"","TYPE":"number","NAME":"Pieces Per Package"},{"ID":2,"VALUE":"Individual Pieces","TYPE":"select","NAME":"Shape/Form"}]},{"ATTRIBUTE_GROUP_ID":3,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Distributors","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":5,"VALUE":"","TYPE":"toggle","NAME":"Allow Discounts"},{"ID":6,"VALUE":"","TYPE":"number","NAME":"Discount Amount"},{"ID":7,"VALUE":"Cosco","TYPE":"text","NAME":"Vendors"}]}],"CORPID":53,"PARTNUMBER":"Hot_Tamales","PARTCATEGORYNAME":"Candy","WEB_VIDEO_LINK":"","WEB_REVIEWS":"","PARTDESCRIPTION":"Hot Tamales... Hot!","PHOTOLIST":"part-225446-1.jpg","USEMARKUP":0,"WEBPRICESETTINGID":1,"THUMBNAIL":"part-225446-th","PRICESETTINGSHORT":"Price","INVENTORYTYPEID":5,"WEB_ALTERNATE_MESSAGE":"","SMART_GROUP_COUNT":0,"SUB_CHILD_INVENTORY_ARRAY":[],"PARTID":225446,"WEB_LONG_DESCRIPTION":"","WEBPRICE":0.00000,"PARTCATEGORYBUFFER":0,"PRICESETTINGTEXT":"Current Price (default)","SMART_GROUP_OPTIONS":[],"PARTCATEGORYID":2741,"UOMINITIALS":"ea.","PARTCOST":0.45000,"RFIDTAGNUMBER":"","WEB_RELATED_PARTS":""},{"PHOTOCOUNT":0,"UOMDESCRIPTION":"Each","VENDORPAYEEID":28591,"PARTMARKUP":1.87,"PARTSALEPRICE":0.87000,"PARTWEIGHT":"","MARKEDUPPRICE":0.9350000,"TAXCATEGORYID":2,"WEB_SPECS":"","PARENT_ATTRIBUTES_ARRAY":[{"ATTRIBUTE_GROUP_ID":2,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Candy Attributes","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":4,"VALUE":"","TYPE":"select","NAME":"Flavor"},{"ID":3,"VALUE":"","TYPE":"number","NAME":"Pieces Per Package"},{"ID":2,"VALUE":"","TYPE":"select","NAME":"Shape/Form"}]},{"ATTRIBUTE_GROUP_ID":3,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Distributors","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":5,"VALUE":"","TYPE":"toggle","NAME":"Allow Discounts"},{"ID":6,"VALUE":"","TYPE":"number","NAME":"Discount Amount"},{"ID":7,"VALUE":"","TYPE":"text","NAME":"Vendors"}]}],"CORPID":53,"PARTNUMBER":"M_and_M","PARTCATEGORYNAME":"Candy","WEB_VIDEO_LINK":"","WEB_REVIEWS":"","PARTDESCRIPTION":"M&M's","PHOTOLIST":"","USEMARKUP":0,"WEBPRICESETTINGID":1,"THUMBNAIL":"default_th","PRICESETTINGSHORT":"Price","INVENTORYTYPEID":5,"WEB_ALTERNATE_MESSAGE":"","SMART_GROUP_COUNT":1,"SUB_CHILD_INVENTORY_ARRAY":[],"PARTID":225405,"WEB_LONG_DESCRIPTION":"","WEBPRICE":0.00000,"PARTCATEGORYBUFFER":0,"PRICESETTINGTEXT":"Current Price (default)","SMART_GROUP_OPTIONS":[{"CUSTOMER_TYPE_NAME":"General Customer","BUTTON_COLOR":"white","CUSTOMER_TYPE_ID":1,"CART_FAVORITE_ID":17186,"BUTTON_NAME":"Candy Tier ","BUTTON_RULES_ARRAY":[{"RULE_END":5.00000,"RULE_START":0.00000,"PRICE_PER_ITEM":1,"ITEM_PRICE":0.87000},{"RULE_END":12.00000,"RULE_START":5.01000,"PRICE_PER_ITEM":1,"ITEM_PRICE":0.80000},{"RULE_END":50.00000,"RULE_START":12.01000,"PRICE_PER_ITEM":0,"ITEM_PRICE":24.00000},{"RULE_END":99999999.99000,"RULE_START":50.01000,"PRICE_PER_ITEM":0,"ITEM_PRICE":24.00000}]}],"PARTCATEGORYID":2741,"UOMINITIALS":"ea.","PARTCOST":0.50000,"RFIDTAGNUMBER":"","WEB_RELATED_PARTS":""},{"PHOTOCOUNT":1,"UOMDESCRIPTION":"Each","VENDORPAYEEID":28591,"PARTMARKUP":1.87,"PARTSALEPRICE":0.87000,"PARTWEIGHT":"","MARKEDUPPRICE":0.9350000,"TAXCATEGORYID":2,"WEB_SPECS":"","PARENT_ATTRIBUTES_ARRAY":[{"ATTRIBUTE_GROUP_ID":2,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Candy Attributes","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":4,"VALUE":"Chocolate","TYPE":"select","NAME":"Flavor"},{"ID":3,"VALUE":"","TYPE":"number","NAME":"Pieces Per Package"},{"ID":2,"VALUE":"Bar","TYPE":"select","NAME":"Shape/Form"}]},{"ATTRIBUTE_GROUP_ID":3,"ATTRIBUTE_MAIN_CATEGORY_NAME":"Distributors","ATTRIBUTES_AND_VALUES_ARRAY":[{"ID":5,"VALUE":"Yes","TYPE":"toggle","NAME":"Allow Discounts"},{"ID":6,"VALUE":15.25000,"TYPE":"number","NAME":"Discount Amount"},{"ID":7,"VALUE":"Sam's Club, Costco","TYPE":"text","NAME":"Vendors"}]}],"CORPID":53,"PARTNUMBER":"Snickers","PARTCATEGORYNAME":"Candy","WEB_VIDEO_LINK":"","WEB_REVIEWS":"","PARTDESCRIPTION":"Snickers","PHOTOLIST":"part-225406-1.jpg","USEMARKUP":0,"WEBPRICESETTINGID":1,"THUMBNAIL":"part-225406-th","PRICESETTINGSHORT":"Price","INVENTORYTYPEID":5,"WEB_ALTERNATE_MESSAGE":"","SMART_GROUP_COUNT":1,"SUB_CHILD_INVENTORY_ARRAY":[],"PARTID":225406,"WEB_LONG_DESCRIPTION":"<p>This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger. This is a longer web description. It may end up being much, much, bigger.</p>","WEBPRICE":0.00000,"PARTCATEGORYBUFFER":0,"PRICESETTINGTEXT":"Current Price (default)","SMART_GROUP_OPTIONS":[{"CUSTOMER_TYPE_NAME":"General Customer","BUTTON_COLOR":"white","CUSTOMER_TYPE_ID":1,"CART_FAVORITE_ID":17186,"BUTTON_NAME":"Candy Tier ","BUTTON_RULES_ARRAY":[{"RULE_END":5.00000,"RULE_START":0.00000,"PRICE_PER_ITEM":1,"ITEM_PRICE":0.87000},{"RULE_END":12.00000,"RULE_START":5.01000,"PRICE_PER_ITEM":1,"ITEM_PRICE":0.80000},{"RULE_END":50.00000,"RULE_START":12.01000,"PRICE_PER_ITEM":0,"ITEM_PRICE":24.00000},{"RULE_END":99999999.99000,"RULE_START":50.01000,"PRICE_PER_ITEM":0,"ITEM_PRICE":24.00000}]}],"PARTCATEGORYID":2741,"UOMINITIALS":"ea.","PARTCOST":0.50000,"RFIDTAGNUMBER":"","WEB_RELATED_PARTS":""}]}
|
Outside links |
If you want to see this JSON response in a more readable format - we recommend copying the JSON portion into something like https://jsonlint.com/ and then reading it from there. Also, some of the output may look pretty intense due to normal URL encoding. We often have to flatten certain strings to send them over the web (spaces, special characters, etc.). If you need a visual URL decoder page, see the following small adilas tool for URL encoding - https://www.adilas.biz/web/url_encoder.cfm (this tool goes from web URL encoding back to normal English - back and forth).
|