Express router for routes related to reading RFID tags
Methods
(static) delete/fabship/product/rfid/carton()
Route to delete a carton
Parameters:
| Name | Type | Description |
|---|---|---|
req.query.cartonId |
String | the carton unique id} |
(static) get/fabship/product/rfid() → {Array.<epcDetails>}
The route to decode a list of EPC(s) and return their GTIN mapped product details
Parameters:
| Name | Type | Description |
|---|---|---|
req.body.epc |
Array.<String> | The list of epc(s) |
Returns:
The list of GTIN details returned module:routers/v8/fabship/product/rfid~epcDetails
- Type
- Array.<epcDetails>
(static) get/fabship/product/rfid/carton/barcode/:barcode() → {string}
The route to get carton code based on carton barcode
Parameters:
| Name | Type | Description |
|---|---|---|
req.params.barcode |
String | The carton barcode |
Returns:
The carton code based on carton barcode
- Type
- string
(static) get/fabship/product/rfid/location/:location() → {Array.<scannedCartonDetails>}
The route to get the details of the cartons and epc(s) scanned at a location filtered by date of scan
Parameters:
| Name | Type | Description |
|---|---|---|
req.params.location |
String | The location |
req.query.fromScanDate |
String | The from date of scan YYYY-MM-DD |
req.query.toScanDate |
String | The to date of scan YYYY-MM-DD |
Returns:
The list of details returned module:routers/v8/fabship/product/rfid~scannedCartonDetails
- Type
- Array.<scannedCartonDetails>
(static) post/fabship/product/rfid()
Route to allow the client to post scanned EPC's and store them in DB
Parameters:
| Name | Type | Description |
|---|---|---|
req.body.location |
String | The location of the client |
req.body.epc |
Array.<String> | The epc codes that have been scanned |
req.body.shipmentId |
String | The shipment id |
req.body.cartonBarcode |
String | The carton barcode |
req.body.cartonCode |
String | The carton code |
req.body.cartonWeight |
String | The carton weight |
req.body.packType |
String | The type of pack |
(static) post/fabship/product/rfid/upload-details()
Route to upload the product details along with their GTIN
Parameters:
| Name | Type | Description |
|---|---|---|
req.body.productDetails |
Array.<productDetails> | The list of product details object module:routers/v8/fabship/product/rfid~productDetails |
Type Definitions
epcDetails
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
epcDetails.epc |
String | The EPC |
epcDetails.size |
String | The product size |
epcDetails.description |
String | The product description |
productDetails
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
productDetails.orderNumber |
String | The order number |
productDetails.season |
String | The season which is a combination of year and month YYYYMM |
productDetails.product |
String | The unique product code |
productDetails.variant |
String | The variant code |
productDetails.gtin |
String | The unique gtin |
productDetails.articleNumber |
String | The article number |
productDetails.sdsCode |
String | The SDS Code |
productDetails.description |
String | The product description which is a combination of (type, color) and (size ,fit type) separated by a comma Eg: Shirt Blue, XS/S |
scannedCartonDetails
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
scannedCartonDetails.shipmentId |
String | The shipment id |
scannedCartonDetails.cartonId |
String | The carton Id |
scannedCartonDetails.cartonNumber |
Number | The carton number |
scannedCartonDetails.cartonCode |
String | The carton code |
scannedCartonDetails.cartonWeight |
Number | The carton weight |
scannedCartonDetails.packType |
String | The type of pack |
scannedCartonDetails.scannedDate |
String | The scan date |
scannedCartonDetails.scannedTime |
String | The time of scan |
scannedCartonDetails.epcs |
Array.<String> | The list of epc(s) within the carton |