Production Items

Add attachment to line items

post

The API gives the ability to add attachment to line item.

Allowed content-types:

image/png
model/obj
application/pdf
image/webp
image/jpeg
text/plain
application/vnd.hp-HPGL
application/vnd.ms-excel
application/msword
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document

Authorizations

x-api-keystringRequired

Path parameters

external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e

line_item_idstringRequired

The unique identifier of the production item

Example: 557657-8654-89i76

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body

file_namestringOptional

File name

Example: technical_drawing.pdf

urlstringRequired

URL of the file

Example: https://cdn.example.com/files/technical_drawing.pdf

is_primarybooleanOptional

Marks image as primary line item image

Example: false

Responses

201Success

application/json

messagestringRequired

Message returned from API confirming the operation

Example: The operation was done successfully

429

Returned when the rate limit is exceeded

post/api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/attachments

POST /api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/attachments HTTP/1.1
Host: api-stage.hesh.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "file_name": "technical_drawing.pdf",
  "url": "https://cdn.example.com/files/technical_drawing.pdf",
  "is_primary": false
}

{
  "message": "The operation was done successfully"
}

Get current execution state for a line item

get

Returns a list of active workflow cursors (tasks in progress, reopened, or ready to pick up) for a specific Line Item across all linked workflows.

Authorizations

x-api-keystringRequired

Path parameters

external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e

line_item_idstringRequired

The unique identifier of the production item

Example: 557657-8654-89i76

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Responses

200Success

application/json

429

Returned when the rate limit is exceeded

get/api/v1/public/orders/state/{external_order_id}/line-items/{line_item_id}

GET /api/v1/public/orders/state/{external_order_id}/line-items/{line_item_id} HTTP/1.1
Host: api-stage.hesh.tech
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "current": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "production_workflow_id": "123e4567-e89b-12d3-a456-426614174000",
      "task": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "task_key": "text",
        "status": "Reopened",
        "is_in_queue": true,
        "is_reopened": true,
        "reopened_task_key": "text"
      },
      "nestedWorkflow": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "To_Do",
        "production_key": "text"
      }
    },
    "previous": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "production_workflow_id": "123e4567-e89b-12d3-a456-426614174000",
        "task": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "task_key": "text",
          "status": "Reopened",
          "is_in_queue": true,
          "is_reopened": true,
          "reopened_task_key": "text"
        },
        "nestedWorkflow": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "To_Do",
          "production_key": "text"
        }
      }
    ],
    "next": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "production_workflow_id": "123e4567-e89b-12d3-a456-426614174000",
        "task": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "task_key": "text",
          "status": "Reopened",
          "is_in_queue": true,
          "is_reopened": true,
          "reopened_task_key": "text"
        },
        "nestedWorkflow": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "To_Do",
          "production_key": "text"
        }
      }
    ]
  }
]

Get current execution state for a specific workflow

get

Returns a list of active cursors for a single specific workflow by its ID.

Authorizations

x-api-keystringRequired

Path parameters

workflow_idstringRequired

Internal unique identifier of the Production Workflow

Example: 859ab706-979e-4645-8b8e-b3ec3fd89858

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Responses

200Success

application/json

429

Returned when the rate limit is exceeded

get/api/v1/public/orders/state/{workflow_id}

GET /api/v1/public/orders/state/{workflow_id} HTTP/1.1
Host: api-stage.hesh.tech
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "current": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "production_workflow_id": "123e4567-e89b-12d3-a456-426614174000",
      "task": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "task_key": "text",
        "status": "Reopened",
        "is_in_queue": true,
        "is_reopened": true,
        "reopened_task_key": "text"
      },
      "nestedWorkflow": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "To_Do",
        "production_key": "text"
      }
    },
    "previous": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "production_workflow_id": "123e4567-e89b-12d3-a456-426614174000",
        "task": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "task_key": "text",
          "status": "Reopened",
          "is_in_queue": true,
          "is_reopened": true,
          "reopened_task_key": "text"
        },
        "nestedWorkflow": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "To_Do",
          "production_key": "text"
        }
      }
    ],
    "next": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "production_workflow_id": "123e4567-e89b-12d3-a456-426614174000",
        "task": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "task_key": "text",
          "status": "Reopened",
          "is_in_queue": true,
          "is_reopened": true,
          "reopened_task_key": "text"
        },
        "nestedWorkflow": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "To_Do",
          "production_key": "text"
        }
      }
    ]
  }
]

PreviousProduction Item Tags NextProducts

Last updated 24 days ago