Back

Search

Search

Methods

Inventory

Orders

OrderWorkflow /GetJobByName

Response: GetJobResponse



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

Parameters

NameTypeDescription
requestGetJobByNameRequestRequest class

HTTP Endpoint

Server /OrderWorkflow / GetJobByName

Permissions

GlobalPermissions.OrderBook.Workflow.ViewWorkflowNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/OrderWorkflow/GetJobByName HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

request={
  "JobName": "sample string 1",
  "LocationId": "e150f4a0-ada8-4a07-a8f1-20f3c66b9af0"
}

Response

This is an example response. Results may 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": "2018-10-03T11:12:35.7874165Z",
    "ExecutedByUser": "sample string 9",
    "ExecutionDate": "2018-10-03T11:12:35.7874165Z",
    "JobAttachmentList": [
      {
        "AttachmentId": 1,
        "JobId": 2,
        "Type": 0,
        "URL": "sample string 3",
        "PrintedDate": "2018-10-03T11:12:35.7874165+01:00",
        "User": "sample string 4"
      },
      {
        "AttachmentId": 1,
        "JobId": 2,
        "Type": 0,
        "URL": "sample string 3",
        "PrintedDate": "2018-10-03T11:12:35.7874165+01:00",
        "User": "sample string 4"
      }
    ],
    "OrderList": [
      {
        "OrderId": "6eb265d2-a407-4a85-a3df-3db616a01582",
        "nOrderId": 2,
        "CustomerName": "sample string 3",
        "EmailAddress": "sample string 4"
      },
      {
        "OrderId": "6eb265d2-a407-4a85-a3df-3db616a01582",
        "nOrderId": 2,
        "CustomerName": "sample string 3",
        "EmailAddress": "sample string 4"
      }
    ]
  },
  "JobErrors": [
    {
      "JobErrorId": 1,
      "Action": "sample string 2",
      "OrderId": "b4d87675-630c-47df-90e6-fbc181b0181b",
      "ErrorType": 3,
      "ErrorText": "sample string 4"
    },
    {
      "JobErrorId": 1,
      "Action": "sample string 2",
      "OrderId": "b4d87675-630c-47df-90e6-fbc181b0181b",
      "ErrorType": 3,
      "ErrorText": "sample string 4"
    }
  ]
}