Module: repository/fabship/rfid

Methods

deleteCarton(cartonId) → {Number}

This method is responsible to delete carton
Parameters:
Name Type Description
cartonId String The postUnique (carton id)
Returns:
Type
Number

deleteCartonBarcode(cartonBarcode) → {Number}

This method is responsible to delete carton barcode and carton description
Parameters:
Name Type Description
cartonBarcode String The carton barcode
Returns:
Type
Number

deleteEPCData(epcList, location) → {Number}

Parameters:
Name Type Description
epcList Array.<String> The list of epc codes
location String The location
Returns:
Type
Number

deleteProductDetails(gtin, orderNumber) → {Number}

Parameters:
Name Type Description
gtin String The unique gtin
orderNumber String The order number
Returns:
Type
Number

getCartonCode(barcode) → {String}

This method returns carton code based on carton barcode
Parameters:
Name Type Description
barcode String The carton barcode
Returns:
cartonCode The carton code
Type
String

getCartonIdFromEPC(epcCode) → {String}

This method is responsible to get carton id using the EPC number
Parameters:
Name Type Description
epcCode String The epcCode
Returns:
Type
String

getGTINProductDetails(gtinList) → {Array.<gtinDetails>}

This method returns the product details associated with a list of GTIN(s)
Parameters:
Name Type Description
gtinList Array.<String> The list of GTINs
Returns:
The list of product details associated {@link:module:repository/fabship/rfid~gtinDetails}
Type
Array.<gtinDetails>

getScannedCartonsForLocationAndDate(location, fromScanDate, toScanDate) → {Array.<cartonDetails>}

This method fetches the scanned carton and epc details at a location filtered by date
Parameters:
Name Type Description
location String The location
fromScanDate String The from scanned date YYYY-MM-DD
toScanDate String The to scanned date YYYY-MM-DD
Returns:
The returned details module:repository/fabship/rfid~cartonDetails
Type
Array.<cartonDetails>

insertCartonBarcode(cartonBarcode, cartonDescription, cartonCode) → {Number}

This method is responsible to insert carton barcode and carton description
Parameters:
Name Type Description
cartonBarcode String The carton barcode
cartonDescription String The carton description
cartonCode String The carton code
Returns:
Type
Number

insertEPCData(epcList, location, shipmentId, cartonBarcode, cartonCode, cartonWeight, packType) → {Number}

Parameters:
Name Type Description
epcList Array.<String> The list of epc codes
location String The location
shipmentId String The shipment id
cartonBarcode String The carton barcode
cartonCode String The carton code
cartonWeight Number The carton weight
packType String The type of pack
Returns:
Type
Number

insertProductDetails(productDetails) → {Number}

Parameters:
Name Type Description
productDetails Array.<productDetails> The product details {@link:module:repository/fabship/rfid~productDetails}
Returns:
Type
Number

validateCartonBarcode(barcode) → {boolean}

This method returns boolean on validate of carton barcode
Parameters:
Name Type Description
barcode String The carton barcode
Returns:
Type
boolean

validateCartonId(The) → {boolean}

This method returns boolean on validate of carton id
Parameters:
Name Type Description
The String carton id
Returns:
Type
boolean

validateEPCList(epcList) → {Boolean}

This method checks whether all the EPC(s) were scanned into the database
Parameters:
Name Type Description
epcList Array.<String> The list of electronic product codes
Returns:
Type
Boolean

validateGTINList(gtinList) → {Boolean}

This method checks if the GTIN(s) details are present in the database
Parameters:
Name Type Description
gtinList Array.<String> The list of GTINs
Returns:
Type
Boolean

Type Definitions

cartonDetails

Type:
  • Object
Properties:
Name Type Description
cartonDetails.shipmentId String The shipment id
cartonDetails.cartonId String The carton Id
cartonDetails.cartonCode String The carton code
cartonDetails.cartonWeight Number The carton weight
cartonDetails.packType String The type of pack
cartonDetails.epc String The concatenated epc(s) grouped
cartonDetails.scannedTime String The date and time of scan

gtinDetails

Type:
  • Object
Properties:
Name Type Description
gtinDetails.orderNumber String The order number
gtinDetails.gtin String The GTIN
gtinDetails.description String The garment description
gtinDetails.size String The size

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.garmentDescription String The product description
productDetails.size String The size(s)