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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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"}
|