The print endpoint allows user to print multiple copies of a label using template or raw data. In this section we will discuss the template version. The endpoint path is

/print/{printerQueueName}

To print using this endpoint, there are some parts of a request that have to be provided:

1. printerQueueName path parameter – print queue name to tell the program which printer you want to print to. Our example: pq_testPrinter
2. request body – a JSON request body containing the necessary template-print information. Request body schema for the template print version looks like this:

{
  "template": {
    "name": "string",
    "options": [
      {
        "numberOfCopies": 0,
        "placeholderValues": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      }
    ]
  }
}

As you can see, the JSON body is a bit more complicated in this version than in simple-print, but you will easily understand everything by looking at the example supplemented with our sample data.

• query parameter templateName has been included here in the JSON body as a field of the template object and has the short name name. In our case, it will take the value of testTemplate
• there is a new parameter called numberOfCopies which simply indicates how many copies of the label you want to print
• in placeholderValues object you can specify the names and values of template’s placeholders. In our case, the namePlaceholder and descriptionPlaceholder will be included

The final version of print endpoint request looks like this:

URL

http://localhost:5987/print/pq_testPrinter

JSON

{
  "template": {
    "name": "testTemplate",
    "options": [
      {
        "numberOfCopies": 1,
        "placeholderValues": {
          "namePlaceholder": "The Name",
          "descriptionPlaceholder": "The Description"
        }
      }
    ]
  }
}