Order Lines

Attributes

id uuid
Unique identifier for the object.
number integer
The sequence number of the order line.
status string
Either queued, or processed. Queued is imported but not fully picked, and processed is fully picked.
hostIdentification string
A unique value at the order line level that can be carried through from ERP to PPG and back to ERP.
serialNumber string
lot string
progressType integer
materialId uuid
The material on the order line.
materialName string
The material name of the items.
quantity float
The quantity on the original order line.
quantityRequested float
The quantity that was requested when processed. Only shows if the order line was processed.
quantityConfirmed float
The quantity that was processed. Only shows if the order line has been processed.
quantityDeviated float
The quantity that was missing. Only shows if the order line has been processed.
expiryDate datetime
The Expiry date to be processed on the order line.
releaseDate datetime
The Release date to be processed on the order line.
productionDate datetime
The Production date to be processed on the order line.
costCenterName string
The cost center this order line was processed at.
status string
"queued" if the order has not yet been processed, otherwise "processed".
modifiedAt datetime
The date/time this order was last modified. This will either be the creation date if it is still queued, or the processed date.
Info1 string
A generic field for custom use.
Info2 string
A generic field for custom use.
Info3 string
A generic field for custom use.
Info4 string
A generic field for custom use.
Info5 string
A generic field for custom use.

Endpoints

List Order Lines

get /api/order_lines

Arguments

limit integer
A limit on the number of objects to be returned. Limit can range between 1 and 1000, and the default is 25.
offset integer
Will return items, but only those after the integer amount.
modifiedAt datetime
Return orders modified on a certain date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.
countOnly boolean
When true, will only return a count of the amount of items in the query.
materialName string
Filter order lines only by a certain material.
status boolean
Only return order with a certain status, either queued, or processed.
type integer
Specify whether you want Pick or Put order lines.
quantity integer
Filter by a certain quantity.
costCenterName string
[DynamicField]
Any dynamic fields that have been set up can be used as a filter.

Request with curl

curl "http://[Your IP] /api/order_lines" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response

{
    "order_lines": [
        {
            "number": 5,
            "serialNumber": "65",
            "quantity": 1.0,
            "Info5": null,
            "id": "4A0C741B-5E79-4713-BB4B-4F10E9C23B1C",
            "modifiedDate": "2021-11-15T15:49:20.440000",
            "releaseDate": null,
            "Info3": null,
            "lot": null,
            "putLocation": null,
            "quantityRequested": 0.0,
            "status": "queued",
            "orderId": "85A55CF6-BE05-48AF-B0D7-D71212C3ACCA",
            "hasStock": 1,
            "expiryDate": null,
            "directionType": 1,
            "putDate": null,
            "materialName": "S103",
            "progressType": 2,
            "costCenterName": null,
            "Info1": "TEST",
            "putHeight": null,
            "productionDate": null,
            "Info2": null,
            "ORDELINEISSUETO": null,
            "storageUnits": [
                {
                    "id": "CA1E5648-FA38-416F-9604-CF33A6763496",
                    "name": "VLM-01"
                }
            ],
            "quantityDeviated": 1.0,
            "quantityConfirmed": 0.0,
            "incompleteAllocations": 0,
            "materialId": "8E7EC42A-F2B2-4B64-BF71-750F006DEF8D",
            "qualification": null,
            "ORDERLINEINFO6": null,
            "ORDERLINENOTE": null,
            "Info4": null,
            "hostIdentification": null,
            "owner": "sys",
            "putBinName": null,
            "pickBinName": null,
            "pickLocation": null
        }
    ]
}

Create Order Line

post /api/order_lines

Create an order line, to be imported by PowerPick. Requires passing the ID of the order the new line is being added to.

Body Parameters

orderId uuid REQUIRED
The ID of the order this order line belongs to.
number integer
The sequence number of the order line. Will be automatically generated if not provided.
materialId uuid REQUIRED
The unique ID of the material on the order line.
quantity integer REQUIRED
The quantity to be processed on the order line.
hostIdentification string
A unique value at the order line level that can be carried through from ERP to PPG and back to ERP.
batchName string
The Lot or Batch number of the material on the order line.
qualification string
A specified attribute of the material on the order line.
serialNumber string
The unique serial number at the unit level of the material on the order line.
expiryDate datetime
The Expiry date to be processed on the order line.
releaseDate datetime
The Release date to be processed on the order line.
productionDate datetime
The Production date to be processed on the order line.
info1 string
info2 string
info3 string
info4 string
info5 string
[DynamicField]
Any field set up in PowerPick.

Request with curl

curl "http://[Your IP] /api/order_lines" \ -X post \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" \

-d '{
    "orderId": "8D768C21-F0DB-49A2-B048-B75BDA00897C",
    "materialId": "C6607DB2-CE96-4888-82A5-71E36EBF2785",
    "quantity": 1
}'

Example Response

{
    "order_line": {
        "expiryDate": null,
        "lot": null,
        "directionType": 1,
        "putBinName": null,
        "putLocation": null,
        "storageUnits": [],
        "putDate": null,
        "hasStock": 1,
        "quantity": 1.0,
        "serialNumber": null,
        "number": 5,
        "status": "queued",
        "owner": "sys",
        "quantityConfirmed": 0.0,
        "costCenterName": null,
        "orderId": "8D768C21-F0DB-49A2-B048-B75BDA00897C",
        "progressType": 1,
        "putHeight": null,
        "materialName": "SampleMaterial",
        "qualification": null,
        "pickBinName": null,
        "Info3": null,
        "releaseDate": null,
        "Info2": null,
        "materialId": "C6607DB2-CE96-4888-82A5-71E36EBF2785",
        "incompleteAllocations": 0,
        "pickLocation": null,
        "productionDate": null,
        "Info4": null,
        "modifiedDate": "2022-01-28T23:05:06.500000",
        "id": "EFB5158B-1ECB-4B5B-8EA9-1AF1236D0FC2",
        "quantityRequested": 0.0,
        "Info1": null,
        "quantityDeviated": 1.0,
        "Info5": null,
        "hostIdentification": null
    }
}

Show Order Line

get /api/order_lines/[id]

Get a specific order line from the PPG database and return a JSON response. The order will be pulled from the MasterOrderLine table.

Arguments

Request with curl

curl -L 
-X GET '[Your IP]/api/order_lines/4A0C741B-5E79-4713-BB4B-4F10E9C23B1C' 
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer [Your JWT Access Token]'

Example Response

{
    "order_line": {
        "number": 5,
        "serialNumber": "65",
        "quantity": 1.0,
        "Info5": null,
        "id": "4A0C741B-5E79-4713-BB4B-4F10E9C23B1C",
        "modifiedDate": "2021-11-15T15:49:20.440000",
        "releaseDate": null,
        "Info3": null,
        "lot": null,
        "putLocation": null,
        "quantityRequested": 0.0,
        "status": "queued",
        "orderId": "85A55CF6-BE05-48AF-B0D7-D71212C3ACCA",
        "hasStock": 1,
        "expiryDate": null,
        "directionType": 1,
        "putDate": null,
        "materialName": "S103",
        "progressType": 2,
        "costCenterName": null,
        "Info1": "TEST",
        "putHeight": null,
        "productionDate": null,
        "Info2": null,
        "ORDELINEISSUETO": null,
        "storageUnits": [
            {
                "id": "CA1E5648-FA38-416F-9604-CF33A6763496",
                "name": "VLM-01"
            }
        ],
        "quantityDeviated": 1.0,
        "quantityConfirmed": 0.0,
        "incompleteAllocations": 0,
        "materialId": "8E7EC42A-F2B2-4B64-BF71-750F006DEF8D",
        "qualification": null,
        "ORDERLINEINFO6": null,
        "ORDERLINENOTE": null,
        "Info4": null,
        "hostIdentification": null,
        "owner": "sys",
        "putBinName": null,
        "pickBinName": null,
        "pickLocation": null
    }
}

Delete Order Line

get /api/order_lines/[id]/delete

Delete an order line.

Arguments

Request with curl

curl -L 
-X DELETE '[Your IP]/api/order_lines/4A0C741B-5E79-4713-BB4B-4F10E9C23B1C/delete' 
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer [Your JWT Access Token]'

Example Response

{"deleted": "true"}