24/7 Support: 800.608.6482

Navigation


QuoteCustomFieldAndValueList_Load_Quote

This function loads custom field values from a Quote.

Quote may be specified using product_id, product_code, edit_product or product_sku. Only one indentifier is needed.

Request Parameters

store_code Type:
String
Title:
Store Code
Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String
Title:
Module
For module level functions this parameter will always have the value "Module"
module_code Type:
String
Title:
Quote
The module code will always have the value "quote" for this function
module_function Type:
String
Title:
Module_Function
Specifies the function being executed, in this case "QuoteCustomFieldAndValueList_Load_Quote"
quote_id Type:
Number
Title:
Quote Id
The id number of the quote

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
id Type:
Number
Title:
Custom Field Value Id
The id number of the custom field
default_id Type:
Number
Title:
Default ID
Custom value default id
disp_order Type:
Number
Title:
Display Order
The display order of the custom values in the quote
code Type:
String
Title:
Custom Value Code
Custom value code
type Type:
String
Title:
Custom Value Field Type
Custom value field type (text, radio button, dropdown)
prompt Type:
String
Title:
Custom Value Selection Prompt
The selection prompt for the custom value
required Type:
Boolean
Title:
Required
Boolean value indicating if a response is required for the custom value field
options
+ Show Properties
Type:
Object
Title:
Options
Custom field options data
data Type:
String
Title:
Data
Custom field string data

Example Request

Example Response

Error Responses

error code:
MER-UTL-QUOTES-00343
error message:
Quote not found
description:
Quote not found
error code:
MER-UTL-QUOTES-00346
error message:
Unable to load quote: One of Quote_ID, Edit_Quote, or Quote_Code must be specified
description:
Unable to load quote

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2021 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.