Print client

Create a print job

Creates a print job.

Print jobs are sent to the print client on the specified host to print documents.

Shipmondo Print Client installation and setup guide

post/print_jobs

Request

Base URL
https://sandbox.shipmondo.com/api/public/v3
URL
https://sandbox.shipmondo.com/api/public/v3/print_jobs
Auth
HTTP basic

Request body

document_idinteger required

Identifier for the provided document_type.

document_type'shipment' | 'sales_order' | 'fulfillment' | 'proforma' | 'waybill' required

Type of document that should be printed.

host_namestring required

The name of the computer/host to print at.

printer_namestring required

The name of the printer that should be printed on.

label_format'a4_pdf' | '10x19_pdf' | '10x19_zpl' | 'compact_pdf' | 'compact_zpl' required

The given format of the print job. Label_formats: compact_pdf and compact_zpl, is only compatible with document_type: shipment. Customs documents (document_type: proforma) are always rendered in A4, so label_format is ignored for them.

Example request

{
  "document_id": 11460,
  "document_type": "shipment",
  "host_name": "WAREHOUSE-PC-01",
  "printer_name": "GK420D",
  "label_format": "10x19_zpl"
}

Response

Successful.

successboolean

Identicates if the creation of print job was successful or not

Changes

No recorded changes to this operation across all 17 revisions of this API.