Print APIs

The Print APIs (api.print) provide access to printer functionality.

getDefaultPrinterName

A public method that provides the configured printer name.

Method	`public getDefaultPrinterName(): string \| null`
Parameters	None
Returns	`name: string \| null` Returns `name` of printer or `null` if printer name is not configured.

Prints an order receipt of a given type. Uses embedded printing templates for generated receipts.

Method

printOrder(order, extraPrintData): void;

Parameters

Name	Type	Description
`order`	OrderObject	An order object
`extraPrintData`	ExtraPrintData	Additional printing parameters

Returns

void

This method does not wait for the process to complete.

Provides the ability to execute different print jobs on the assigned primary receipt printer.

Method

executeOnPrimaryPrinter(params: PrintJobWithPayload): void

Parameters

Name	Type	Description
`params`	PrintJobWithPayload	Print parameters and payload

Returns

void - Does not wait for completion of print request.

Printing request utility method that calculates extraPrintData for printOrder method.

Method

getExtraPrintDataForOrder(order: OrderObject): ExtraPrintData

Parameters

Name	Type	Description
`order`	OrderObject	An order object

Returns

ExtraPrintData