Skip to content

`PrintQueueJob_Insert`#

Description#

This function allows you to insert a print job into a print queue (which MivaPrint Q will then print). Only one of the following request fields are required: PrintQueue_ID, Edit_PrintQueue, PrintQueue_Description.

Request Body Parameters#

Parameter	Type	Description
`PrintQueue_Description` `PrintQueue_ID` `Edit_PrintQueue`	String Number String	The Name of the Print Queue to insert the job into. ID of Print Queue to insert the job into. Same Value as PrintQueue_Description
`PrintQueueJob_Description`	String	Example: Label For Shipment 12345
`PrintQueueJob_Format`	String	Available Options: zpl (additional print format options may be added in the future)
`PrintQueueJob_Data`	String	Base64 encoded string for the ZPL label to print

Response Parameters#

Parameter	Type	Description
`success`	boolean	Boolean value for if the request was successful
`id`		ID of the successfully created print job

Example Request#

{
    "Function": "PrintQueueJob_Insert",
    "PrintQueue_Description": "Warehouse1",
    "PrintQueueJob_Description": "Label For Shipment 12345",
    "PrintQueueJob_Format": "zpl",
    "PrintQueueJob_Data": "..."
}

Example Response#

{
    "success": 1,
    "data": {
        "id": 3
    }
}