Specification for Barcode Service

Check out the specification below to see how easy it is to integrate barcode into your solutions.

Barcode Benefits

Barcodes have grown in popularity since the 1970s are are now utilised almost everywhere where there is a need to accurately route, track or identify something. When compared to manual data entry where studies show an expert operator will make an average of one error every 300 characters, even the least accurate barcode implementation is almost 1,500 times more accurate and the most accurate barcode implementation is over 2 million times more accurate. So that's a no-brainer then! Using barcodes will greatly increase production, accuracy and can help to dramatically reduce costs.

Choosing a Barcode

If there is an industry standard for the intended barcode use, you should follow that standard, otherwise you can choose from the many options feedzon provides. Note that in some industries there are multiple standards, so be careful to identify which standard is appropriate for your intended usage. If you will also be scanning the bardcodes, consider whether barcode scanning equipment has already been purchased and which types of barcodes it can scan - there is no point in creating 2D barcodes if the scanners can only read 1D barcodes and there is no budget to replace the scanners!

Furthermore, consider the amount of data that needs to be encoded and how much space is available on the item or packaging to print the barcode. 2D barcodes can encode much more data in a much smaller space than 1D barcodes and so are appropriate where you need to encode a lot of data in a small space. However, if you'll just be encoding a simple product ID or expiry date, then a 1D barcode should suffice. To indicate the varying size of barcodes, the following examples have all encoded the same data "feedzon.com 2013/12/31"

Show 1D Barcode specification Show 2D Barcode specification

Specification

Each request to a feedzon web service requires a number of parameters, all listed below. All requests require an Service Key which was generated when you activated a key for that service. You can create multiple keys for each service, if required.

feedzon methods and parameters names are all case sensitive,e.g. CreateBarcode will work but createBarcode will not; ServiceKey=abc123 will work and SERVICEKEY=abc123 will not.

Create Barcode

Create a barcode image.

Request Format

https://api.feedzon.com/barcode/1.1/CreateBarcode.fz?{parameters}

Returns

"0"
"6789"

Parameters

Name Type Description Example
ServiceKey String Your Service Key uYt892VbNBmKLE2K9upE83HhjeR6342L

Because feedzon supports so many 1D & 2D barcode types, the specification might look a little complex, but don't worry; you just need to identify which barcode type you'll be using and which parameters it requires. Different barcode types have different requirements, for example some can only contain numeric values and others alphanumeric; some types can be any length and others must be a specific length; some types require a specific start or end character. Most parameters are optional, so if you don't need to specify something, you can usually leave it out and the default values (shown) will be applied. The minimum required values for creating most barcodes are the CodeType and Data.

Download File

Download the barcode image file.

Request Format

https://api.feedzon.com/barcode/1.1/DownloadFile.fz?{parameters}

Returns

Parameters

Name Type Description Example
ServiceKey String Your Service Key uYt892VbNBmKLE2K9upE83HhjeR6342L
TaskID Integer TaskID provided when using CreateBarcode method 6789

In FileMaker the results should be saved to a container field. If the TaskID is invalid, no value is returned.

Response Errors

 

Error Description Cause Resolution
-1 Function doesn't exist The function name doesn't exist or has been spelled incorrectly. Please check your syntax for any errors since all function names and parameter names are case sensitive.
1000 Service Key is invalid The Service Key used to access feedzon was not recognised or has been disabled. Please check your Service Key, re-enable the service or contact us for further assistance.
1010 No data No data was provided for the barcode label. This error does not relate to the parameters, only the data to be printed on the barcode.
1020 Validation failed Validation failed. You've used a non-permitted character in your data. Please check the syntax for permitted characters. Please check the parameters section to identify which parameters are required for the specified command.