Create Barcode

This action creates a barcode image in the specified format. It supports a variety of one-dimensional (1D) barcode types and allows for customization of size, colors, and other properties.

Parameters

Required

• Data (string) - The data to be encoded in the barcode.
• CodeType (enum) - The type of barcode to generate. Default: Ean13. Options include:
  • UpcA, UpcE - Universal Product Code variants
  • Ean13, Ean8 - European Article Number variants
  • Code39, Code39Extended, Code39Mod43 - Code 39 variants
  • Code128, Code128A, Code128B, Code128C - Code 128 variants
  • Interleaved2Of5 - Interleaved 2 of 5
  • And many more standard barcode formats

Optional

• OutputImageFormat (enum) - The format of the output image. Default: Png. Options include:

  • Png - PNG format
  • Jpeg - JPEG format
  • Gif - GIF format
  • Svg - SVG format
  • Tiff - TIFF format

• Height (integer) - The height of the barcode image in pixels. Default: 290

• Width (integer) - The width of the barcode image in pixels. Default: 120

• BackgroundColorAsString (string) - The background color of the barcode. Default: White

• ForegroundColorAsString (string) - The color of the barcode bars. Default: Black

• Rotation (float) - Rotation angle in degrees. Default: 0

• BarWidth (integer) - Width of the barcode bars. Default: 1

• BorderVisible (boolean) - Whether to display a border. Default: false

• BorderColorAsString (string) - The border color (when border is visible)

• BorderStyle (enum) - Style of the border. Default: Solid. Options include: Solid, Dashed, Dotted

• BorderWidth (integer) - Width of the border in pixels. Default: 1

• LabelVisible (boolean) - Whether to display the encoded data as a label. Default: false

• LabelFontAsString (string) - The font to use for the label

• LabelFontStyle (enum) - Style of the label font. Default: Normal. Options include: Normal, Bold, Italic, BoldItalic

• LabelFontSize (float) - Size of the label font. Default: 18

Output

• FileContent (string) - Base64-encoded string of the barcode image
• Filename (string) - Suggested filename for the barcode image

Example

{
  "Data": "1234567890128",
  "CodeType": "Ean13",
  "OutputImageFormat": "Png",
  "Height": 300,
  "Width": 300,
  "BackgroundColorAsString": "#FFFFFF",
  "ForegroundColorAsString": "#000000",
  "LabelVisible": true
}

Notes

Credit Cost

Cost: 1 credit(s) per call

• Ensure the data format matches the requirements of the selected barcode type. For example, EAN-13 requires exactly 12 digits (the 13th is a checksum that will be calculated automatically).
• Different barcode types have different data encoding capacities and format requirements.
• When using color parameters, you can provide either named colors (e.g., “Red”, “Blue”) or hex color values (e.g., “#FF0000”, “#0000FF”).