Connectors Reference

Cloudmersive Barcode

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

 

Status: Preview

Tier: Premium

Version: v1

 

Actions:

Name

Summary

BarcodeLookup_EanLookup (string value)

Lookup EAN barcode value, return product data

BarcodeScan_Image (file imageFile)

Scan and recognize an image of a barcode

GenerateBarcode_QRCode (string value)

Generate a QR code barcode as PNG file

GenerateBarcode_UPCA (string value)

Generate a UPC-A code barcode as PNG file

GenerateBarcode_UPCE (string value)

Generate a UPC-E code barcode as PNG file

GenerateBarcode_EAN13 (string value)

Generate a EAN-13 code barcode as PNG file

GenerateBarcode_EAN8 (string value)

Generate a EAN-8 code barcode as PNG file

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

BarcodeLookupResponse

 

BarcodeScanResult

 

file

Image file to perform the operation on.  Common file formats such as P

ProductMatch

 

 

Actions:

BarcodeLookup_EanLookup

Summary: Lookup EAN barcode value, return product data

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

 

Syntax:

CloudmersiveBarcode.BarcodeLookup_EanLookup (string value)

 

Parameters:

Name

Type

Summary

Required

Related Action

value

string

 

 

True

 

Returns:

          Type:BarcodeLookupResponse

          Description: Result of performing a barcode lookup

 

BarcodeScan_Image

Summary: Scan and recognize an image of a barcode

Description: 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

 

Syntax:

CloudmersiveBarcode.BarcodeScan_Image (file imageFile)

 

Parameters:

Name

Type

Summary

Required

Related Action

imageFile

file

(Image file to perform the operation on.  Common file formats such as P)

Image file to perform the operation on.  Common file formats such as P

True

 

Returns:

          Type:BarcodeScanResult

          Description: Result of the barcode scan

 

GenerateBarcode_QRCode

Summary: Generate a QR code barcode as PNG file

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

 

Syntax:

CloudmersiveBarcode.GenerateBarcode_QRCode (string value)

 

Parameters:

Name

Type

Summary

Required

Related Action

value

string

 

 

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

GenerateBarcode_UPCA

Summary: Generate a UPC-A code barcode as PNG file

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

 

Syntax:

CloudmersiveBarcode.GenerateBarcode_UPCA (string value)

 

Parameters:

Name

Type

Summary

Required

Related Action

value

string

 

 

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

GenerateBarcode_UPCE

Summary: Generate a UPC-E code barcode as PNG file

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

 

Syntax:

CloudmersiveBarcode.GenerateBarcode_UPCE (string value)

 

Parameters:

Name

Type

Summary

Required

Related Action

value

string

 

 

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

GenerateBarcode_EAN13

Summary: Generate a EAN-13 code barcode as PNG file

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

 

Syntax:

CloudmersiveBarcode.GenerateBarcode_EAN13 (string value)

 

Parameters:

Name

Type

Summary

Required

Related Action

value

string

 

 

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 

GenerateBarcode_EAN8

Summary: Generate a EAN-8 code barcode as PNG file

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

 

Syntax:

CloudmersiveBarcode.GenerateBarcode_EAN8 (string value)

 

Parameters:

Name

Type

Summary

Required

Related Action

value

string

 

 

True

 

Returns:

          Type:string(binary)OutputContent

Title: OutputContent

          Description: Output file content from the operation

 


 

BarcodeLookupResponse

Summary:

Description: Result of performing a barcode lookup

 

          Properties:

Name

Type

Summary

Successful

boolean

 

True if operation was successful, false otherwise

Matches

array of (ProductMatch)

 

Resulting product matches for the input barcode


 

BarcodeScanResult

Summary:

Description: Result of the barcode scan

 

          Properties:

Name

Type

Summary

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


 

file

Summary: Image file to perform the operation on.  Common file formats such as P

Description: Image file to perform the operation on.  Common file formats such as P

 

          Properties:

Name

Type

Summary


 

ProductMatch

Summary:

Description: Matching product for the input barcode

 

          Properties:

Name

Type

Summary

EAN

string

 

EAN code for the product

Title

string

 

Title of the product