Label printing API
API for external consumer label printing applications
| API | Description |
|---|---|
| GET api/labelprinting/connectiontest |
Test the API key and other factors. Returns 200 OK on success, on failure a non 2xx code is returned. |
| GET api/labelprinting/images/{filename} |
Get labeling image using the filename returned in the labeling instructions. |
| GET api/labelprinting/instructions?ownerNumber={ownerNumber}&productIdentifier={productIdentifier}&classId={classId}&includeImageData={includeImageData} |
Gets labeling instructions by owner and product identifier. Returns LabelingInstructions object, see that for more information about its contents. |
External picking API
API requests towards WMS for external picking applications
| API | Description |
|---|---|
| GET api/externalpicking/connectiontest |
Test the API key and other factors. Returns 200 OK on success, on failure a non 2xx code is returned. |
| GET api/externalpicking/printers?warehouse={warehouse} |
Get available printers |
| POST api/externalpicking/batchcompleted?wmsbatchid={wmsbatchid} |
External picking application has finished a picking batch (a group of items to pick, which might be called a job, a task, a picking list etc.). Returns 200 OK on success, non-2xx response on failure. |
| GET api/externalpicking/requestfilltask?wmslineid={wmslineid} |
External picking application requests a forklift fill task to the picking place indicated by the product and shelf place of the picking line. |
| GET api/externalpicking/validateserialnumber?wmslineid={wmslineid}&serialnumber={serialnumber} |
Validates given serial number. Returns an object from which the result can be obtained. |
| GET api/externalpicking/stockquantity?productid={productid}&warehouse={warehouse} |
Gets product pickable quantity in warehouse. Container quantity is pickable if container classification is Normal, Dump, Taxfree or NULL and batch number is not Broken. |
| POST api/externalpicking/printcontainerlabel?wmsbatchid={wmsbatchid} |
External picking application can print container labels Returns 200 OK on success, non-2xx response on failure. |
| POST api/externalpicking/batchstarted?wmsbatchid={wmsbatchid} |
This method should be called when the user of the external picking application has starting to batch. So this method should always be called exactly once per batch. Returns 200 OK on success, non-2xx response on failure. |
| POST api/externalpicking/linecompleted?wmslineid={wmslineid} |
This method should be called when the user of the external picking application has finished handling a picking line, and will not return to the line again. So this method should always be called exactly once for each line. The picked quantity, along with provided container identifiers, serial numbers etc. are stored into the WMS database. Returns 200 OK on success, non-2xx response on failure. |
Warehouse picking status and performance API
Logistics operator level API for picking status and performance data.
| API | Description |
|---|---|
| GET api/pickingstatus/connectiontest |
Test the API key and other factors. Returns 200 OK on success, on failure a non 2xx code is returned. |
| GET api/pickingstatus/owners?pickingDate={pickingDate}&warehouse={warehouse}&pickingMethodId={pickingMethodId} |
Gets picking status of a picking date for each owner. |
| GET api/pickingstatus/performance?warehouse={warehouse}&pickingMethodId={pickingMethodId} |
Gets picking performance measurements relative to current date and time |