Skip to content

PharmaFlow Knowledgebase

Register a printer

Admin only. Registers a browser printer for a branch, defaulting when the branch has none. Only browser printing is supported, so a device_path is refused and copies must be 1 to 20.

POST/api/v1/printing/printers

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Request body

requiredapplication/json

branch_idstring

namestringrequired

kindstring

connectionstring

device_pathstring

copiesnumber

is_defaultboolean

auto_printboolean

kick_drawerboolean

Responses

201

Printer registered

idstringrequired

branch_idstringrequired

namestringrequired

kindstringrequired

connectionstringrequired

device_pathstringrequired

is_defaultintegerrequired

min -9007199254740991 · max 9007199254740991

copiesintegerrequired

min -9007199254740991 · max 9007199254740991

auto_printintegerrequired

min -9007199254740991 · max 9007199254740991

kick_drawerintegerrequired

min -9007199254740991 · max 9007199254740991

is_activeintegerrequired

min -9007199254740991 · max 9007199254740991

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

created_atstringrequired

updated_atstringrequired

400

Printer name is empty, a device path is set, the kind or connection is unsupported, or copies is not an integer between 1 and 20

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin, or the branch is outside your ownership

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

branch_idstringnamestring*kindstringconnectionstringdevice_pathstringcopiesnumberis_defaultbooleanauto_printbooleankick_drawerboolean

Request

curl -X POST 'http://localhost:8000/api/v1/printing/printers' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "branch_id": "string",
  "name": "string",
  "kind": "string",
  "connection": "string",
  "device_path": "string",
  "copies": 0,
  "is_default": true,
  "auto_print": true,
  "kick_drawer": true
}'

const response = await fetch("http://localhost:8000/api/v1/printing/printers", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"branch_id\": \"string\",\n  \"name\": \"string\",\n  \"kind\": \"string\",\n  \"connection\": \"string\",\n  \"device_path\": \"string\",\n  \"copies\": 0,\n  \"is_default\": true,\n  \"auto_print\": true,\n  \"kick_drawer\": true\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/printing/printers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"branch_id\": \"string\",\n  \"name\": \"string\",\n  \"kind\": \"string\",\n  \"connection\": \"string\",\n  \"device_path\": \"string\",\n  \"copies\": 0,\n  \"is_default\": true,\n  \"auto_print\": true,\n  \"kick_drawer\": true\n}",
)

Response

{
  "id": "string",
  "branch_id": "string",
  "name": "string",
  "kind": "string",
  "connection": "string",
  "device_path": "string",
  "is_default": -9007199254740991,
  "copies": -9007199254740991,
  "auto_print": -9007199254740991,
  "kick_drawer": -9007199254740991,
  "is_active": -9007199254740991,
  "is_deleted": -9007199254740991,
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}