Main Web API Documentation Information
Actual Page/Function Name:
getFullQuoteDetails
Human Readable Name or Caption:
Get Full Quote Details
Page/Function Description:
This method will get all details of a single quote.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,quote
Extra Page/Function Notes:
This gets all the main information back for a single quote. This includes main info, customer info, line items, etc.


Parameters
Scope Name Type Default Description Required Alternates Known Values
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 QUOTE_NUMBER Numeric 0 Pass in the quote number. This is one of the keys that ties things together. Yes
Arguments LINE_SHOW String hide Pass in the string "all" for all visible and non-visible line items. Use the string "hide" for only visible lines. 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
QRY_MAIN_QUOTE_DETAILS_ARRAY Array This array contains the main quote details. It contains values like corp id, customer id, po number, invoice number, salesperson id, quote amount, notes, date, etc.
QRY_STORE_INFO_ARRAY Array This array contains the location info. This is used when converting from quote to shopping cart. This holds the tax title information.
QUOTE_LINE_ARRAY Array This array holds the quote line data. This has information like catalog page, city tax, corp id, county tax, line total, discounts, line description, item cost, make name, tax, etc.
QRY_ADDITIONAL_CUSTOMERS_ARRAY Array This array contains any additional customers that are tied to the unit. This contains values like customer id, notes, contact info for the additional customer, customer type, etc.
QRY_HIDDEN_LINE_ITEMS_ARRAY Array This is a count of hidden line items. See description.
QRY_ELEMENTS_OF_TIME_ARRAY Array This is an array with all elements of time that are associated with the quote. This contains info like start date, end date, general amount, notes, title, invoice number, quote number, time id, comments, etc.
QRY_TIME_SUB_DATES_ARRAY Array This array contains the time sub date/times. This has info like sub date notes, sort info, title, end date, end time, start date, start time, etc.
QRY_TIME_SUB_NOTES_ARRAY Array This array has the time sub notes and comments if there are any. This has values like sub comment date, notes, sort info, time title, etc.
FLEX_GRID_COUNT Numeric This is the total number of records in the flex grid. See description.
SUB_TOTAL Decimal This is the sum of the line amounts. See description.
TOTAL_TAX Decimal This is the sum of the tax in the lines. See description.
GRAND_TOTAL Decimal This is the sum of the extended line amounts. See description.
ORIGINAL_TOTAL Decimal This is the sum of the original line total. See description.
SAVINGS_TOTAL Decimal This is the sum of the savings line amounts. See description.
CART_AS_A_WHOLE_DISCOUNT Decimal This is the discount rate. See description.
CART_AS_A_WHOLE_DISCOUNT_CAMPAIGN String This is the discount campaign value from the get main quote details query. See description.
SHOW_DISCOUNT_COLUMNS Boolean This is a value to see if we need to show the in-line discount values. See description.
dataIn Unable to get the quote details. Missing some data. Use your back button and try again. This is returned if the required values (corp id, quote number, and line show) are either missing or are the wrong length.
zero Unable to find the quote you requested in the database. Use your back button and try again. This is returned if the record count is "0" for the requested data.
db Unable to connect to the database. Missing the main quote information. Use your back button and try again. This is a catch for any errors that occur while grabbing and setting up the returning quote structure.
stock Unable to find the stock number #tempLine_st.stock#. Missing quote line items. Use your back button and try again. This is returned if the record count is "0" for the stock line items query.
db2 Unable to connect to the database. Missing the quote line items information Use your back button and try again. This is a catch for any errors that occur while querying for the quote line items.
db3 Problems while doing math on quote totals. Missing the quote line items information. Use your back button and try again. This is a catch for any errors that occur while querying values such as line quantity, item price, city tax, etc. and doing math for the total, sub total, and tax total.


Samples
Caption Text
JSON
{"API_CALL_FUNCTION_NAME":"getFullQuoteDetails ","CORP_ID":53,"QUOTE_NUMBER":2,"LINE_SHOW":"all","API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}