Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

OrderWorkflow /GetJobByName

Allows 150 calls per minute

Response: GetJobResponse



Get specific job details. This method will return list of order ids in a job.

Parameters

NameTypeDescription
requestGetJobByNameRequestRequest class

Permissions

GlobalPermissions.OrderBook.Workflow.ViewWorkflowNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/OrderWorkflow/GetJobByName

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.

request={
  "JobName": "sample string 1",
  "LocationId": "322f7d14-213c-4ce0-b1b5-53c70ed4ce8e"
}

Response

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

{
  "Job": {
    "JobId": 1,
    "GroupId": 2,
    "Name": "sample string 3",
    "Status": "PENDING",
    "OrderCount": 4,
    "AttachmentCount": 5,
    "IsError": true,
    "IsAllPrinted": true,
    "CreatedDate": "2021-07-29T09:24:14.4467531Z",
    "ExecutedByUser": "sample string 9",
    "ExecutionDate": "2021-07-29T09:24:14.4467531Z",
    "JobAttachmentList": [
      {
        "AttachmentId": 1,
        "JobId": 2,
        "Type": 0,
        "URL": "sample string 3",
        "PrintedDate": "2021-07-29T09:24:14.4467531+01:00",
        "User": "sample string 4"
      }
    ],
    "OrderList": [
      {
        "OrderId": "5e6f9f17-f79d-4840-a32a-16d443ac380d",
        "nOrderId": 2,
        "CustomerName": "sample string 3",
        "EmailAddress": "sample string 4"
      }
    ]
  },
  "JobErrors": [
    {
      "JobErrorId": 1,
      "Action": "sample string 2",
      "OrderId": "2b056339-7d51-4980-8fd7-318b7eba1633",
      "ErrorType": 3,
      "ErrorText": "sample string 4"
    }
  ]
}