circle-exclamation
This documentation is currently under development. Certain sections are not yet complete and will be added shortly.

Barcode

Generate a barcode image

get
/api/{tenantId}/barcode/{type}/{data}

Generates a barcode or QR code image in PNG format with customizable colors and dimensions.

Supported Barcode Types

  • QR Code: 2D matrix barcode with error correction

  • PDF417: High-capacity 2D stacked barcode

  • UPC-A/UPC-E: Universal Product Code for retail

  • EAN-8/EAN-13: European Article Number for retail

  • Code 39/93/128: Linear barcodes for various applications

  • ITF-14: Interleaved 2 of 5 for shipping containers

Color Parameters

  • Colors must be specified as 6-digit hex values (without #)

  • Example: fg=000000 for black, bg=FFFFFF for white

Dimensions

  • For QR codes: width acts as a sizing hint (height is ignored)

  • For linear barcodes: both width and height are applied

Caching

Generated images are cached for 100 days based on query parameters.

Path parameters
datastringRequired

Data to encode.

typestring · enumRequired

Barcode symbology to generate.

Possible values:
tenantIdstringRequired
Query parameters
fgstringOptional

Foreground color as HTML hex without the leading #.

Default: 000000
bgstringOptional

Background color as HTML hex without the leading #.

Default: FFFFFF
winteger · int32Optional

Target image width; for QR, acts as a hint.

Default: 300
hinteger · int32Optional

Image height; ignored for QR.

Default: 50
Responses
get
/api/{tenantId}/barcode/{type}/{data}
200

OK

No content

Last updated