v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
DEVICE

Print an image

Sends an image print job to a Clover device.

post/v1/device/print/image

Headers

User-Agentstring required

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

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Idempotency-Keystring

The idempotency key transmitted during the request, if any.

Request body

imagestring

Base-64 encoded image data

printDeviceIdstring

An id obtained from the list of ids in the retrieve printers call, or null for default.

printJobIdstring

A unique id for the request

Response

A PrintImageResponse from a Clover device.

printJobIdstring

The requestId

status'IN_QUEUE' | 'PRINTING' | 'DONE' | 'ERROR' | 'UNKNOWN' | 'NOT_FOUND'