1. Resource Central
  2. arrow-right
  3. Work Order Lines

Work Order Lines

A Work Order Line is a segmented amount of materials that need to be picked from a specific location for a specific order.

Attributes

  • name string LIMIT: 50

    Name or number of the work order line.

  • id uuid

    Unique identifier of the work order line.

  • attributeControl

  • batchId uuid

    ID of the batch.

  • directionType integer/string

    The type of order.

    Possible values:

    1 or "put"
    2 or "pick"
    3 or "return"
    4 or "transport"
    5 or "count"
    7 or "production"

  • handlingRank integer

    Rank of the handling unit.

  • handlingUnit string

    The transport tote/container/cart used when processing the order or batch.

  • locationContentBreakdownId uuid

    ID of the location content breakdown.

  • locationContentId uuid

    ID of the location content.

  • locationId uuid

    ID of the location.

  • locationName string

    Name of the location.

  • materialId uuid

    ID of the material.

  • orderId uuid

    ID of the order.

  • orderLineId uuid

    ID of the order line.

  • orderName string

    Name of the order.

  • pickError

    Error on pick.

  • progressType integer

    Status of the individual line.

  • putError

    Error on put.

  • quantity float

    Quantity of materials for the work order line.

  • storageUnitId uuid

    ID of the storage unit.

  • zoneId uuid

    ID of the zone.

Endpoints

List Work Order Lines /api/work_order_lines
get

Get a list of work order lines from the PPG database. View the guide on adding filters to List API calls.

Body Parameters

  • batchId uuid

    ID of the batch.

  • directionType integer/string

    The type of order. Can use integer or string.

    Possible values:

    1 or "put"
    2 or "pick"
    3 or "return"
    4 or "transport"
    5 or "count"
    7 or "production"

  • handlingUnit string

    The transport tote/container/cart used when processing the order or batch.

  • locationContentId uuid

    ID of the location content.

  • locationId uuid

    ID of the location.

  • locationName uuid

    Name of the location.

  • name string

    Name or number of the work order line.

  • orderLineId uuid

    ID of the order line.

  • progressType integer

    Status of the individual line.

    Possible values:

    0 = Complete
    1 = Not Started
    2 = In Progress

  • quantity float

    Quantity of materials for the work order line.

  • countOnly boolean

    When "true", will only return a count of the amount of items in the query.

    Default value:

    false

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 1000.

    Default value:

    250

  • page integer

    Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.

  • orderBy string, array

    Order the response by the selected field. Multiple values can be passed, separated by a comma.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/work_order_lines" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{ "work_order_lines": [{ "name": " string ", "id": " uuid ", "attributeControl": " ", "batchId": " uuid ", "directionType": " integer/string ", "handlingRank": " integer ", "handlingUnit": " string ", "locationContentBreakdownId": " uuid ", "locationContentId": " uuid ", "locationId": " uuid ", "locationName": " string ", "materialId": " uuid ", "orderId": " uuid ", "orderLineId": " uuid ", "orderName": " string ", "pickError": " ", "progressType": " integer ", "putError": " ", "quantity": " float ", "storageUnitId": " uuid ", "zoneId": " uuid ", }] }] }
Show Work Order Line /api/work_order_line/[id]
get

Get a single work order line from the PPG database and return a JSON response.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/work_order_line/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{ "work_order_lines": [{ "name": " string ", "id": " uuid ", "attributeControl": " ", "batchId": " uuid ", "directionType": " integer/string ", "handlingRank": " integer ", "handlingUnit": " string ", "locationContentBreakdownId": " uuid ", "locationContentId": " uuid ", "locationId": " uuid ", "locationName": " string ", "materialId": " uuid ", "orderId": " uuid ", "orderLineId": " uuid ", "orderName": " string ", "pickError": " ", "progressType": " integer ", "putError": " ", "quantity": " float ", "storageUnitId": " uuid ", "zoneId": " uuid ", }] }] }