Print Templates

Server

Download schema

Print template management for receipts and tickets

Get location print settings

GET

https://common-api.karma.life

/api/v1/locations/{locationId}/print-settings

Get print settings for a specific location

Get location print settings › path Parameters

locationId

number · required

Get location print settings › Responses

Default Response

status

string

object

Save location print settings

PUT

https://common-api.karma.life

/api/v1/locations/{locationId}/print-settings

Create or update print settings for a location

Save location print settings › path Parameters

locationId

number · required

Save location print settings › Request Body

fontSize

number | null · min: 1 · max: 4

fontFamily

string | null · enum

Enum values:

lineSpacing

number | null · min: 1 · max: 5

logoUrl

string | null

headerText

string | null

footerText

string | null

showLogo

boolean | null

printQrCode

boolean | null

printVatBreakdown

boolean | null

kitchenTicketBeep

boolean | null

language

string | null

Save location print settings › Responses

Default Response

status

string

object

PUT/api/v1/locations/{locationId}/print-settings

curl --request PUT \
  --url https://common-api.karma.life/api/v1/locations/:locationId/print-settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "fontSize": 1,
  "fontFamily": "a",
  "lineSpacing": 1,
  "logoUrl": "logoUrl",
  "headerText": "headerText",
  "footerText": "footerText",
  "showLogo": true,
  "printQrCode": true,
  "printVatBreakdown": true,
  "kitchenTicketBeep": true,
  "language": "language"
}
'

Example Request Body

{
  "fontSize": 1,
  "fontFamily": "a",
  "lineSpacing": 1,
  "logoUrl": "logoUrl",
  "headerText": "headerText",
  "footerText": "footerText",
  "showLogo": true,
  "printQrCode": true,
  "printVatBreakdown": true,
  "kitchenTicketBeep": true,
  "language": "language"
}

json

Example Responses

No example specified for this content type

application/json

Delete location print settings

DELETE

https://common-api.karma.life

/api/v1/locations/{locationId}/print-settings

Delete print settings for a location (reset to defaults)

Delete location print settings › path Parameters

locationId

number · required

Delete location print settings › Responses

Default Response

status

string

object

List location template overrides

GET

https://common-api.karma.life

/api/v1/locations/{locationId}/template-overrides

Get all template overrides for a specific location

List location template overrides › path Parameters

locationId

number · required

List location template overrides › Responses

Default Response

status

string

object

Get location template override

GET

https://common-api.karma.life

/api/v1/locations/{locationId}/template-overrides/{templateType}

Get a specific template override for a location

Get location template override › path Parameters

locationId

number · required

templateType

string · enum · required

Enum values:

kitchen_ticket

purchase_receipt

pre_check

order_confirmation

custom

Get location template override › Responses

Default Response

status

string

object

Save location template override

PUT

https://common-api.karma.life

/api/v1/locations/{locationId}/template-overrides/{templateType}

Create or update a template override for a location

Save location template override › path Parameters

locationId

number · required

templateType

string · enum · required

Enum values:

kitchen_ticket

purchase_receipt

pre_check

order_confirmation

custom

Save location template override › Request Body

overrideScope

string · enum · required

Enum values:

full

section

settings

object | null

Save location template override › Responses

Default Response

status

string

object

List print templates

GET

https://common-api.karma.life

/api/v1/print-templates

Get a list of all print templates with optional filtering

List print templates › query Parameters

type

string · enum

Filter by template type

Enum values:

kitchen_ticket

purchase_receipt

pre_check

order_confirmation

custom

isActive

boolean

Filter by active status

isSystem

boolean

Filter by system template status

limit

number · min: 1 · max: 100

Default: 50

offset

number · min: 0

Default: 0

List print templates › Responses

Default Response

status

string

object

Create print template

POST

https://common-api.karma.life

/api/v1/print-templates

Create a new custom print template

Create print template › Request Body

type

string · enum · required

Enum values:

kitchen_ticket

purchase_receipt

pre_check

order_confirmation

custom

name

string · minLength: 1 · maxLength: 100 · required

object · required

description

string · maxLength: 500

Create print template › Responses

Default Response

status

string

object

Get print template

GET

https://common-api.karma.life

/api/v1/print-templates/{id}

Get a single print template by ID

Get print template › path Parameters

id

string · uuid · required

Get print template › Responses

Default Response

status

string

object

Delete print template

DELETE

https://common-api.karma.life

/api/v1/print-templates/{id}

Delete a custom print template (system templates cannot be deleted)

Delete print template › path Parameters

id

string · uuid · required

Delete print template › Responses

Default Response

status

string

object

Update print template

PATCH

https://common-api.karma.life

/api/v1/print-templates/{id}

Update an existing custom print template (system templates cannot be modified)

Update print template › path Parameters

id

string · uuid · required

Update print template › Request Body

name

string · minLength: 1 · maxLength: 100

description

string · maxLength: 500

object

isActive

boolean

Update print template › Responses

Default Response

status

string

object

Get active print template by type

GET

https://common-api.karma.life

/api/v1/print-templates/type/{type}

Get the currently active print template for a specific type

Get active print template by type › path Parameters

type

string · enum · required

Enum values:

kitchen_ticket

purchase_receipt

pre_check

order_confirmation

custom

Get active print template by type › Responses

Default Response

status

string

object

Delete location template override

DELETE

https://common-api.karma.life

/api/v1/template-overrides/{id}

Delete a template override for a location

Delete location template override › path Parameters

id

string · uuid · required

Delete location template override › Responses

Default Response

status

string

object

Update location template override

PATCH

https://common-api.karma.life

/api/v1/template-overrides/{id}

Update an existing template override

Update location template override › path Parameters

id

string · uuid · required

Update location template override › Request Body

overrideScope

string · enum

Enum values:

full

section

settings

object | null

isActive

boolean

Update location template override › Responses

Default Response

status

string

object

Webhook: Print template created

POST

https://common-api.karma.life

/webhook/print_template.created

Fired when a new print template is created. Full template fields are emitted.

This is an outbound webhook event. Karma POSTs this payload to the URL you registered via POST /api/v1/webhooks/subscriptions. Your endpoint should respond 2xx within 30 seconds to acknowledge delivery.

Webhook: Print template created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

print_template.created

resource

string · enum · required

Enum values:

print_template

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Print template created › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/print_template.created

curl --request POST \
  --url https://common-api.karma.life/webhook/print_template.created \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "print_template.created",
  "resource": "print_template",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "kitchen_ticket",
    "name": "name",
    "description": "description",
    "version": 0,
    "isActive": true,
    "isSystem": true,
    "content": {},
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "createdBy": 0
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "print_template.created",
  "resource": "print_template",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "kitchen_ticket",
    "name": "name",
    "description": "description",
    "version": 0,
    "isActive": true,
    "isSystem": true,
    "content": {},
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "createdBy": 0
  }
}

json

Example Responses

No example specified for this content type

Webhook: Print template updated

POST

https://common-api.karma.life

/webhook/print_template.updated

Updated fields are emitted.

Webhook: Print template updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

print_template.updated

resource

string · enum · required

Enum values:

print_template

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Partial object — only fields that changed are included. Merge with previously cached template.

Webhook: Print template updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/print_template.updated

curl --request POST \
  --url https://common-api.karma.life/webhook/print_template.updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "print_template.updated",
  "resource": "print_template",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "name": "name",
    "description": "description",
    "content": {},
    "isActive": true,
    "version": 0
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "print_template.updated",
  "resource": "print_template",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "name": "name",
    "description": "description",
    "content": {},
    "isActive": true,
    "version": 0
  }
}

json

Example Responses

No example specified for this content type

Webhook: Print template deleted

POST

https://common-api.karma.life

/webhook/print_template.deleted

Minimal payload — just the template ID.

Webhook: Print template deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

print_template.deleted

resource

string · enum · required

Enum values:

print_template

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Print template deleted › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Location print settings updated

POST

https://common-api.karma.life

/webhook/location_print_settings.updated

Fired when a location's print settings are changed.

Webhook: Location print settings updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_print_settings.updated

resource

string · enum · required

Enum values:

location_print_settings

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Location print settings updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/location_print_settings.updated

curl --request POST \
  --url https://common-api.karma.life/webhook/location_print_settings.updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "location_print_settings.updated",
  "resource": "location_print_settings",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "fontSize": 0,
    "fontFamily": "fontFamily",
    "lineSpacing": 0,
    "logoUrl": "https://www.example.com/path/to/resource",
    "headerText": "headerText",
    "footerText": "footerText",
    "showLogo": true,
    "printQrCode": true,
    "printVatBreakdown": true,
    "kitchenTicketBeep": true,
    "language": "language",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "location_print_settings.updated",
  "resource": "location_print_settings",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "fontSize": 0,
    "fontFamily": "fontFamily",
    "lineSpacing": 0,
    "logoUrl": "https://www.example.com/path/to/resource",
    "headerText": "headerText",
    "footerText": "footerText",
    "showLogo": true,
    "printQrCode": true,
    "printVatBreakdown": true,
    "kitchenTicketBeep": true,
    "language": "language",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Location template override updated

POST

https://common-api.karma.life

/webhook/location_template_override.updated

Fired when a location-specific template override is changed.

Webhook: Location template override updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_template_override.updated

resource

string · enum · required

Enum values:

location_template_override

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Partial object — only fields that changed are included.

Webhook: Location template override updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/location_template_override.updated

curl --request POST \
  --url https://common-api.karma.life/webhook/location_template_override.updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "location_template_override.updated",
  "resource": "location_template_override",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "overrideScope": "full",
    "customTemplateContent": {},
    "sectionOverrides": {},
    "settingsOverrides": {},
    "isActive": true
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "location_template_override.updated",
  "resource": "location_template_override",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "overrideScope": "full",
    "customTemplateContent": {},
    "sectionOverrides": {},
    "settingsOverrides": {},
    "isActive": true
  }
}

json

Example Responses

No example specified for this content type

Permissions Printers