Skip to content
P4 Software P4 Software / BarcoderX English

Add these docs to Claude

Ask Claude questions about these docs. Claude reads the published pages and links you back to them. Copy this address:

https://p4-software.opendocs.page/mcp

In claude.ai or Claude Desktop: open Settings, then Connectors, choose Add custom connector and paste the address.

In Claude Code, run:

claude mcp add --transport http docs https://p4-software.opendocs.page/mcp

UPC-E and add-on symbols

UPC-E and add-on symbols

Applies to: BarcoderX Basic and Ultimate

Status: Built, not yet released. The encoders for UPC-E and for the add-on symbols exist inside the engine that is still being built, and they are tested. There is no released package, there is no public interface that you can call to encode a barcode directly, and the licensed engine will be the only public way to produce output. In the symbology registry, which the web API is planned to list, these symbologies still have the status Planned, because that status changes only when their evidence is complete. See What the statuses mean. The label engine draws them, and its tests cover them. Everything marked "planned" is not usable yet.

UPC-E is the short form of a UPC-A barcode. An add-on is a small extra symbol that sits to the right of an EAN-13, a UPC-A or a UPC-E. UPC-E, and the add-ons that go with an EAN-13, a UPC-A or a UPC-E, belong to the first group of symbologies and are in the Basic edition. This page describes what BarcoderX does with them. Their rules come from the GS1 General Specifications, release 26.0. BarcoderX is designed to meet them. See GS1 support.

BarcodeId in a templateWhat it carries
UPC-Eupc-eA UPC-A number that can be shortened, as 6 digits in the barcode.
Two-digit add-onean-addon-22 digits.
Five-digit add-onean-addon-55 digits.
EAN-13 with an add-onean-13-2, ean-13-5The EAN-13 and a two-digit or a five-digit add-on, in one symbol.
UPC-A with an add-onupc-a-2, upc-a-5The UPC-A and a two-digit or a five-digit add-on.
UPC-E with an add-onupc-e-2, upc-e-5The UPC-E and a two-digit or a five-digit add-on.

In a template, a barcode names its symbology and gives its content. See The label template format. The shipping barcodes are on Shipping barcodes: ITF-14, GS1-128 and SSCC-18.

UPC-E

  • Digits. Give the UPC-A number, not the six digits of the UPC-E. Give 11 digits and BarcoderX adds the last digit, the check digit. Or give all 12 and BarcoderX checks the last one. A wrong check digit is refused (BX4003), and so is any other number of digits (BX4002), a six-digit number included.
  • Shortening. BarcoderX takes the zeros out itself, by the four rules of section 5.2.2.4.1 (pages 327 and 328) of the GS1 General Specifications, release 26.0. The specification allows a UPC-E only for a GTIN-12 that starts with a zero and has a run of four or five zeros in defined places (section 5.2.2.4, page 327). For any other number BarcoderX says so (BX4022). Use a UPC-A for that number instead, with the same add-on if there is one.
  • Example. The number 012345000058 is shortened to the six digits 123455 (Figure 5-15, page 328, of the GS1 General Specifications, release 26.0). Given as 11 digits, 01234500005, BarcoderX adds the check digit 8 and makes the same barcode. Another number printed in the specification is 045670000080, which is shortened to 456784 (Figure 5-16, page 328). A number that starts with 1 is refused (BX4022).
  • The digits you read. The six digits sit under the bars. The leading 0 is shown to the left of the barcode and the check digit, 8 in the example, to the right of it (section 5.2.5, page 337, of the GS1 General Specifications, release 26.0). The encoder reports all three groups of digits, and the label engine draws them.
  • Quiet zones are 9 times the narrowest bar on the left and 7 on the right (Table 5-11 of the GS1 General Specifications, release 26.0). With them, a UPC-E is 67 modules long (Table 5-12).

Add-on symbols

What they are for

The GS1 General Specifications, release 26.0, say this about add-on symbols:

  • They were designed for use with EAN and UPC symbols on periodicals and on hardback and paperback books. Because they give reduced security, the specification limits their use to applications where the rules of the application guard the format and the content of the data (section 5.2.2.5, page 329).
  • A two-digit or a five-digit add-on gives more information about one publication of the printed item. It is not needed to identify the title. The digits are numeric data of any structure and meaning, and the publisher defines the numbering scheme. An add-on is used together with a UPC-A, a UPC-E or an EAN-13 barcode, and it is never scanned alone. Reading it at the point of sale is optional (section 2.1.3.4, page 85).
  • The digits should not hold information that belongs in the item's own GTIN (section 2.1.3.4, page 85).
  • For serial publications, the specification recommends how to use the two digits. With a five-digit add-on, a two-digit add-on cannot also be used (section 2.1.3.5, pages 86 and 87). Some of the recommendations for two digits:
PublicationTwo-digit add-on
WeeklyThe number of the week, 01 to 53.
MonthlyThe number of the month, 01 to 12.
AnnualThe first digit is the last digit of the year, and the second is 5.

For five digits, the specification says that the information can include the actual date of issue, to tell successive issues apart (section 2.1.3.5, page 87).

The GS1 General Specifications, release 26.0, say that an add-on is used together with a UPC-A, a UPC-E or an EAN-13 barcode (section 2.1.3.4, page 85), and that a two-digit or a five-digit add-on may be used to accompany an EAN-13, a UPC-A or a UPC-E (sections 5.2.2.5.1 and 5.2.2.5.2, pages 329 and 330). BarcoderX builds add-ons for those three. The registry also lists add-ons for the EAN-8 (ean-8-2 and ean-8-5), and the table of the first group on the page Barcodes counts them. They are not built: they wait for the ISO/IEC 15420 standard, which has not been read.

Giving the content

To draw an add-on next to a main symbol, choose one of the six ids of the table above and give the number of the main symbol followed directly by the digits of the add-on, with nothing between them. The id says how many digits the add-on has. The main number follows the rules of its own symbol: for example, an EAN-13 with a two-digit add-on takes 14 digits, or 15 with the check digit of the EAN-13.

IdContentPrinted in the specification
ean-13-2977138452401712: the EAN-13 9771384524017 and the add-on 12Figure 5-19, page 330
ean-13-5978087779930654321: the EAN-13 9780877799306 and the add-on 54321Figure 5-20, page 331
upc-a-201234567890524: the UPC-A 012345678905 and the add-on 24Figure 5-27, page 343
ean-13-5123456789101945678: the EAN-13 1234567891019 and the add-on 45678Figure 5-28, page 343

The two add-on types also exist on their own, ean-addon-2 with exactly 2 digits and ean-addon-5 with exactly 5. They are for drawing an add-on separately. The specification says that an add-on is never scanned alone.

  • A wrong main number. A check digit or a character that is wrong in the main number is reported with the id of the whole combination (BX4001 and BX4003). A UPC-E number that cannot be shortened is reported with BX4022.
  • Options. The only setting that a combination takes is the separation, below. A barcode that takes no settings and is given one is refused (BX4015). The label engine does not apply the settings of a barcode yet (BX3902), so a template cannot set the separation today.

The space between the two symbols

The add-on sits to the right of the main symbol and parallel to it. The same module width is used for both. The space between them is at least the right quiet zone of the main symbol, 7 modules for an EAN-13 and a UPC-E and 9 for a UPC-A, and at most 12 modules (section 5.2.3.6 and Table 5-11 of the GS1 General Specifications, release 26.0). By default BarcoderX uses the smallest. The tables of the specification do not agree for a UPC-E: Table 5-11 gives 9 to 12 for the add-ons of a UPC, while Tables 5-12 and 5-63 need 7. BarcoderX uses 7 for a UPC-E and accepts 9. A value outside the range is refused (BX4015).

With the default space and the minimum quiet zones, the whole symbol has the length that Table 5-12 gives, in modules:

With a two-digit add-onModulesWith a five-digit add-onModules
EAN-13138EAN-13165
UPC-A138UPC-A165
UPC-E92UPC-E119

The digits of an add-on

The specification asks that the digits of an add-on are shown above its bars, with the same height as the digits of the main symbol (section 5.2.5, page 337). The encoder reports them that way, and the label engine draws them that way, when the barcode has a humanReadable setting. The digits of an add-on sit one module above its bars, with their upper edges level with the top of the main bars, and they have the same size as the other digits of the symbol (they shrink together with them when they do not fit). The distance of one module and the rule for the size are choices of this project: the specification gives a minimum. If the bars are too short to hold the digits, the digits are drawn anyway and BX3907 says so.

What is the same for all of them

  • BarcoderX draws the bars as rectangles on whole printer dots, with the width of the narrowest bar rounded to whole dots. It reports the width it really used. See Barcodes.
  • Bad data gives a diagnostic code, not a crash.

The diagnostic codes of these barcodes are BX4001 to BX4003 and BX4010 to BX4022. Their texts, in English and Spanish, are in Diagnostic codes.

Not available yet

  • An EAN-8 with an add-on (ean-8-2 and ean-8-5), which waits for the ISO/IEC 15420 standard.
  • A way to set the space between the symbols from a template.

BarcoderX is a product of P4 Software.

Was this page helpful?