Order Lines

Attributes

  • id uuid

    Unique identifier for the object.

  • costCenterName string LIMIT: 50

    The cost center this order line was processed at.

  • directionType integer

    The type of order.

    Possible values:

    1 = Put
    2 = Pick
    3 = Return
    4 = Transport
    5 = Count
    7 = Production

  • expiryDate dateTime

    Used by a material property to track material expiry.

  • hasStock boolean

    If there is enough stock to fulfill the order line.

    Possible values:

    0 = False
    1 = True

  • hostIdentification string LIMIT: 50

    A unique value at the order line level that can be carried through from ERP to PPG and back to ERP.

  • incompleteAllocations integer

  • Info1 string LIMIT: 80

    A generic field for custom use.

  • Info2 string LIMIT: 80

    A generic field for custom use.

  • Info3 string LIMIT: 80

    A generic field for custom use.

  • Info4 string LIMIT: 80

    A generic field for custom use.

  • Info5 string LIMIT: 80

    A generic field for custom use.

  • lot string LIMIT: 50

    Lot number used by a material property for tracking materials.

  • materialId uuid

    The unique ID of the material on the order line.

  • materialName string LIMIT: 50

    The name of the material on the order line.

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

  • number integer

    The unique sequence number of the order line. If not provided, the system automatically generates a unique number for the order line.

  • orderId uuid

    The unique ID of the order that the order line belongs to.

  • owner string LIMIT: 50

    Used in a transfer order. The owner will be replaced by the given recipient, which will be assigned as the new owner of the material during the put.

  • productionDate dateTime

    Used by a material property to track material production date.

  • progressType integer

    Status of the individual line.

    Possible values:

    1 = Not Started
    2 = In Progress/Complete

  • putBinName string LIMIT: 50

    Designated bin especially for transfer orders.

  • putDate dateTime

    Used by return orders to specify the original put date of the material. If this value is not provided by host, the current date will be used.

  • putHeight integer

    Designated height especially for transfer orders.

  • putLocation string LIMIT: 128

    Designated location especially for transfer orders.

  • qualification string LIMIT: 50

    A specified attribute of the material on the order line.

  • quantity float

    The quantity on the original order line.

  • quantityConfirmed float

    Actual quantity of units processed, confirmed by the user. Only shows if the order line has been processed.

  • quantityDeviated float

    The difference between the quantity of units requested and units actually processed, recorded by the user. Only shows if the order line has been processed.

  • quantityRequested float

    Original quantity requested for the order line. Only shows if the order line has been processed.

  • releaseDate dateTime

    Used by a material property to track material release date.

  • serialNumber string LIMIT: 50

    Unique serial number, recorded at the item level when a material is added or retrieved.

  • status string

    Queued is imported but not fully picked, and processed is fully picked.

    Possible values:

    queued
    processed

  • storageUnits array

    Storage unit(s) where the order line is being processed.

  • [dynamicField] string LIMIT: 1999

    Any of the dynamic order fields from PowerPick. Requires ItemPath's Custom Fields app.

Endpoints

List Order Lines

get /api/order_lines

Arguments

  • costCenterName string LIMIT: 50

    The cost center this order line was processed at.

  • directionType integer

    The type of order.

    Possible values:

    1 = Put
    2 = Pick
    3 = Return
    4 = Transport
    5 = Count
    7 = Production

  • expiryDate dateTime

    Used by a material property to track material expiry. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • hasStock boolean

    If there is enough stock to fulfill the order line.

    Possible values:

    0 = False
    1 = True

  • hostIdentification string LIMIT: 50

    The identification sent from host system, specially by SAP. Will be written to history table to report it back to the host.

  • incompleteAllocations integer

  • Info1 string LIMIT: 80

    A generic field for custom use.

  • Info2 string LIMIT: 80

    A generic field for custom use.

  • Info3 string LIMIT: 80

    A generic field for custom use.

  • Info4 string LIMIT: 80

    A generic field for custom use.

  • Info5 string LIMIT: 80

    A generic field for custom use.

  • lot string LIMIT: 50

    Lot number used by a material property for tracking materials.

  • materialId uuid

    The unique ID of the material 0n the order line.

  • materialName string LIMIT: 50

    The name of the material on the order line.

  • modifiedDate 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. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • number integer

    The unique sequence number of the order line. If not provided, the system automatically generates a unique number for the order line.

  • orderId uuid

    The unique ID of the order that the order line belongs to.

  • owner string LIMIT: 50

    Used in a transfer order. The owner will be replaced by the given recipient, which will be assigned as the new owner of the material during the put.

  • pickBinName string LIMIT: 50

    Designated bin especially for transfer orders.

  • pickLocation string LIMIT: 128

    Designated location especially for transfer orders.

  • productionDate dateTime

    Used by a material property to track material production date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • progressType integer

    Status of the individual line.

    Possible values:

    1 = Not Started
    2 = In Progress/Complete

  • putBinName string LIMIT: 50

    Designated bin especially for transfer orders.

  • putDate dateTime

    Used by return orders to specify the original put date of the material. If this value is not provided by host, the current date will be used. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • putHeight integer

    Designated height especially for transfer orders.

  • putLocation string LIMIT: 128

    Designated location especially for transfer orders.

  • qualification string LIMIT: 50

    Used by a material property for tracking materials.

  • quantity integer

    Filter by a certain quantity.

  • quantityConfirmed integer

    Actual quantity of units processed, confirmed by the user. Only shows if the order line has been processed.

  • quantityDeviated integer

    The difference between the quantity of units requested and units actually processed, recorded by the user. Only shows if the order line has been processed.

  • quantityRequested integer

    Original quantity requested for the order line. Only shows if the order line has been processed.

  • releaseDate dateTime

    Used by a material property to track material release date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • serialNumber string LIMIT: 50

    Unique serial number, recorded at the item level when a material is added or retrieved.

  • status string

    Queued is imported but not fully picked, and processed is fully picked.

    Possible values:

    queued
    processed

  • storageUnits array

    Storage unit(s) where the order line is being processed.

  • [dynamicField]

    Any dynamic fields that have been set up can be used as a filter. Requires ItemPath's Custom Fields app.

  • limit integer

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

    Default value: 250

  • offset integer

    Will return items, but only those after the integer amount.

  • countOnly boolean

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

    Default value: false

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_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
        }
}

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.

  • materialId uuid
    REQUIRED

    The unique ID of the material on the order line.
    Note: Either a materialId OR a materialName is required, not both.

  • materialName string LIMIT: 50
    REQUIRED

    The material name of the item(s).
    Note: Either a materialId OR a materialName is required, not both.

  • quantity integer
    REQUIRED

    The quantity to be processed on the order line. This is not required for Count orders.

  • number integer

    The unique sequence number of the order line. Will be automatically generated if not provided.

    Default value: 1 (or next consecutive number)

  • batchName string LIMIT: 50

    The Lot or Batch number of the material on the order line.

  • expiryDate dateTime

    Used by a material property to track material expiry.

  • hostIdentification string LIMIT: 50

    A unique value at the order line level that can be carried through from ERP to PPG and back to ERP.

  • Info1 string LIMIT: 80

    A generic field for custom use.

  • Info2 string LIMIT: 80

    A generic field for custom use.

  • Info3 string LIMIT: 80

    A generic field for custom use.

  • Info4 string LIMIT: 80

    A generic field for custom use.

  • Info5 string LIMIT: 80

    A generic field for custom use.

  • productionDate dateTime

    Used by a material property to track material production date.

  • qualification string LIMIT: 50

    A specified attribute of the material on the order line.

  • releaseDate dateTime

    Used by a material property to track material release date.

  • serialNumber string LIMIT: 50

    The unique serial number at the unit level of the material on the order line.

  • storageUnits array

    A list of storage units that this order line can be picked or put from. Either an ID or name is required.

    Possible values:

    [{"id": "3276A9F6-7CE5-4924-A02B-FD8304D7C3A1"}, {"name": "VLM 1"}]

  • locations array

    A list of locations that this order line can be picked or put from. Either an ID or name is required.

    Possible values:

    [{"id": "8B3E44C1-EA03-4F2D-A514-EF5B7AE2BF89"}, {"name": "VLM 1/01/01"}]

  • zones array

    A list of zones that this order line can be picked or put from. Either an ID or name is required.

    Possible values:

    [{"id": "9B937196-FBDC-4462-9D15-E60A7EEB5FA7"}, {"name": "Zone 1"}]

  • shelves array

    A list of shelves that this order line can be picked or put from. Either an ID or name is required.

    Possible values:

    [{"id": "7142BF15-38BD-4971-BCB2-D890DDA9CC32"}, {"name": "01/01"}]

  • carriers array

    A list of carriers that this order line can be picked or put from. Either an ID or name is required.

    Possible values:

    [{"id": "66AFE69B-695E-469F-9E73-C416A12B727E"}, {"name": "01"}]

  • [DynamicField] LIMIT: 1999

    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,
    "storageUnits": [{"id": "66AFE69B-695E-469F-9E73-C416A12B727E"}],
}'
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

delete /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"}