Quote_Create_Empty
Description
This function creates a new quote with no items or customer info.
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 |
Response Parameters
Parameter |
Type |
Description |
success |
Boolean |
Boolean value indicating if the api request was successful |
id |
Number |
The id number of the new quote that has been generated |
cust_id |
Number |
Customer ID |
order_id |
Number |
Order ID associated with the new quote |
code |
String |
New 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 |
New quote comments |
status |
Number |
New quote status |
created |
Number |
Unix timestamp for new quote creation date |
total |
Number |
Total |
formatted_total |
String |
Formatted total |
terms |
String |
Terms |
expires |
Number |
Unix timestamp for new quote expiration date |
Example Request
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "Module",
"Module_Code": "quote",
"Module_Function": "Quote_Create_Empty"
}
Example Response
{
"success": 1,
"data": {
"id": 1015,
"cust_id": 0,
"order_id": 0,
"code": "PV7T-K404-U8G0-CGU8",
"email": "",
"fname": "",
"lname": "",
"phone": "",
"zip": "",
"country": "",
"comment": "",
"status": 0,
"created": 1623433232,
"total": 0.0,
"formatted_total": "$0.00",
"terms": "",
"expires": 0
}
}