Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

PrintService /CreatePDFfromJobForceTemplateWithQuantities

Allows 150 calls per minute

Response: CreatePDFResult



Creates a PDF file with Stock Item labels from a print job request

Parameters

NameTypeDescription
templateTypeStringThe template type
IDsAndQuantitiesList<KeyValuePair>Stock Id and quantity of stock
templateIDNullable<Int32>The ID of the template to use
parametersList<KeyValuePair>
printerNameStringPrinter name of the virtual 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

Example Request

The following request format is required for this method.

Get

Endpoint URL

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

GET https://eu-ext.linnworks.net/api/PrintService/CreatePDFfromJobForceTemplateWithQuantities?templateType=sample%20string%201&IDsAndQuantities=%5B%0D%0A%20%20%7B%0D%0A%20%20%20%20%22Key%22%3A%20%224c637768-b749-40ef-90ad-59f303d5d91f%22%2C%0D%0A%20%20%20%20%22Value%22%3A%202%0D%0A%20%20%7D%0D%0A%5D&templateID=1¶meters=%5B%0D%0A%20%20%7B%0D%0A%20%20%20%20%22Key%22%3A%20%22sample%20string%201%22%2C%0D%0A%20%20%20%20%22Value%22%3A%20%22sample%20string%202%22%0D%0A%20%20%7D%0D%0A%5D&printerName=sample%20string%201&printZoneCode=sample%20string%201

Headers

Connection: keep-alive
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Post

Endpoint URL

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

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&IDsAndQuantities=[
  {
    "Key": "4c637768-b749-40ef-90ad-59f303d5d91f",
    "Value": 2
  }
]&templateID=1¶meters=[
  {
    "Key": "sample string 1",
    "Value": "sample string 2"
  }
]&printerName=sample string 1&printZoneCode=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": "db9f0138-bdb5-4e98-9532-81b3e9b3cc4c",
      "Error": "sample string 3",
      "Tags": [
        {
          "Tag": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "URL": "sample string 1",
  "IdsProcessed": [
    "85daa085-5e23-4782-ad3e-7b72849e5a7b"
  ],
  "ProcessedIds": {
    "sample string 1": [
      "9fe87dae-b291-4ca1-8cbd-f82705e38e80"
    ]
  },
  "PageCount": 2,
  "PrintErrors": [
    "sample string 1"
  ]
}