Fieldpine Logo eLink Home | Documentation Home

retailmax.elink.barcodes

Returns information about individual barcodes and what these barcodes reference, such as products, loyalty cards, coupons, logistics unit etc.

Major Fields

f100
Barcode string as read by scanner
f101
Product referenced, when a product barcode

Notes

Can also be used to statically analyse a barcode without checking actual use, such as verifying validity.

Quick Example

/gnap/buck?3=retailmax.elink.barcodes
 &7=dl(sl)
 &9=f100,0,9416458040405

<ARAY>
 <f111>1</f111>
 <f121>EAN13</f121>
 <f112>20</f112>
 <f115>64</f115>
 <f125>EAN New Zealand (GS1)</f125>
 <f113>4</f113>
 <f123>Retail Item</f123>
 <DATS>
   <f100>9416458040405</f100>
   <f101>1010</f101>
   <f102>1</f102>
   <f110>1</f110>
   <f120>Product</f120>
 </DATS>
</ARAY>

eLink retailmax.elink.barcodes Bucket

This bucket returns details about a barcode and what it is referencing.

Goto: eLink Home

Input Arguments

Arg#BinaryDescription
3's'Required. Constant 'retailmax.elink.barcodes'
9's'Predicates to select data to return.
8 (or 20)'E'Maximum rows to return. The default operation is to return only the first match. (ie 8=1)
7's'Select Operation Mode. A comma separated list of keywords
  • so (SearchOrder). Controls the order in which the barcode is decoded which can affect the order of returned rows when the barcode has multiple uses. The value of this keyword is the list of types given in F110. If no value is provided the system applies a default order. Eg. 7=so(1,3,2)
  • dl (DetailLevel). Sets the fields to be returned. This is a list of the following keywords:
    • 's' (Static Decode) Calculate through the static phase and return fields that can be directly decoded from the barcode without looking up the database to see what the barcode refers too. This causes the following fields to be returned: 111, 112, 113, 300 to 399
    • 'l' (Lookup) Search the database and return detail of what is matched. This is the default mode of operation if none is supplied.
Example: 7=dl(sl)

Output Fields

This bucket returns an ARAY packet, and zero or more DATS packets for each matching entry

The ARAY packet may contain fields F111, F112, F113, f300-f399 (as defined below) when these values are being returned as part of static decode operation.

The fields on the DATS packet are:
FieldPresent by DefaultPredicatesDescription
f100YesYesThe full barcode as would be expected from a typical scanner. This is presented as the information fields only without prefix, suffix or type identifiers.
f101YesYesWhere a barcode refers to a product, this contains the product id (pid) this barcode references
f102YesNoQuantity. Where a barcode can infer a quantity, this field contains the quantity. For products, this would indicate the number of items to be sold.
f110YesYesThis DATS packet type. This is a coded number indicating the broad category the barcode refers to. Possible values are:
ValueDescription
1A product definition AND the product is known in this retail database. This would indicate a normal barcode referencing a product that is known to be available for sale
2Customer
3Teller or Staff Member
11Coupon
12Trade Unit
13SSCC
14Active Stored Value Card
15Inactive Stored Value Card
16Payment Voucher
17FlyBuy Loyalty Card
f111NoNoSymbology
ValueDescription
0Unknown
1EAN13
2EAN8
3UPCA
4UPCE
5Code 39
6Codabar
7ITF
8IATA
9Code 128
10EAN128
11Code 93
f112NoNoSymbology trust level. An indicator showing how confident we are of the value in f111. Ranges from 0 (unknown) to 100 (definite). 50 means "We think it is a ... but cannot be sure with information provided"
fYes
fYes
fYes
fYes
fYes
f113NoNoBarcode Contents. When a static decode operation is undertaken, this field returns the expected barcode contents based on the rules for that symbology.
ValueDescriptionValueDescription
0Unknown 1Store Private Use (EAN '2' etc). Returns f300 and f301
2Store Specific Variable Weighed Item (EAN '02') 3Coupon
f300NoNoPLU or part code, when this can be extracted from a static decode operation. ie the Part code is embedded in the barcode.
f301NoNoPrice from a static decode operation.

Examples