Creates a PDF file from a print job request
Name | Type | Description |
---|---|---|
templateType | String | The template type |
IDs | List<Guid> | A list of IDs to print (e.g. Order IDs or Warehouse Transfer IDs) |
templateID | Nullable<Int32> | The ID of the template to use |
parameters | List<KeyValuePair> | |
printerName | String | printer name of the ivrtual printer to use. If null then the sepecified in the template |
printZoneCode | String | Print zone code, if present, will override the printer used if the template has a set printer for that zone |
pageStartNumber | Int32 | First page number. Used for splitting prints into multiple requests. |
operationId | Nullable<Guid> | |
context | ClientContext |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/PrintService/CreatePDFfromJobForceTemplate
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
This is an example of the request structure. Results will vary depending on your data.
templateType=sample string 1&IDs=[
"9776bfb2-00de-4bcb-96b2-933b8035d043"
]&templateID=1¶meters=[
{
"Key": "sample string 1",
"Value": "sample string 2"
}
]&printerName=sample string 1&printZoneCode=sample string 1&pageStartNumber=1&operationId=87f0bbf0-6ea0-4c0b-a264-4e37aaf37d83&context={
"Module": "sample string 1"
}
This is an example of the response JSON. Results will vary depending on your data.
{
"KeyedError": [
{
"TemplateType": "sample string 1",
"Id": "c28ab7cf-c543-49b2-af44-6d5af3e3faa8",
"Error": "sample string 3",
"Tags": [
{
"Tag": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"URL": "sample string 1",
"IdsProcessed": [
"b72cb0e6-d1e6-409d-b039-4e183f5ad4dd"
],
"ProcessedIds": {
"sample string 1": [
"8a4a6be4-4eb0-4867-b377-c2517bbf2bdf"
]
},
"PageCount": 2,
"PrintErrors": [
"sample string 1"
]
}