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/transactions

Arguments

  • 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

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": [{ "id": " uuid ", "number": " 1 ", "creationDate": " datetime ", "expiryDate": " datetime ", "productionDate": " datetime ", "releaseDate": " datetime ", "shelfName": " string ", "locationName": " VLM-01-001/01-05/01 ", "warehouseName": " string ", "carrierName": " string ", "binName": " string ", "userName": " Admin ", "orderLineId": " uuid ", "xStep": " integer ", "yStep": " integer ", "orderId": " uuid ", "motiveType": " integer ", "type": " integer ", "quantityTotal": " 10.0 ", "quantityRequested": " 10.0 ", "quantityConfirmed": " 10.0 ", "quantityDeviated": " float ", "exportStateType": " 2 ", "lot": " string ", "taskNumber": " string ", "serialNumber": " string ", "reasonCode": " ", "qualification": " integer ", }]}]}

Show Transaction

get /api/transactions/[id]

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

Request with curl
curl "http://[Your IP] /api/transactions/[id]" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{"transaction": { "id": uuid , "number": 1 , "creationDate": datetime , "expiryDate": datetime , "productionDate": datetime , "releaseDate": datetime , "shelfName": " string " , "locationName": " VLM-01-001/01-05/01 " , "warehouseName": " string " , "carrierName": " string " , "binName": " string " , "userName": " Admin " , "orderLineId": uuid , "xStep": integer , "yStep": integer , "orderId": uuid , "motiveType": integer , "type": integer , "quantityTotal": 10.0 , "quantityRequested": 10.0 , "quantityConfirmed": 10.0 , "quantityDeviated": float , "exportStateType": 2 , "lot": " string " , "taskNumber": " string " , "serialNumber": " string " , "reasonCode": , "qualification": integer , } }

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

Request with curl
curl "http://[Your IP] /api/transactions/[id]" \ -X put \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{"transaction": { "id": " uuid ", "number": " 1 ", "creationDate": " datetime ", "expiryDate": " datetime ", "productionDate": " datetime ", "releaseDate": " datetime ", "shelfName": " string ", "locationName": " VLM-01-001/01-05/01 ", "warehouseName": " string ", "carrierName": " string ", "binName": " string ", "userName": " Admin ", "orderLineId": " uuid ", "xStep": " integer ", "yStep": " integer ", "orderId": " uuid ", "motiveType": " integer ", "type": " integer ", "quantityTotal": " 10.0 ", "quantityRequested": " 10.0 ", "quantityConfirmed": " 10.0 ", "quantityDeviated": " float ", "exportStateType": " 2 ", "lot": " string ", "taskNumber": " string ", "serialNumber": " string ", "reasonCode": " ", "qualification": " integer ", } }