Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

PrintService /CreatePDFfromJobForceTemplate

Allows 250 calls per minute

Response: CreatePDFResult



Creates a PDF file from a print job request

Parameters

NameTypeDescription
templateTypeStringThe template type
IDsList<Guid>A list of IDs to print (e.g. Order IDs or Warehouse Transfer IDs)
templateIDNullable<Int32>The ID of the template to use
parametersList<KeyValuePair>
printerNameStringprinter name of the ivrtual printer to use. If null then the sepecified in the template
printZoneCodeStringPrint zone code, if present, will override the printer used if the template has a set printer for that zone
pageStartNumberInt32First page number. Used for splitting prints into multiple requests.
operationIdNullable<Guid>
contextClientContext

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/PrintService/CreatePDFfromJobForceTemplate

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

templateType=sample string 1&IDs=[
  "6f313ad1-17d2-4364-97ef-0214ec89efb0"
]&templateID=1¶meters=[
  {
    "Key": "sample string 1",
    "Value": "sample string 2"
  }
]&printerName=sample string 1&printZoneCode=sample string 1&pageStartNumber=1&operationId=c30ca4c7-f2f9-4eca-a57c-8efbdf345fc4&context={
  "Module": "sample string 1"
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "KeyedError": [
    {
      "TemplateType": "sample string 1",
      "Id": "217922dd-9984-4e6e-ab30-465e728ec3fd",
      "Error": "sample string 3",
      "Tags": [
        {
          "Tag": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "URL": "sample string 1",
  "IdsProcessed": [
    "b4fa82a7-fd9b-4945-b278-f2ca5cc06dc8"
  ],
  "ProcessedIds": {
    "sample string 1": [
      "64b9c71f-3012-4b32-a1c0-a171ebe57cd1"
    ]
  },
  "PageCount": 2,
  "PrintErrors": [
    "sample string 1"
  ]
}