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.

  • 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.

  • [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": [{ "id": "CAE60ED9-8B57-40B9-98D5-3CB5068E4D81", "number": "22", "status": "true", "hostIdentification": "AIFBE123F", "serialNumber": "string", "lot": "string", "progressType": "integer", "materialId": "30A295F8-D3EC-44C5-8825-00A2358E4280", "materialName": "ITEM0241", "quantity": "float", "quantityRequested": "10", "quantityConfirmed": "8", "quantityDeviated": "2", "expiryDate": "datetime", "releaseDate": "datetime", "productionDate": "datetime", "status": "queued", "modifiedAt": "2020-02-10 00:36:00.327", "Info1": "string", "Info2": "string", "Info3": "string", "Info4": "string", "Info5": "string", }] }] }

Create Order Line

post /api/order_lines

Create an order line, to be imported by PowerPick.

Body Parameters

  • number integer REQUIRED

    The sequence number of the order line.

  • materialName string REQUIRED

    The name of the material on the order line.

  • orderNumber REQUIRED

    The number of the order this order line belongs to.

  • 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.

  • expiry 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 '{ "number": "integer", "materialName": "string", "orderNumber": "", "quantity": "integer", }'
Example Response
{ "orderline": { "id": "CAE60ED9-8B57-40B9-98D5-3CB5068E4D81", "number": "22", "status": "true", "hostIdentification": "AIFBE123F", "serialNumber": "string", "lot": "string", "progressType": "integer", "materialId": "30A295F8-D3EC-44C5-8825-00A2358E4280", "materialName": "ITEM0241", "quantity": "float", "quantityRequested": "10", "quantityConfirmed": "8", "quantityDeviated": "2", "expiryDate": "datetime", "releaseDate": "datetime", "productionDate": "datetime", "status": "queued", "modifiedAt": "2020-02-10 00:36:00.327", "Info1": "string", "Info2": "string", "Info3": "string", "Info4": "string", "Info5": "string", } }

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 "http://[Your IP]/api/order_lines/[id]" \ -X get \-H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "orderline": { "id": CAE60ED9-8B57-40B9-98D5-3CB5068E4D81, "number": 22, "status": "true", "hostIdentification": "AIFBE123F", "serialNumber": "string", "lot": "string", "progressType": integer, "materialId": 30A295F8-D3EC-44C5-8825-00A2358E4280, "materialName": "ITEM0241", "quantity": float, "quantityRequested": 10, "quantityConfirmed": 8, "quantityDeviated": 2, "expiryDate": datetime, "releaseDate": datetime, "productionDate": datetime, "status": "queued", "modifiedAt": 2020-02-10 00:36:00.327, "Info1": "string", "Info2": "string", "Info3": "string", "Info4": "string", "Info5": "string", } }

Delete Order Line

get /api/order_lines/[id]/delete

Delete an order line.

Arguments

Request with curl
curl "http://[Your IP] /api/order_lines/[id]/delete" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{"deleted": "true" }