curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"printer_name": "<string>",
"payload_base64": "<string>",
"payload_text": "<string>",
"copies": 5,
"metadata": {}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs"
payload = {
"printer_name": "<string>",
"payload_base64": "<string>",
"payload_text": "<string>",
"copies": 5,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
printer_name: '<string>',
payload_base64: '<string>',
payload_text: '<string>',
copies: 5,
metadata: {}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'printer_name' => '<string>',
'payload_base64' => '<string>',
'payload_text' => '<string>',
'copies' => 5,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs"
payload := strings.NewReader("{\n \"printer_name\": \"<string>\",\n \"payload_base64\": \"<string>\",\n \"payload_text\": \"<string>\",\n \"copies\": 5,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"printer_name\": \"<string>\",\n \"payload_base64\": \"<string>\",\n \"payload_text\": \"<string>\",\n \"copies\": 5,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"printer_name\": \"<string>\",\n \"payload_base64\": \"<string>\",\n \"payload_text\": \"<string>\",\n \"copies\": 5,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"station_id": "<string>",
"status": "<string>",
"kind": "<string>",
"format": "<string>",
"printer_name": "<string>",
"copies": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"available_printers": [
"<string>"
]
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"error": "<string>"
}{
"message": "<string>",
"errors": {}
}Enqueue a print job
Enqueue a print job to a paired, non-revoked print station. The station’s agent picks it up on its next long-poll. Provide the payload as payload_base64 (binary/PDF bytes) or payload_text (raw ZPL command stream) — exactly one is required. If printer_name is supplied it must match a printer available on the station.
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"printer_name": "<string>",
"payload_base64": "<string>",
"payload_text": "<string>",
"copies": 5,
"metadata": {}
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs"
payload = {
"printer_name": "<string>",
"payload_base64": "<string>",
"payload_text": "<string>",
"copies": 5,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
printer_name: '<string>',
payload_base64: '<string>',
payload_text: '<string>',
copies: 5,
metadata: {}
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'printer_name' => '<string>',
'payload_base64' => '<string>',
'payload_text' => '<string>',
'copies' => 5,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs"
payload := strings.NewReader("{\n \"printer_name\": \"<string>\",\n \"payload_base64\": \"<string>\",\n \"payload_text\": \"<string>\",\n \"copies\": 5,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"printer_name\": \"<string>\",\n \"payload_base64\": \"<string>\",\n \"payload_text\": \"<string>\",\n \"copies\": 5,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/print-stations/{stationId}/print-jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"printer_name\": \"<string>\",\n \"payload_base64\": \"<string>\",\n \"payload_text\": \"<string>\",\n \"copies\": 5,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"station_id": "<string>",
"status": "<string>",
"kind": "<string>",
"format": "<string>",
"printer_name": "<string>",
"copies": 123,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"available_printers": [
"<string>"
]
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"error": "<string>"
}{
"message": "<string>",
"errors": {}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
ID of the target print station.
Body
Payload format.
zpl, pdf Job kind. Defaults to raw.
shipping_label, packing_slip, raw Target printer name. Must match a printer available on the station; omit to use the station default.
Base64-encoded payload (binary/PDF bytes). Required when payload_text is not provided.
Raw text payload (e.g. a ZPL command stream). Required when payload_base64 is not provided.
Number of copies to print. Defaults to 1.
1 <= x <= 10Arbitrary metadata echoed back on the job.
Response
Print job enqueued
Show child attributes
Show child attributes