Skip to content

`QuoteList_Load_Query`#

Description#

This function loads a list of quotes.

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 `QuoteList_Load_Query`
`count`	Number	Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
`filter`	String	A string for filtering returned data
`offset`	Number	Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
`sort`	String	The order for sorting returned data

Response Parameters#

Parameter	Type	Description
`success`	Boolean	Boolean value indicating if the API request was successful
`total_count`	Number	Total number of quotes returned
`start_offset`	Number	Starting offset value for pagination of the response data
`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 quote creation date
`total`	Number	Total
`formatted_total`	String	Currency Formatted Total
`terms`	String	Terms
`expires`	Number	Unix timestamp for quote expiration date

Example Request#

{
    "Store_code": "beta",
    "Function": "Module",
    "Module_Code": "quote",
    "Module_Function": "QuoteList_Load_Query",
    "Filter": [
        {
            "name": "search",
            "value": [
                {
                    "field": "created",
                    "operator": "GE",
                    "value": 1613030400
                }
            ]
        }
    ],
    "Sort": "-",
    "Offset": 0,
    "Count": 39
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 4,
        "start_offset": 0,
        "data": [
            {
                "id": 1000,
                "cust_id": 0,
                "order_id": 0,
                "code": "82EF-X8UU-08CC-04C0",
                "email": "",
                "fname": "",
                "lname": "",
                "phone": "",
                "zip": "",
                "country": "",
                "comment": "",
                "status": 0,
                "created": 1619998719,
                "total": 1272.45,
                "formatted_total": "$1,272.45",
                "terms": "",
                "expires": 0
            },
            {
                "id": 1001,
                "cust_id": 0,
                "order_id": 0,
                "code": "5WAP-TQ4C-LCG0-4QU4",
                "email": "UlantsStim@email.com",
                "fname": "Stim",
                "lname": "Ulants",
                "phone": "800-789-4561",
                "zip": "10022",
                "country": "US",
                "comment": "I need my speed",
                "status": 0,
                "created": 1620008372,
                "total": 2594.75,
                "formatted_total": "$2,594.75",
                "terms": "",
                "expires": 1620851709
            },
            {
                "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": 0,
                "created": 1620008437,
                "total": 149.7,
                "formatted_total": "$149.70",
                "terms": "",
                "expires": 0
            },
            {
                "id": 1003,
                "cust_id": 0,
                "order_id": 0,
                "code": "X62K-B8CC-U8Q4-G8L8",
                "email": "donjuan@email.com",
                "fname": "Don",
                "lname": "Juan",
                "phone": "800-123-4567",
                "zip": "10028",
                "country": "US",
                "comment": "don't burn the beans",
                "status": 0,
                "created": 1620074398,
                "total": 1272.45,
                "formatted_total": "$1,272.45",
                "terms": "",
                "expires": 0
            }
        ]
    }
}

Error Responses#

Error Code	Error Message	Error Description
MER-UTL-QUOTES-00343	Quote not found	Quote not found