CloudPrint Documentation/API reference

Idempotent print-job creation

Prevent duplicate physical prints when retrying CloudPrint print-job requests after a timeout or network failure.

API version: v1Download OpenAPI v1 JSONOpen in the interactive API ExplorerView as Markdown

Why printing needs idempotency

A timeout can happen after CloudPrint accepted the request but before your backend received the response. Creating a new job at that point can print the same label or document twice.

Key design

Build a stable key from the business operation, such as shipment-18451-label-v1. Keep it opaque, at most 128 characters and identical for retries of the same payload. An intentional reprint is a new operation and needs a new key.

Reuse rules

The same account, key and payload return the original result. Reusing the key with a different payload returns 409 Conflict. Persist the key before the first request so a worker restart does not generate a replacement.

Recovery after uncertainty

After a network failure, retry the same create request with the same key. Once a print_job_id is known, persist it and read job status instead of creating another job.

Related documentation

Create a print jobSend an uploaded CloudPrint document to a selected printer with idempotency and explicit print options.CloudPrint API errors and retriesHandle CloudPrint API status codes, machine-readable errors, rate limits, request tracing and safe retry decisions.Create and track CloudPrint print jobsCreate idempotent print jobs, validate printer options and follow each job safely until it is printed or fails.

OpenAPIOpen accountPrivacy PolicyTermsPayment and refundsDPA