Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

OrderWorkflow /GetWorkflow

Allows 150 calls per minute

Response: GetWorkflowResponse



Get workflow groups and jobs per location. This call will return all groups available to the user.
Group header only contains essential information for displaying the number of jobs to do, total number of orders in the group. Things like Conditions and Action lists are not returned as part of this call.
Jobs - only header of a job is returned, actual list of order ids will be empty in this call. You will need to use GetJob to get actual list of orders allocated to the job

Parameters

NameTypeDescription
requestGetWorkflowRequestGet workflow request

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/GetWorkflow

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={
  "LocationId": "50068c3d-f7a9-4d3b-9c00-1cd56fdd6a8e",
  "GroupId": 1
}

Response

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

{
  "WorkflowGroups": [
    {
      "GroupHeader": {
        "GroupId": 1,
        "LocationId": "4c523049-5caf-4492-aa63-11d5eae75aa2",
        "Name": "sample string 3",
        "Prefix": "sam",
        "Seed": 5,
        "MaxOrderCount": 6,
        "Prevalence": 7,
        "JobCount": 8,
        "OrderCount": 9,
        "AttachmentCount": 10,
        "Condition": {
          "Where": "sample string 1",
          "Inner": "sample string 2",
          "Sort": "sample string 3"
        },
        "Action": {
          "Actions": [
            "sample string 1"
          ]
        },
        "HasAction": true
      },
      "Jobs": [
        {
          "JobId": 1,
          "GroupId": 2,
          "Name": "sample string 3",
          "Status": "PENDING",
          "OrderCount": 4,
          "AttachmentCount": 5,
          "IsError": true,
          "IsAllPrinted": true,
          "CreatedDate": "2021-07-29T09:24:14.4237443Z",
          "ExecutedByUser": "sample string 9",
          "ExecutionDate": "2021-07-29T09:24:14.4237443Z",
          "JobAttachmentList": [
            {
              "AttachmentId": 1,
              "JobId": 2,
              "Type": 0,
              "URL": "sample string 3",
              "PrintedDate": "2021-07-29T09:24:14.4247441+01:00",
              "User": "sample string 4"
            }
          ],
          "OrderList": [
            {
              "OrderId": "9a35d3ff-46d1-448d-b9d7-10fd312244da",
              "nOrderId": 2,
              "CustomerName": "sample string 3",
              "EmailAddress": "sample string 4"
            }
          ]
        }
      ]
    }
  ]
}