Kotlin

AI Scanning APIs

The Vision SDK supports OCR via cloud-based APIs to extract structured data from various documents like shipping labels, BOLs (Bill of Lading), and item labels. This mode leverages RESTful APIs and requires a valid API key or token and environment to be configured before making any calls. All you need to do is, capture the image of a document and then send it to relevant API.

📌 You can obtain your API key and environment details from cloud.packagex.io.

Learn how to capture an image using Vision SDK.

# ☁️ Cloud-based APIs

The Vision SDK cloud OCR supports the following document types:

• Shipping Labels (SL)
• Bill of Lading (BOL)
• Item Label (IL)

To access these cloud services, you need to create an instance of ApiManager. It has both, synchronous and asynchronous, methods that you can call to extract information from the supported document types.

Let's get deep into our cloud-based APIs.

# 📦 Shipping Labels ( SL )

Extracts structured data such as tracking numbers, courier names, addresses, etc. More details Here

To get logistic information from a shipping label, call the following method:

        suspend fun callShippingLabelAPI() {
  val stringResponse = apiManager.shippingLabelApiCallSync(
    apiKey: String? = null,
    token: String? = null,
    bitmap: Bitmap,
    shouldResizeImage: Boolean = true,
    barcodeList: List<String>,
    locationId: String? = null,
    recipient: Map<String, Any>? = null,
    sender: Map<String, Any>? = null,
    options: Map<String, Any> = emptyMap(),
    metadata: Map<String, Any> = emptyMap()
  )
  val jsonResponse = JSONObject(stringResponse)
}

      

# 🔍 Parameter Breakdown

# 📄 Bill of Lading ( BOL )

Detects and extracts BOL-specific fields such as carrier information, consignee details, and reference numbers. More details Here

To get logistic information from a bill of lading, call the following method:

        suspend fun callBillOfLadingAPI() {
  val stringResponse = apiManager.billOfLadingApiCallSync(
    apiKey: String? = null,
    token: String? = null,
    bitmap: Bitmap,
    shouldResizeImage: Boolean = true,
    barcodeList: List<String>,
    locationId: String? = null,
    options: Map<String, Any> = emptyMap(),
  )
  val jsonResponse = JSONObject(stringResponse)
}

      

# 🔍 Parameter Breakdown

# 🏷️ Item Labels

Recognizes SKU, GTIN, price, brand, and other item-level information printed on labels. More details Here

To get logistic information from an item label, call the following method:

        suspend fun callItemLabelAPI() {
  val stringResponse = apiManager.itemLabelApiCallSync(
    apiKey: String? = null,
    token: String? = null,
    bitmap: Bitmap,
    shouldResizeImage: Boolean = true,
  )
  val jsonResponse = JSONObject(stringResponse)
}

      

# 🔍 Parameter Breakdown