Interfaces

targetOrder

OrderObject

Resulting order object

combinedOrders

OrderObject[]

An array of combined (and then deleted) orders, that does not include the above resulting order.

item

OrderItem

An order item object

quantity

number

Quantity to split

item

OrderItem

An order item object

quantity

number

Quantity to split

jobType

PRINT_JOB_TYPES

Type of receipt to print

printingType

RECEIPT_PRINTING_TY PE

Optional, whom to address the receipt. Default: customer

fiscal_info

FiscalPrintPayload

Optional, fiscal data to include on the receipt

cash_total

number

Optional, cash total to print on the receipt

loyaltyInfo

LoyaltyPrintData

Optional, loyalty information to print on the receipt

merchantPayments

Payment[]

Optional, payments to print on the Merchant Card Payment receipt

print_rounding_adjustment

boolean

Optional, include rounding adjustment. Default: false

receipt_date_time

string

Optional, print customized time on the receipt. Default: current, local time.

rounding_adjustment

string

Optional, rounding adjustment to print on the receipt

is_online_order

boolean

Optional, determines if receipt is for an incoming online order. Default: false

external_data

unknown

Optional, other day to include in the print request

item

OrderItem

An order item object

quantity

number

Quantity to split

item

OrderItem

An order item object

quantity

number

Quantity to split

message

string

Optional notification message

button

string

Optional button text. Default: Ok

title

string

Optional window title. Default: title not displayed

contentTitle

string

Optional content title. Default: content title not displayed

contentAlign

string

Optional content align. Default: content-centered

Other values: content-aligned-left, content-centered, content-aligned-right

item

OrderItem

An order item object

quantity

number

Quantity to split

item

OrderItem

An order item object

quantity

number

Quantity to split

printOrder

IPrintOrder

Overrides receipt functionality for print order

order

OrderObject

An order object

payment

PaymentObject

A payment object

content

string

Optional, custom receipt template. Otherwise default template used.

jobType

PRINT_JOB_TYPES

Optional, print receipt type

template

PRINT_JOB_TYPES

Optional, template type for receipt

cancelJob

dropConnection

getBrand

getStatus

openDrawer

printJob

printText

printTest

registerTransaction

data

any

Optional, data provided as a payload for the print request

command

PrintingCommand

Specific print command for the receipt printer to execute

config

PrinterJobConfig

Optional, print job configuration

site_info

Record<string, string>

Optional, site info to include

text

string

Optional, text to include

destination

string

Receipt printer name

order

OrderObject

An order object, for which a printed receipt is requested

copyNumber

number

Number of printing copy

data

PrintPayload

The payload for

Cash_Pull

Closed_Drawer_Report

Drawer_Audit_Report

Employee_Audit_Report

End_Of_Day_Report

Final_Receipt_TSR

Gift_Balance

Guest_Check

Kitchen

Item_Label

Merchant_Card_Payment

Merchant_Card_Declined_Payment

No_Sale

Paid_In_Out

Pay_Tips_Report

Punch_In

Punch_In_Detail

Punch_Out

Punch_Out_Detail

Raw_Report

Receipt

Refund

Report

Void

Waste

item

OrderItem

An order item object

quantity

number

Quantity to split

bufferSize

number

(Optional)

name

string

(Optional)

persistent

number

(Optional)

order

OrderObject

An order object, from which order items were moved (sourceOrder)

segments

{ [segmentId: string]: SplitDataBySegment}

Information about split items by segments

segment

OrderSegment

A order segment object

items

{ [orderItemId: string]: splitItemData}

Information about split items

isFullSegment

boolean

true - all items from the segment selected for move/share;

false - not all items from the segment selected for move/share

item

OrderItem

An order item object

quantity

number

Quantity to split

targetOrder

OrderObject

An order object, to where items were moved/shared

sourceOrder

OrderObject

An order object, from where items were moved/shared

splitData

SplitData

Information about moved/shared items

message

string

Confirmation message

title

string

Optional window title. Default: title not displayed

okButton

string

Optional 'acknowledge' button text. Default: Ok

cancelButton

string

Optional 'cancel' button text. Default: Cancel