Skip to content

QuoteCustomFieldAndValueList_Load_Quote#


Description#

This function loads custom field values from a Quote.

Request Parameters#

Parameter
Type Description
function String For module level functions this parameter will always have the value Module
module_code String The module code will always have the value quote for this function
module_function String Specifies the function being executed, in this case QuoteCustomFieldAndValueList_Load_Quote
quote_id
edit_quote
quote_code
Number
String
String
The id of the quote
The code of the quote
The code of the quote

Response Parameters#

Parameter
Type Description
success Boolean Boolean value indicating if the API request was successful
id Number The id number of the custom field
default_id Number Custom value default id
disp_order Number The display order of the custom values in the quote
code String Custom value code
type String Custom value field type (text, radio button, dropdown)
prompt String The selection prompt for the custom value
required Boolean Boolean value indicating if a response is required for the custom value field
options.data String Custom field string data

Example Request#

{
    "Store_code": "beta",
    "Function": "Module",
    "Module_Code": "quote",
    "Module_Function": "QuoteCustomFieldAndValueList_Load_Quote",
    "Quote_ID": 1010
}

Example Response#

{
    "success": 1,
    "data": [
        {
            "id": 1,
            "default_id": 0,
            "disp_order": 1,
            "code": "spec_instructions",
            "type": "text",
            "prompt": "Special Instructions",
            "required": false,
            "options": [],
            "data": "please make the coffee very special"
        },
        {
            "id": 2,
            "default_id": 0,
            "disp_order": 2,
            "code": "spec_radio_instructions",
            "type": "radio",
            "prompt": "Radio Spec Instructions",
            "required": false,
            "options": [],
            "data": ""
        },
        {
            "id": 3,
            "default_id": 0,
            "disp_order": 3,
            "code": "spec_dropdown_instructions",
            "type": "select",
            "prompt": "Spec Dropdown Instructions",
            "required": false,
            "options": [],
            "data": ""
        }
    ]
}

Error Responses#

Error Code Error Message Error Description
MER-UTL-QUOTES-00343 Quote not found Quote not found
MER-UTL-QUOTES-00346 Unable to load quote: One of Quote_ID, Edit_Quote, or Quote_Code must be specified Unable to load quote