24/7 Support: 800.608.6482

Get Started

Navigation


PrintQueueJobList_Load_Query

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

On Demand Columns

job_data returns base64 encoded data of ZPL label

Request Body Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many print jobs you want returned. If for example you are querying thousands of print jobs you'll want to set the count to limit how many you get back in a single request.
offset Type:
Offset
Title:
Number
Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0 whcih is no offset.
sort Type:
String
Title:
Sort
Field to sort results by. Avaiilable sorting fields listed above. Use - prefix for a decending sort.
Filter Type:
Object
Title:
Filter
Array of Object containing search filters. See usage here: List Load Query Overview
PrintQueue_Description Type:
String
Title:
Print Queue Description
Name of the Print Queue to Pull Jobs From

Response Parameters

total_count Type:
Number
Title:
Total Product Count
total_count is the total number of records that match your search criteria. Note: this is not always the total products returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
start_offset Type:
Number
Title:
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 Type:
Number
Title:
Job Id
Job Id
queue_id Type:
Number
Title:
Queue Id
Queue Id
store_id Type:
Number
Title:
Store Id
Store Id
user_id Type:
Number
Title:
User Id
Miva Admin User Id of the user whom created the print job
descrip Type:
String
Title:
Job Description
Job Description with the following format: Shipment: :
job_fmt Type:
String
Title:
Job Format
Possible Values: zpl
dt_created Type:
Date/Time
Title:
Date Job Created
Date/Time Print Job Was Created
job_data Type:
String
Title:
Job Data
Base64 Encoded ZPL print Data

Example Request

Example Response

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 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.