/print

Print is how you manage print client applications, printers and print jobs on your nShift Delivery account.

Note

The REST API endpoints are only accessible via HTTPS and are located at api.unifaun.com.

https://api.unifaun.com/rs-extapi/v1

Before getting started you need to know your developer ID and create an API key.

Fetch print clients

GET/print/clients

Fetches a list of all Print client applications. Returns only partial list using pagination parameters page and size, which provides a way to narrow down the Print client selection.

Query parameters

Parameter	Type	Description	Category
page	number	Specifies which page to fetch. A page contains up to 50 items, if "size" is not provided. Pagination starts at zero (0).	Required
size	number	Number of items per page. Default: 50 items per page	Optional

Fetch a print client

GET /print/clients/{clientId}

Fetches a specific Print client application, identified by client ID.

URI parameters

Parameter	Type	Description	Category
clientId	string	Identifies a print client.	Required

{
  "id": 12,
  "name": "AnalyticalEngine",
  "inet": null,
  "inet6": null,
  "hostname": null,
  "version": null,
  "jre": null,
  "createTimestamp": "2015-11-16T23:14:12.354Z",
  "state": "disconnected"
}

Fetch printers for a print client

GET /print/clients/{clientId}/printers

Fetches a list of all printers that are connected to a specific Print client application, identified by client ID. Returns only partial list using pagination parameters page and size.

URI parameters

Parameter	Type	Description	Category
clientId	string	Identifies a print client.	Required

Query parameters

Parameter	Type	Description	Category
medias	string	Fetches printers that support a specific media type. Valid values: "laser-1a5" - Laser (1 x A5, 210 x 297 mm) "laser-2a5" - Laser (2 x A5, 210 x 297 mm) "laser-2x104x190top" - Laser (2 x 107 x 190 mm, at the top) "laser-2x104x250" - Laser (2 x STE, 210 x 297 mm) "laser-2x104x250rot" - Laser (2 x STE, 210 x 297 mm, 180°) "laser-2x110x190" - Laser (2 x 110 x 190 mm) "laser-2x210x104" - Laser (2 x 210 x 104 mm) "laser-3part" - Laser (3 parts, 210 x 297 mm) "laser-a4" - Standard A4 (210 x 297 mm) "laser-a5" - Laser (A5, 148 x 210 mm) "laser-c5" - Laser (C5, 148 x 210 mm) "laser-ste" - Two STE labels (107x251 mm) on A4 paper "thermo-105" - Thermal (99 x 105 mm) "thermo-148" - Thermal (105 x 148 mm) "thermo-165" - Thermal (107 x 165 mm) "thermo-190" - Thermal (107 x 190 mm) "thermo-225" - Thermal (107 x 225 mm) "thermo-250" - Thermal (107 x 250 mm) "thermo-285" - Thermal (104 x 285 mm) "thermo-55" - Thermal (107 x 55 mm) "thermo-72" - Thermal (107 x 72 mm) "thermo-brev3" = Thermal (107 x 72 mm) "thermo-se" = Thermal (107 x 251 mm)	Optional
page	number	Specifies which page to fetch. A page contains up to 50 items, if "size" is not provided. Pagination starts at zero (0).	Required
size	number	Number of items per page. Default: 50 items per page	Optional

[
  {
    "printerId": 71153066,
    "clientId": 419133,
    "name": "Test",
    "options": [
      {
        "key": "collate",
        "value": "true"
      },
      {
        "key": "color",
        "value": "true"
      },
      {
        "key": "copies",
        "value": "9999"
      },
      {
        "key": "duplex",
        "value": "true"
      },
      {
        "key": "supports_custom_paper_size",
        "value": "false"
      }
    ],
    "medias": [
      {
        "id": "laser-3part",
        "description": "Laser (3 parts, 210 x 297 mm)"
      },
      {
        "id": "laser-a4",
        "description": "Standard A4 (A4, 210 x 297 mm)"
      }
    ]
  },
  {
    "printerId": 71153550,
    "clientId": 419166,
    "name": "CUPS-BRF-Printer",
    "options": [
      {
        "key": "collate",
        "value": "true"
      },
      {
        "key": "color",
        "value": "true"
      },
      {
        "key": "copies",
        "value": "9999"
      },
      {
        "key": "duplex",
        "value": "true"
      },
      {
        "key": "supports_custom_paper_size",
        "value": "false"
      }
    ],
    "medias": [
      {
        "id": "laser-3part",
        "description": "Laser (3 parts, 210 x 297 mm)"
      },
      {
        "id": "laser-a4",
        "description": "Standard A4 (A4, 210 x 297 mm)"
      }
    ]
  }
]

Fetch printers

GET/print/printers

Fetches a list of all printers that are connected to any Print client application. Returns only partial list using pagination parameters page and size.

Query parameters

Parameter	Type	Description	Category
page	number	Specifies which page to fetch. A page contains up to 50 items, if "size" is not provided. Pagination starts at zero (0).	Required
size	number	Number of items per page. Default: 50 items per page	Optional

[
  {
    "printerId": 71153066,
    "clientId": 419133,
    "name": "Test",
    "options": [
      {
        "key": "collate",
        "value": "true"
      },
      {
        "key": "color",
        "value": "true"
      },
      {
        "key": "copies",
        "value": "9999"
      },
      {
        "key": "duplex",
        "value": "true"
      },
      {
        "key": "supports_custom_paper_size",
        "value": "false"
      }
    ],
    "medias": [
      {
        "id": "laser-3part",
        "description": "Laser (3 parts, 210 x 297 mm)"
      },
      {
        "id": "laser-a4",
        "description": "Standard A4 (A4, 210 x 297 mm)"
      }
    ]
  },
  {
    "printerId": 71153550,
    "clientId": 419166,
    "name": "CUPS-BRF-Printer",
    "options": [
      {
        "key": "collate",
        "value": "true"
      },
      {
        "key": "color",
        "value": "true"
      },
      {
        "key": "copies",
        "value": "9999"
      },
      {
        "key": "duplex",
        "value": "true"
      },
      {
        "key": "supports_custom_paper_size",
        "value": "false"
      }
    ],
    "medias": [
      {
        "id": "laser-3part",
        "description": "Laser (3 parts, 210 x 297 mm)"
      },
      {
        "id": "laser-a4",
        "description": "Standard A4 (A4, 210 x 297 mm)"
      }
    ]
  }
]

Fetch a printer

GET/print/printers/{printerId}

Fetches printer details for a printer, identified by printer ID, that is connected to a Print client.

URI parameters

Parameter	Type	Description	Category
printerId	string	Identifies the physical printer.	Required

[
  {
    "printerId": 71153066,
    "clientId": 419133,
    "name": "Test",
    "options": [
      {
        "key": "collate",
        "value": "true"
      },
      {
        "key": "color",
        "value": "true"
      },
      {
        "key": "copies",
        "value": "9999"
      },
      {
        "key": "duplex",
        "value": "true"
      },
      {
        "key": "supports_custom_paper_size",
        "value": "false"
      }
    ],
    "medias": [
      {
        "id": "laser-3part",
        "description": "Laser (3 parts, 210 x 297 mm)"
      },
      {
        "id": "laser-a4",
        "description": "Standard A4 (A4, 210 x 297 mm)"
      }
    ]
  },
  {
    "printerId": 71153550,
    "clientId": 419166,
    "name": "CUPS-BRF-Printer",
    "options": [
      {
        "key": "collate",
        "value": "true"
      },
      {
        "key": "color",
        "value": "true"
      },
      {
        "key": "copies",
        "value": "9999"
      },
      {
        "key": "duplex",
        "value": "true"
      },
      {
        "key": "supports_custom_paper_size",
        "value": "false"
      }
    ],
    "medias": [
      {
        "id": "laser-3part",
        "description": "Laser (3 parts, 210 x 297 mm)"
      },
      {
        "id": "laser-a4",
        "description": "Standard A4 (A4, 210 x 297 mm)"
      }
    ]
  }
]

Fetch print jobs

GET/print/printjobs

Fetches a list of all print jobs sent to any Print client, possibly filtered by date and/or status. Returns only partial list using pagination parameters page and size.

Query parameters

Parameter	Type	Description	Category
dateFrom	string	The lower limit of a date interval ISO-8601 date format, for example, 2020-01-01T01:00:00+00:00. Must be used together with dateTo.	Optional
dateTo	string	The upper limit of a date interval. ISO-8601 date format, for example, 2020-01-01T01:00:00+00:00. Must be used together with dateFrom.	Optional
page	number	Specifies which page to fetch. A page contains up to 50 items, if "size" is not provided. Pagination starts at zero (0).	Required
size	number	Number of items per page. Default: 50 items per page	Optional
status	string	Fetches print jobs with a specific status. Valid values: RECEIVED - Print job received by nShift Delivery. SENT - Print job sent to server. FAILED - Failed to print. PRINTED - Successfull printing. REGISTERED - Registered for physical printing. READY_FOR PRINTING - Sent to physical printer.	Optional

{
  "page": 0,
  "totalPages": 1,
  "printJobs": [
    {
      "id": 10,
      "status": "Info > Received",
      "type": "raw_uri",
      "created": "2022-12-02 11:51:38.963"
    },
    {
      "id": 11,
      "status": "Info > Received",
      "type": "raw_uri",
      "created": "2022-12-02 11:52:42.346"
    }
  ]
}

Fetch a print job

GET/print/printjobs/{printJobId}

Fetches a specific print job that has been sent to a Print client, using print job ID.

The response can contain the following print job statuses:

RECEIVED - Print job received by nShift Delivery.
SENT - Print job sent to server.
FAILED - Failed to print.
PRINTED - Successfull printing.
REGISTERED - Registered for physical printing.
READY_FOR PRINTING - Sent to physical printer.

URI parameters

Parameter	Type	Description	Category
printJobId	string	Identifies the print job.	Required

{
  "id": 40,
  "status": "PRINTED",
  "type": "application/octet-stream",
  "created": "Mon Mar 21 14:15:36 CET 2022"
}

Send a shipment print job to a printer

POST/print/shipments/{shipmentId}/prints/{printId}/printjobs

Sends print job for a shipment to any connected printer using shipment ID and print ID as identifiers. Returns the resulting print job.

Define printer ID and other print job settings in the request body.

Note

The endpoint works with formats PDF or RAW, where RAW is any other format generated as a printed document.

The property contentType must be one of the following: pdf_base64, pdf_uri, raw_base64, raw_uri and defaults to *_uri depending on the generated document format.

URI parameters

Parameter	Type	Description	Category
printId	string	Identifies the PDF or ZPL document.	Required
shipmentId	string	Identifies the shipment.	Required

{
  "name": "Printer name",
  "printerId": 1,
  "reference": "Reference",
  "contentType" : "pdf_base64",
  "options": [{
    "key": "tray",
    "value": "bin1"
  }]
}

{
  "id": 12345,
  "status": "PRINTED",
  "type": "application/octet-stream",
  "created": "Mon Mar 21 14:15:36 CET 2022",
  "href": "https://api.unifaun.com/ufoweb-prod-202306141018/rs-extapi/v1/printjob/12345"
}

Send a shipment list print job to a printer

POST/print/shipment-manifests/{manifestId}/prints/{printId}/printjobs

Sends a print job for a shipment list to any connected printer using manifest ID and print ID as identifiers. Returns the resulting print job.

Define printer ID and other print job settings in the request body.

Note

The endpoint works with formats PDF or RAW, where RAW is any other format generated as a printed document.

The property contentType must be one of the following: pdf_base64, pdf_uri, raw_base64, raw_uri and defaults to *_uri depending on the generated document format.

URI parameters

Parameter	Type	Description	Category
manifestId	string	Identifies the shipment list.	Required
printId	string	Identifies the PDF or ZPL document.	Required

{
  "name": "Printer name",
  "printerId": 1,
  "reference": "Reference",
  "contentType" : "pdf_base64",
  "options": [{
    "key": "tray",
    "value": "bin1"
  }]
}

{
  "id": 12345,
  "status": "PRINTED",
  "type": "application/octet-stream",
  "created": "Mon Mar 21 14:15:36 CET 2022",
  "href": "https://api.unifaun.com/ufoweb-prod-202310311219/rs-extapi/v1/printjob/12345"
}

Send a consolidated shipment print job to a printer

POST/print/consolidated-shipments/{consolidatedId}/prints/{printId}/printjobs

Sends a print job for a consolidated shipment to any connected printer using consolidated shipment ID and print ID as identifiers. Returns the resulting print job.

Define printer ID and other print job settings in the request body.

Note

The endpoint works with formats PDF or RAW, where RAW is any other format generated as a printed document.

The property contentType must be one of the following: pdf_base64, pdf_uri, raw_base64, raw_uri and defaults to *_uri depending on the generated document format.

URI parameters

Parameter	Type	Description	Category
consolidatedId	string	Identifies the consolidated shipment	Required
printId	string	Identifies the PDF or ZPL document.	Required

{
  "name": "Printer name",
  "printerId": 1,
  "reference": "Reference",
  "contentType" : "pdf_base64",
  "options": [{
    "key": "tray",
    "value": "bin1"
  }]
}

{
  "id": 12345,
  "status": "PRINTED",
  "type": "application/octet-stream",
  "created": "Mon Mar 21 14:15:36 CET 2022",
  "href": "https://api.unifaun.com/ufoweb-prod-202310311219/rs-extapi/v1/printjob/12345"
}

Tip

For schema and testing, please refer to https://api.unifaun.com/rs-docs/.

For description of properties, please refer to the Property reference guide.

In this section:

/print

Note

Fetch print clients

Query parameters

Fetch a print client

URI parameters

Fetch printers for a print client

URI parameters

Query parameters

Fetch printers

Query parameters

Fetch a printer

URI parameters

Fetch print jobs

Query parameters

Fetch a print job

URI parameters

Send a shipment print job to a printer

Note

URI parameters

Send a shipment list print job to a printer

Note

URI parameters

Send a consolidated shipment print job to a printer

Note

URI parameters

Tip

Search results