Labelary

https://labelary.com/
Admin
Labelary is a REST API service for rendering ZPL (Zebra Programming Language) label templates into...
Tokens:96,487
Snippets:585
Trust Score:9.3
Update:2 days ago
Show doc for...
Tokens:
Raw
### ^WS full usage example

Source: https://labelary.com/reference.html

Full usage example for ^WS command with all parameters specified.

```zpl
^WSBUILDING2,I,L,1,20,0x07FF,0
```

--------------------------------

### ^WS common usage example

Source: https://labelary.com/reference.html

Configures the wireless radio card with ESSID only. Other parameters use defaults.

```zpl
^WSBUILDING2
```

--------------------------------

### ~JI common usage

Source: https://labelary.com/reference.html

Starts a new ZBI session using the tilde command syntax.

```ZBI
~JI
```

--------------------------------

### ^BK full usage example

Source: https://labelary.com/reference.html

Full usage of the ^BK command: ^BKN,N,50,Y,N,C,D. Specifies orientation N, no check digit, height 50, line Y, lineAbove N, start character C, stop character D.

```zpl
^BKN,N,50,Y,N,C,D
```

--------------------------------

### ~WL command examples for printing network configuration label

Source: https://labelary.com/reference.html

Prints a network configuration label. Common and full usage are identical.

```zpl
~WL
```

```zpl
~WL
```

--------------------------------

### ^NS Common Usage Example

Source: https://labelary.com/reference.html

Configures network settings with a subnet mask and gateway, leaving other parameters at defaults.

```zpl
^NS,,255.255.255.0,192.168.0.1
```

--------------------------------

### ~WR common usage example

Source: https://labelary.com/reference.html

Resets the wireless radio card and the print server.

```zpl
~WR
```

--------------------------------

### ~WC - Common Usage

Source: https://labelary.com/reference.html

Prints a printer configuration label. This example uses the common usage form.

```zpl
~WC
```

--------------------------------

### ^JI common usage

Source: https://labelary.com/reference.html

Starts a new ZBI session with default parameters (console and echo enabled, no script).

```ZBI
^JI
```

--------------------------------

### ^XA - Common Usage

Source: https://labelary.com/reference.html

Begins a label definition. All label definitions must start with this command.

```zpl
^XA
```

--------------------------------

### ^XG path, magnificationX, magnificationY - Full Usage

Source: https://labelary.com/reference.html

Full usage example for the ^XG command with magnification values 2,2.

```zpl
^XGR:IMAGE.GRF,2,2
```

--------------------------------

### ^BK common usage example

Source: https://labelary.com/reference.html

Common usage of the ^BK command: ^BK,,50,,,C,D. Uses default orientation, no check digit, height 50, default line settings, start character C, stop character D.

```zpl
^BK,,50,,,C,D
```

--------------------------------

### ^NS Full Usage Example

Source: https://labelary.com/reference.html

Configures all network settings including IP resolver, IP address, subnet mask, gateway, WINS server, timeout, timeout seconds, ARP broadcast interval, and port.

```zpl
^NSA,192.168.0.100,255.255.255.0,192.168.0.1,192.168.0.10,Y,300,0,9100
```

--------------------------------

### ~JO: Start printhead test (pause on failure)

Source: https://labelary.com/reference.html

Starts a printhead test. The printer will pause if the test fails.

```zpl
~JO
```

--------------------------------

### ~JN: Start printhead test (halt on failure)

Source: https://labelary.com/reference.html

Starts a printhead test. The printer will halt if the test fails.

```zpl
~JN
```

--------------------------------

### ^LF common usage example

Source: https://labelary.com/reference.html

Generates a configuration label containing a list of font links. If the current label already contains content, the configuration label is generated after the current label.

```zpl
^LF
```

--------------------------------

### curl GET request to convert ZPL to PNG

Source: https://labelary.com/service.html

Uses the GET method with --data-urlencode to send ZPL and save the resulting PNG image to label.png.

```bash
curl --get https://api.labelary.com/v1/printers/8dpmm/labels/4x6/0/ --data-urlencode "^xa^cfa,50^fo100,100^fdHello World^fs^xz" > label.png
```

--------------------------------

### ~DY command common usage example

Source: https://labelary.com/reference.html

Example of the ~DY command with typical parameters for uploading an image file. The path is R:IMAGE, format is A (hexadecimal), extension is G (GRF file), totalBytes is 999000, rowBytes is 999, and data is truncated as ABCDEF01234...

```plaintext
~DYR:IMAGE,A,G,999000,999,ABCDEF01234...
```

--------------------------------

### ^SS full usage example

Source: https://labelary.com/reference.html

Configures all ^SS parameters: web, media, ribbon, label length, media LED intensity, ribbon LED intensity, black mark sensor threshold, media black mark sensor threshold, and black mark sensor LED intensity.

```zpl
^SS50,80,70,1800,150,150,70,30,150
```

--------------------------------

### GET /v1/barcodes?mode=standard

Source: https://labelary.com/barcodes/api.html

Encodes data literally as provided. This is the default data mode.

```APIDOC
## GET /v1/barcodes?mode=standard

### Description
Encodes the data value literally as provided. This is the default data mode.

### Method
GET

### Endpoint
/v1/barcodes?mode=standard&data=ABCD

### Parameters
#### Query Parameters
- **mode** (string) - Required - Set to `standard` to use this data mode.
- **data** (string) - Required - The literal string to encode.

### Request Example
https://api.labelary.com/v1/barcodes?mode=standard&data=ABCD

### Response
#### Success Response (200)
- **body** (binary) - The generated barcode image.

#### Response Example
[Binary image data]
```

--------------------------------

### ^WD path - Common Usage

Source: https://labelary.com/reference.html

Prints a directory label listing all files matching the specified path. Wildcards (*, ?) are accepted. Default path is R:\*.\*. This example uses the common usage form.

```zpl
^WDR:\*.\*
```

--------------------------------

### GET /v1/barcodes?mode=gs1

Source: https://labelary.com/barcodes/api.html

Encodes data with GS1 application identifiers using square brackets.

```APIDOC
## GET /v1/barcodes?mode=gs1

### Description
Encodes data using GS1 application identifiers (AIs) enclosed in square brackets. Can be combined with barcode types like code128 or datamatrix.

### Method
GET

### Endpoint
/v1/barcodes?mode=gs1&type=code128&data=[01]12345678901234

### Parameters
#### Query Parameters
- **mode** (string) - Required - Set to `gs1` to use this data mode.
- **type** (string) - Optional - The barcode type (e.g., `code128`, `datamatrix`).
- **data** (string) - Required - The data string with GS1 AIs in square brackets.

### Request Example
https://api.labelary.com/v1/barcodes?mode=gs1&type=code128&data=[01]12345678901234

### Response
#### Success Response (200)
- **body** (binary) - The generated barcode image.

#### Response Example
[Binary image data]
```

--------------------------------

### ^MM mode, prepeel - Full Usage

Source: https://labelary.com/reference.html

Full usage of ^MM command with mode and prepeel parameters. Mode T (tear-off) and prepeel N (do not pre-peel) are defaults.

```zpl
^MMT,N
```

--------------------------------

### GET /v1/barcodes?mode=escaped

Source: https://labelary.com/barcodes/api.html

Encodes data with escape sequences for Unicode characters and FNC1 elements.

```APIDOC
## GET /v1/barcodes?mode=escaped

### Description
Encodes data using escape sequences. Supports `~UHHHH` for Unicode code points and `~FNC1` for FNC1 elements.

### Method
GET

### Endpoint
/v1/barcodes?mode=escaped&data=c~U00F3digo

### Parameters
#### Query Parameters
- **mode** (string) - Required - Set to `escaped` to use this data mode.
- **data** (string) - Required - The data string with escape sequences.

### Request Example
https://api.labelary.com/v1/barcodes?mode=escaped&data=c~U00F3digo

### Response
#### Success Response (200)
- **body** (binary) - The generated barcode image.

#### Response Example
[Binary image data]
```
Tokens:
Raw