Transactions

The data from /api/transactions is coming from the History table in MSSQL, and is available in the history list in PowerPick.

This data is PowerPick's internal record of transactions, which you can view in the History List (in PowerPick). This generates records of every Pick, Put, Count and other types of transactions, broken down by order, order line, lot, serial, and other breakdowns. It's a raw listing of all that's happening at the storage level.

Attributes

  • id uuid

    A unique ID for this transaction.

  • batchName string

    Name of the batch this order is a part of, if any.

  • binName string

    The bin where this transaction occurred. Bins are usually named by size (08×04 or Medium) or by the materials they store.

  • carrierName string

    The carrier where this transaction occurred.

  • creationDate datetime

    Date and time the transaction record was created.

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

  • exportStateType integer

    Used by external systems (including Data Push) to flag whether the transaction record has been exported.

    Possible values:

    0 = NotSet
    1 = Cannot yet be exported
    2 = Ready to export
    3 = Currently exporting or export canceled
    4 = Successfully exported
    5 = Export failed
    6 = Not to be exported

  • handlingUnit string

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

  • locationName string

    The location where this transaction occurred.

  • lot string

    The lot number of this transaction, if applicable.

  • materialName

    Usually the name of the material, but can be a material code, kit, or handling unit name.

  • motiveType integer

    Reason order was not fully completed.

    Possible values:

    0 = NotSet
    1 = StockUnavailable
    2 = Shortage
    3 = SpaceUnavailable
    4 = SpaceFull
    5 = Deleted
    6 = Canceled
    7 = RoundUpOverstock
    8 = ResolveMissingQty
    9 = Trim
    10 = CancelError

  • number integer

    The internal number of this transaction record.

  • orderId uuid

    The ID of the order this transaction belongs to.

  • orderLineId uuid

    The ID of the order line this transaction belongs to.

  • orderName

    The name of the order this transaction belongs to.

  • productionDate datetime

    Used by a material property to track material production date.

  • qualification integer

    Used by a material property for tracking materials.

  • quantityConfirmed float

    Actual quantity of units processed, confirmed by the user.

  • quantityDeviated float

    The difference between the quantity of units requested and units actually processed, recorded by the user.

  • quantityRequested float

    Original quantity requested for the order.

  • quantityTotal float

    The total quantity that was in stock when this transaction was completed.

  • reasonCode integer

    Code to explain the reason for the motive type of the record.

  • releaseDate datetime

    Used by a material property to track material release date.

  • serialNumber integer

    The serial number of this transaction, if applicable.

  • shelfName string

    The shelf where this transaction occurred.

  • storageUnitName string

    Name of the storage unit.

  • taskNumber integer

    The task number of this transaction, if applicable.

  • type integer

    Type of transaction.

    Possible values:

    0 = NotSet
    1 = ManualPut
    2 = ManualPick
    3 = OrderPut
    4 = OrderPick
    5 = Transfer
    6 = OrderCount
    7 = ContextCount
    8 = MaterialRename
    9 = ManualCorrection
    10 = ContextCorrection
    11 = CancelRequest
    12 = Purge
    13 = Production
    15 = KitRename

  • uploadDate datetime

    Date record was uploaded (not created) from external source.

  • userName string

    The user who created this transaction.

  • warehouseName string

    The warehouse where this transaction occurred.

  • xStep integer

    Bin position on the tray on the x-axis.

  • yStep integer

    Bin position on the tray on the y-axis.

  • [dynamicField] string

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

Endpoints

List Transactions

get /api/transactions

Arguments

  • batchName string

    Name of the batch this order is a part of, if any.

  • binName string

    The bin where this transaction occurred. Bins are usually named by size (08×04 or Medium) or by the materials they store.

  • carrierName string

    The carrier where this transaction occurred.

  • creationDate datetime

    Only return transactions that were created in a certain range. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • directionType integer

    The type of order.

    Possible values:

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

  • expiryDate datetime

    Only return transactions that have a expiry date in a certain range. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • exportStateType integer

    Used by external systems (including Data Push) to flag whether the transaction record has been exported.

    Possible values:

    0 = NotSet
    1 = Cannot yet be exported
    2 = Ready to export
    3 = Currently exporting or export canceled
    4 = Successfully exported
    5 = Export failed
    6 = Not to be exported

  • handlingUnit string

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

  • locationName string

    The location where this transaction occurred.

  • lot integer

    The lot number of this transaction, if applicable.

  • materialName string

    Usually the name of the material, but can be a material code, kit, or handling unit name.

  • motiveType integer

    Reason order was not fully completed.

    Possible values:

    0 = NotSet
    1 = StockUnavailable
    2 = Shortage
    3 = SpaceUnavailable
    4 = SpaceFull
    5 = Deleted
    6 = Canceled
    7 = RoundUpOverstock
    8 = ResolveMissingQty
    9 = Trim
    10 = CancelError

  • number integer

    The internal number of this transaction record.

  • orderId uuid

    The ID of the order this transaction belongs to.

  • orderLineId uuid

    The ID of the order line this transaction belongs to.

  • orderName string

    The name of the order this transaction belongs to.

  • productionDate datetime

    Only return transactions that have a production date in a certain range. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • qualification string

    Used by a material property for tracking materials.

  • quantityConfirmed float

    Actual quantity of units processed, confirmed by the user.

  • quantityDeviated float

    The difference between the quantity of units requested and units actually processed, recorded by the user.

  • quantityRequested float

    Original quantity requested for the order.

  • quantityTotal float

    The total quantity that was in stock when this transaction was completed.

  • reasonCode integer

    Code to explain the reason for the motive type of the record.

  • releaseDate datetime

    Only return transactions that have a release date in a certain range. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • serialNumber integer

    The serial number of this transaction, if applicable.

  • shelfName string

    The shelf where this transaction occurred.

  • storageUnitName string

    Name of the storage unit.

  • taskNumber integer

    The task number of this transaction, if applicable.

  • type integer

    Type of transaction.

    Possible values:

    0 = NotSet
    1 = ManualPut
    2 = ManualPick
    3 = OrderPut
    4 = OrderPick
    5 = Transfer
    6 = OrderCount
    7 = ContextCount
    8 = MaterialRename
    9 = ManualCorrection
    10 = ContextCorrection
    11 = CancelRequest
    12 = Purge
    13 = Production
    15 = KitRename

  • uploadDate datetime

    Only return transactions that have an upload date in a certain range. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.

  • userName string

    The user who created this transaction.

  • warehouseName string

    The warehouse where this transaction occurred.

  • xStep integer

    Bin position on the tray on the x-axis.

  • yStep integer

    Bin position on the tray on the y-axis.

  • [dynamicField] string

    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.

  • orderBy string, array

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

  • 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/transactions" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{
    "transactions": [
        {
            "handlingUnit": null,
            "quantityTotal": 13.0,
            "lot": null,
            "ORDELINEISSUETO": null,
            "quantityDeviated": 1.0,
            "uploadDate": null,
            "ORDERISSUETO": null,
            "quantityRequested": 1.0,
            "materialName": "S103",
            "ORDERLINENOTE": null,
            "batchName": null,
            "ORDERNOTE": null,
            "taskNumber": null,
            "creationDate": "2021-11-22T19:12:31.910000",
            "orderLineId": "E3D7DD2D-6FDD-4356-A527-FD7DC012A4AA",
            "ORDERLINEINFO6": null,
            "serialNumber": "11221",
            "userName": "Admin",
            "binName": null,
            "ORDERINFO6": null,
            "qualification": null,
            "motiveType": 5,
            "orderName": "PUT-211122-a",
            "shelfName": null,
            "storageUnitName": null,
            "yStep": null,
            "locationName": null,
            "expiryDate": null,
            "id": "53A83201-A420-425B-9369-884D49721F1B",
            "number": 1,
            "ORDERFACILITY": null,
            "reasonCode": null,
            "type": 4,
            "quantityConfirmed": 0.0,
            "exportStateType": 2,
            "warehouseName": null,
            "productionDate": null,
            "carrierName": null,
            "orderId": "D037B72C-C67A-445E-ACB4-50CFE500D001",
            "xStep": null,
            "releaseDate": null
        },
        {
            "handlingUnit": null,
            "quantityTotal": 13.0,
            "lot": null,
            "ORDELINEISSUETO": null,
            "quantityDeviated": 1.0,
            "uploadDate": null,
            "ORDERISSUETO": null,
            "quantityRequested": 1.0,
            "materialName": "S103",
            "ORDERLINENOTE": null,
            "batchName": null,
            "ORDERNOTE": null,
            "taskNumber": null,
            "creationDate": "2021-11-22T19:11:45.590000",
            "orderLineId": "DC6288AC-C2FE-4606-A1A6-FE61352C6D0D",
            "ORDERLINEINFO6": null,
            "serialNumber": "12",
            "userName": "Admin",
            "binName": null,
            "ORDERINFO6": null,
            "qualification": null,
            "motiveType": 5,
            "orderName": "Put-211111-01",
            "shelfName": null,
            "storageUnitName": null,
            "yStep": null,
            "locationName": null,
            "expiryDate": null,
            "id": "04F34123-0222-4D0D-8452-EB2FB122B8E6",
            "number": 1,
            "ORDERFACILITY": null,
            "reasonCode": null,
            "type": 3,
            "quantityConfirmed": 0.0,
            "exportStateType": 2,
            "warehouseName": null,
            "productionDate": null,
            "carrierName": null,
            "orderId": "CB64674A-5BD1-48DA-A212-BD5E763A95C6",
            "xStep": null,
            "releaseDate": null
        }
    ]
}

Show Transaction

get /api/transactions/[id]

Get a specific transaction from the PowerPick History table and return a JSON response.

Request with curl
curl -L 
-X GET '[Your IP]/api/transactions/04F34123-0222-4D0D-8452-EB2FB122B8E6' 
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer [Your JWT Access Token]'
Example Response
{
    "transaction": {
        "handlingUnit": null,
        "quantityTotal": 13.0,
        "lot": null,
        "ORDELINEISSUETO": null,
        "quantityDeviated": 1.0,
        "uploadDate": null,
        "ORDERISSUETO": null,
        "quantityRequested": 1.0,
        "materialName": "S103",
        "ORDERLINENOTE": null,
        "batchName": null,
        "ORDERNOTE": null,
        "taskNumber": null,
        "creationDate": "2021-11-22T19:11:45.590000",
        "orderLineId": "DC6288AC-C2FE-4606-A1A6-FE61352C6D0D",
        "ORDERLINEINFO6": null,
        "serialNumber": "12",
        "userName": "Admin",
        "binName": null,
        "ORDERINFO6": null,
        "qualification": null,
        "motiveType": 5,
        "orderName": "Put-211111-01",
        "shelfName": null,
        "storageUnitName": null,
        "yStep": null,
        "locationName": null,
        "expiryDate": null,
        "id": "04F34123-0222-4D0D-8452-EB2FB122B8E6",
        "number": 1,
        "ORDERFACILITY": null,
        "reasonCode": null,
        "type": 3,
        "quantityConfirmed": 0.0,
        "exportStateType": 2,
        "warehouseName": null,
        "productionDate": null,
        "carrierName": null,
        "orderId": "CB64674A-5BD1-48DA-A212-BD5E763A95C6",
        "xStep": null,
        "releaseDate": null
    }
}

Update Transaction

put /api/transactions/[id]

This allows the transaction record to be modified (usually to update the exportStateType or other minor modifications).

Arguments

  • exportStateType integer

    Used by external systems (including Data Push) to flag whether the transaction record has been exported.

    Possible values:

    0 = NotSet
    1 = Cannot yet be exported
    2 = Ready to export
    3 = Currently exporting or export canceled
    4 = Successfully exported
    5 = Export failed
    6 = Not to be exported

Request with curl
curl "http://[Your IP] /api/transactions/[id]" \ -X put \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
-d '{"exportStateType": "4"}'
Example Response
{
    "transaction": {
        "number": 1,
        "warehouseName": "Warehouse",
        "serialNumber": null,
        "id": "EB7A9067-DBC7-4641-8D30-A6F9AC85BFE8",
        "binName": "BIN-08x08x04",
        "carrierName": "001",
        "reasonCode": null,
        "yStep": 1,
        "handlingUnit": null,
        "releaseDate": null,
        "exportStateType": 4,
        "ORDERISSUETO": null,
        "lot": null,
        "ORDERNOTE": null,
        "ORDERFACILITY": null,
        "quantityRequested": 2.0,
        "orderId": "588681F8-0453-4E10-80EF-E69EDC72423A",
        "uploadDate": null,
        "userName": "Admin",
        "taskNumber": 6212,
        "expiryDate": null,
        "storageUnitName": "VLM-01",
        "motiveType": 0,
        "orderLineId": "F67A9389-C109-4BCC-BB6B-894CBCBC28FA",
        "materialName": "1101",
        "creationDate": "2021-06-28T23:24:58.833000",
        "xStep": 1,
        "ORDERINFO6": null,
        "productionDate": null,
        "batchName": "ManualPick-CR-TP-2-01",
        "orderName": "ManualPick-CR-TP-2-01",
        "ORDELINEISSUETO": null,
        "shelfName": "01",
        "type": 2,
        "quantityDeviated": 0.0,
        "quantityConfirmed": 2.0,
        "qualification": null,
        "locationName": "VLM-01-001/01-01/01",
        "ORDERLINEINFO6": null,
        "ORDERLINENOTE": null
    }
}