Skip to content

`Quote_Load_ID`#

Description#

This function loads the meta details of 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 `Quote_Update_Requester_Information`
`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	Quote id
`cust_id`	Number	Customer id
`order_id`	Number	Order id associated with the quote
`code`	String	Quote code
`email`	String	Email Address
`fname`	String	First Name
`lname`	String	Last Name
`phone`	String	Phone Number
`zip`	String	Zip Code
`country`	String	Country
`comment`	String	Quote comments
`status`	Number	Quote status
`created`	Number	Unix timestamp for the quote creation date
`total`	Number	Quote Total
`formatted_total`	String	Currency Formatted Total
`terms`	String	Terms
`expires`	Number	Unix timestamp for the quote expiration date

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "Module",
    "Module_Code": "quote",
    "Module_Function": "Quote_Load_ID",
    "Quote_ID": 1002
}

Example Response#

{
    "success": 1,
    "data": {
        "id": 1002,
        "cust_id": 0,
        "order_id": 0,
        "code": "6SW3-BU4U-UQGQ-G4LQ",
        "email": "kofipot@email.com",
        "fname": "Kofi",
        "lname": "Pot",
        "phone": "801-123-7895",
        "zip": "10021",
        "country": "US",
        "comment": "coffee tools not included",
        "status": 6,
        "created": 1620008437,
        "total": 2644.7,
        "formatted_total": "$2,644.70",
        "terms": "",
        "expires": 0
    }
}

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