- API Reference
- API Calls
- Batches
- Bins
- Carriers
- Clients
- Cost Centers
- Kits
- Kit Lines
- Locations
- Location Contents
- Materials
- Material Codes
- Material Properties
- Orders
- Order Lines
- Reports
- Report Rows
- Shelves
- Snapshots
- Stations
- Storage Rules
- Storage Units
- Transactions
- Users
- Warehouses
- Work Order Lines
- Zones
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.
-
number
integer
The internal number of this transaction record.
-
creationDate
datetime
When the transaction record was created.
- expiryDate datetime
- productionDate datetime
- releaseDate datetime
-
shelfName
string
The shelf where this transaction occurred.
-
locationName
string
The location where this transaction occurred.
-
warehouseName
string
The warehouse where this transaction occurred.
-
carrierName
string
The carrier where this transaction occurred.
-
binName
string
The bin where this transaction occurred.
-
userName
string
The user who created this transaction.
-
orderLineId
uuid
The ID of the order line this transaction belongs to.
- xStep integer
- yStep integer
-
orderId
uuid
The ID of the order this transaction belongs to.
-
motiveType
integer
Motives are: NotSet (0), StockUnavailable (1), Shortage (2), SpaceUnavailable (3), SpaceFull (4), Deleted (5), Canceled (6), RoundUpOverstock (7), ResolveMissingQty (8), Trim (9), CancelError (10)
-
type
integer
Types are: ManualPut (1), ManualPick (2), OrderPut (3), OrderPick (4), Transfer (5), OrderCount (6), ContextCount(7) - context driven location count during put/pick, MaterialRename (8), ManualCorrection (9), ContextCorrection (10) - automatic stock correction during pick/store if a stock shortage is indicated, CancelRequest(11) - Cancel order request, Purge (12), Production (13), KitRename (15)
-
quantityTotal
float
The total quantity that was picked/put/counted when this transaction occurred.
-
quantityRequested
float
The total quantity that was asked for when this transaction occurred.
- quantityConfirmed float
- quantityDeviated float
-
exportStateType
integer
The Export State Type is used by external systems to flag whether the transaction record has been exported. Export types are: NotSet (0) Cannot yet be exported (1), Ready to export (2), Currently exporting or export canceled (3), Successfully exported (4), Export failed (5) Not to be exported (6)
-
lot
string
The lot number of this transaction, if applicable.
-
taskNumber
string
The task number of this transaction, if applicable.
-
serialNumber
string
The serial number of this transaction, if applicable.
- reasonCode
- qualification integer
Endpoints
List Transactions
get /api/transactionsArguments
-
limit
integer
A limit on the number of objects to be returned. Limit can range between 1 and 1000, and the default is 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.
-
creationDate
datetime
Only return transactions that were created on a certain date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.
-
productionDate
datetime
Only return transactions that have a productionDate on a certain date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.
-
number
integer
Only return transactions that have the given number.
-
exportStateType
integer
Only return transactions that have export state type.
-
releaseDate
datetime
Only return transactions that have a releaseDate on a certain date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.
-
expiryDate
datetime
Only return transactions that have a expiryDate on a certain date. Like all date arguments, a [gt], [lt], [lte], for [gte] can be prefixed.
-
[dynamic_field]
Any dynamic fields that have been set up can be used as a filter.
- quantityTotal
- quantityRequested
- quantityConfirmed
- quantityDeviated
{ "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.
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]'
{ "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
-d '{"exportStateType": "4"}'
{ "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 } }