Branding Settings
Get Branding Settings
curl -X GET "http://localhost:8080/api/v1/settings/branding" \
-H "Authorization: Bearer YOUR_TOKEN"
Response
Show BrandingSettingsResponse
URL to the application logo image
Footer text displayed in the application
Primary theme color (hex format)
Dark mode theme color (hex format)
Roles
Accessible by: admin, manager, cashier
Update Branding Settings
curl -X PUT "http://localhost:8080/api/v1/settings/branding" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"app_name": "My POS System",
"app_logo": "https://example.com/logo.png",
"footer_text": "© 2024 My Company",
"theme_color": "#3B82F6",
"theme_color_dark": "#1E40AF"
}'
Request Body
Application name (3-100 characters)
URL to the application logo
Footer text (max 200 characters)
Primary theme color in hex format (e.g., #3B82F6)
Dark mode theme color in hex format
Roles
Accessible by: admin only
Update App Logo
curl -X POST "http://localhost:8080/api/v1/settings/branding/logo" \
-H "Authorization: Bearer YOUR_TOKEN" \
-F "logo=@/path/to/logo.png"
Logo image file (max 5MB, image formats only)
Response
Roles
Accessible by: admin only
Printer Settings
Get Printer Settings
curl -X GET "http://localhost:8080/api/v1/settings/printer" \
-H "Authorization: Bearer YOUR_TOKEN"
Response
Show PrinterSettingsResponse
Printer connection string or IP address
Paper width: 58mm or 80mm
Whether to automatically print receipts
Print method: BE (Backend) or FE (Frontend)
Roles
Accessible by: admin, manager, cashier
Update Printer Settings
curl -X PUT "http://localhost:8080/api/v1/settings/printer" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"connection": "192.168.1.100",
"paper_width": "80mm",
"auto_print": true,
"print_method": "BE"
}'
Request Body
Printer connection string, IP address, or device path
Paper width: 58mm or 80mm
Enable/disable automatic printing of receipts
Print method:
BE - Backend printing (server sends to printer)FE - Frontend printing (client browser prints)
Roles
Accessible by: admin only
Test Printer Connection
curl -X POST "http://localhost:8080/api/v1/settings/printer/test" \
-H "Authorization: Bearer YOUR_TOKEN"
Roles
Accessible by: admin only
Make sure the printer is connected and powered on before testing. The test will print a sample receipt to verify the connection.