Skip to content



This function is used to load a list of pending jobs from a specific Print Queue.

On Demand Columns#

Name Description
job_data Returns base64 encoded data of ZPL label

Request Body Parameters#

Type Description
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
PrintQueue_Description String Name of the Print Queue to Pull Jobs From.

Response Parameters#

Type Description
total_count Number Total number of records that match your search criteria.
start_offset Number Number of the starting offset number of products to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id Number Job Id
queue_id Number Queue Id
store_id Number Store Id
user_id Number Miva Admin User Id of the user who created the print job
descrip String Job Description with the following format: Shipment: :
job_fmt String Possible Values: zpl
dt_created Date/Time Date/Time Print Job Was Created
job_data String Base64 Encoded ZPL print Data
user_name String User Name
store_code String Store Code
store_name String Store Name

Example Request#

    "Function": "PrintQueueJobList_Load_Query",
    "PrintQueue_Description": "Warehouse1",
    "Count": 0,
    "Offset": 0,
    "Filter": [
            "name": "ondemandcolumns",
            "value": ["job_data"]

Example Response#

    "success": 1,
    "data": {
        "total_count": 1,
        "start_offset": 0,
        "data": [
                "id": 1,
                "queue_id": 1,
                "store_id": 2,
                "user_id": 1,
                "descrip": "Shipment: 01034-20190306-00001: 1Z771W650195830661",
                "job_fmt": "zpl",
                "dt_created": 1551911256,
                "job_data": "...",
                "user_name": "Administrator",
                "Store_code": "beta",
                "store_name": "Test"