Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
PRINT

Get a print event by its ID

Returns the PrintOrder associated with the specified eventId. A complete response, which contains the printing device, print category, and job state, is returned If the state of the print event is CREATED, PRINTING, or FAILED. Once the job is successfully printed, it is discarded and cannot be replayed.

get/v3/merchants/{mId}/print_event/{eventId}

Path parameters

mIdstring required

Merchant Id

eventIdstring required

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

idstring

Unique identifier

category'ORDER' | 'RECEIPT' | 'FISCAL' | 'LABEL' | 'TEST_PRINT'

The print category

state'CREATED' | 'PRINTING' | 'FAILED' | 'DONE'

print event state

orderSnapshotstring

Snapshot of the order at the time of print request

createdTimeinteger

Timestamp when the print event was created

modifiedTimeinteger

Timestamp when the print event was last modified

deletedTimeinteger

Timestamp when the print event was last deleted

printTimeinteger

Timestamp when the print event needs to fire to printer