Barcode API API Reference

Barcode APIs let you generate barcode images, and recognize values from images of barcodes.

Swagger OpenAPI Specification | .NET Framework Client | .NET Core Client | Java Client | Node.JS Client | Python Client | Drupal Client

API Endpoint
https://api.cloudmersive.com
Schemes: https
Version: v1

Authentication

Apikey

API Key Authentication

type
apiKey
name
Apikey
in
header

BarcodeLookup

BarcodeLookup

Lookup EAN barcode value, return product data

POST /barcode/lookup/ean


Lookup an input EAN barcode and return key details about the product



Barcode value

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK
BarcodeLookupResponse

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "Matches": [
    {
      "EAN": "string",
      "Title": "string"
    }
  ]
}
Apikey

BarcodeScan

BarcodeScan

Scan and recognize an image of a barcode

POST /barcode/scan/image


Scan an image or photo of a barcode and return the result. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB



imageFile: file
in formData

Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.

Code Example:
200 OK
BarcodeScanResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "BarcodeType": "string",
  "RawText": "string"
}
Apikey
BarcodeScan

Advanced AI scan and recognition of an image of one or more QR barcodes

POST /barcode/scan/image/advanced/qr


Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats.



imageFile: file
in formData

Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.

preprocessing: string
in header

Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement.

Code Example:
200 OK
BarcodeScanQRAdvancedResult

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK) 
{
  "Successful": "boolean",
  "ResultBarcodes": [
    {
      "RawText": "string"
    }
  ],
  "BarcodeCount": "integer (int32)",
  "ErrorMessage": "string"
}
Apikey

GenerateBarcode

GenerateBarcode

Generate a QR code barcode as PNG file

POST /barcode/generate/qrcode


Generate a QR code barcode as a PNG file, a type of 2D barcode which can encode free-form text information



QR code text to convert into the QR code barcode

width: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

height: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK) 
"string (byte)"
Apikey
GenerateBarcode

Generate a UPC-A code barcode as PNG file

POST /barcode/generate/upc-a


Validate and generate a UPC-A barcode as a PNG file, a type of 1D barcode



UPC-A barcode value to generate from

width: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

height: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

includeLabel: boolean
in header

Optional: show text label on the image of the barcode value, default is true.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK) 
"string (byte)"
Apikey
GenerateBarcode

Generate a UPC-E code barcode as PNG file

POST /barcode/generate/upc-e


Validates and generate a UPC-E barcode as a PNG file, a type of 1D barcode



UPC-E barcode value to generate from

width: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

height: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

includeLabel: boolean
in header

Optional: show text label on the image of the barcode value, default is true.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK) 
"string (byte)"
Apikey
GenerateBarcode

Generate a EAN-13 code barcode as PNG file

POST /barcode/generate/ean-13


Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode



Barcode value to generate from

width: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

height: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

includeLabel: boolean
in header

Optional: show text label on the image of the barcode value, default is true.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK) 
"string (byte)"
Apikey
GenerateBarcode

Generate a EAN-8 code barcode as PNG file

POST /barcode/generate/ean-8


Validates and generate a EAN-8 barcode as a PNG file, a type of 1D barcode



Barcode value to generate from

width: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

height: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

includeLabel: boolean
in header

Optional: show text label on the image of the barcode value, default is true.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK) 
"string (byte)"
Apikey
GenerateBarcode

Generate a EAN-13 code barcode as PNG file

POST /barcode/generate/code-128


Validates and generate a EAN-13 barcode as a PNG file, a type of 1D barcode



Barcode value to generate from

width: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

height: integer
in header

Optional: width of the barcode in pixels. Minimum value of 10.

includeLabel: boolean
in header

Optional: show text label on the image of the barcode value, default is true.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

type
string (byte)
Response Content-Types: application/octet-stream
Response Example (200 OK) 
"string (byte)"
Apikey

Schema Definitions

BarcodeLookupResponse: object

Result of performing a barcode lookup

Successful: boolean

True if operation was successful, false otherwise

Matches: ProductMatch

Resulting product matches for the input barcode

ProductMatch
Example
{
  "Successful": "boolean",
  "Matches": [
    {
      "EAN": "string",
      "Title": "string"
    }
  ]
}

ProductMatch: object

Matching product for the input barcode

EAN: string

EAN code for the product

Title: string

Title of the product

Example
{
  "EAN": "string",
  "Title": "string"
}

BarcodeScanResult: object

Result of the barcode scan

Successful: boolean

True if the operation was successful, false otherwise

BarcodeType: string

The type of the barcode; possible values are AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB

RawText: string

The barcode text

Example
{
  "Successful": "boolean",
  "BarcodeType": "string",
  "RawText": "string"
}

BarcodeScanQRAdvancedResult: object

Result of the advanced QR barcode scan

Successful: boolean

True if the operation was successful, false otherwise

ResultBarcodes: BarcodeQRResultItem

Results of performing the QR barcode scan operation

BarcodeQRResultItem
BarcodeCount: integer (int32)

Number of barcodes read

ErrorMessage: string

Error message if any

Example
{
  "Successful": "boolean",
  "ResultBarcodes": [
    {
      "RawText": "string"
    }
  ],
  "BarcodeCount": "integer (int32)",
  "ErrorMessage": "string"
}

BarcodeQRResultItem: object

RawText: string

The barcode text

Example
{
  "RawText": "string"
}