Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
PrintService

CreatePDFfromJobForceTemplate

Creates a PDF file from a print job request <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>250</b></span> / minute

post/api/PrintService/CreatePDFfromJobForceTemplate

Request body

templateTypestring

The template type

IDsstring[]

A list of IDs to print (e.g. Order IDs or Warehouse Transfer IDs)

templateIDinteger

The ID of the template to use

printerNamestring

printer name of the ivrtual printer to use. If null then the sepecified in the template

printZoneCodestring

Print zone code, if present, will override the printer used if the template has a set printer for that zone

pageStartNumberinteger

First page number. Used for splitting prints into multiple requests (optional, default to 0)

operationIdstring uuid

The ID of the current operation, used in logging for tracing (optional, default to null)

Example request

{
  "IDs": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "operationId": "00000000-0000-0000-0000-000000000000"
}

Response

OK

URLstring

URL to PDF file

IdsProcessedstring[]

List of processed order or item IDs

ProcessedIdsobject
PageCountinteger
PrintErrorsstring[]

List of OrderId / Error message

Example response

{
  "KeyedError": [
    {
      "Id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "IdsProcessed": [
    "00000000-0000-0000-0000-000000000000"
  ]
}