Pobierz status zadania druku
Sprawdzaj zadanie CloudPrint, aż osiągnie końcowy status printed, failed albo cancelled.
Działanie metody
Sprawdzaj zadanie CloudPrint, aż osiągnie końcowy status printed, failed albo cancelled.
Uwierzytelnianie
Przekaż krótkotrwały token w Authorization: Bearer <access_token>.
Wymagane uprawnienia: print_jobs:read
Żądanie
Podstawowy adres API: https://public-api.cloudprint.me/api/v1/print-jobs/{printJobId}
Parametry
| Nazwa | Położenie | Typ | Wymagane | Opis | Ograniczenia |
|---|---|---|---|---|---|
printJobId | path | string (uuid) | tak | Stabilny UUID zadania druku wskazanego w ścieżce. | — |
X-Request-Id | header | string | nie | Opcjonalny identyfikator do śledzenia żądania; CloudPrint zwróci bezpieczną wartość w nagłówku odpowiedzi. | maxLength: 128; example: "order-100045-attempt-1" |
Treść żądania
Metoda nie ma treści żądania.
Przykładowe żądania
cURL
bash
curl -sS https://public-api.cloudprint.me/api/v1/print-jobs/55555555-5555-4555-8555-555555555555 \
-H "Authorization: Bearer $ACCESS_TOKEN"Odpowiedź
Status HTTP: 200 — Żądanie zostało wykonane.
Pola odpowiedzi
| Nazwa | Typ | Wymagane | Opis | Ograniczenia |
|---|---|---|---|---|
print_job_id | string (uuid) | tak | Stabilny UUID zadania druku; zapisz go do sprawdzania statusu i obsługi. | — |
document_id | string (uuid) | tak | Stabilny UUID zwracany po pomyślnym przesłaniu dokumentu. | — |
document_mime_type | string | tak | Typ MIME przekazanego dokumentu. | example: "application/pdf" |
document_format | string | tak | Jawny format druku, na przykład pdf albo raw. Oba formaty używają documents:write. | enum: pdf, raw; example: "pdf" |
document_raw_language | string | null | tak | Język poleceń danych RAW, na przykład ZPL lub TSPL. | enum: tspl, zpl, cpcl, escpos; example: null |
printer_id | string (uuid) | tak | Stabilny UUID drukarki docelowej w CloudPrint. | — |
status | string | tak | Bieżący stan zasobu lub procesu; użyj wartości dozwolonych dla danej metody. | enum: pending, reserved, printing, printed, failed, cancelled; example: "pending" |
copies | integer | tak | Liczba kopii, które CloudPrint zleci drukarce. | min: 1; max: 99; example: 1 |
intent | string | tak | Cel biznesowy zadania, używany w diagnostyce i doborze rozsądnych ustawień domyślnych. | enum: document, shipping_label, product_label, invoice, packing_slip, a4_document, receipt; example: "shipping_label" |
color_mode | string | tak | Tryb koloru; default pozostawia wybór konfiguracji drukarki. | enum: default, monochrome, color; example: "default" |
duplex_mode | string | tak | Żądany tryb druku jednostronnego lub dwustronnego. | enum: default, simplex, duplex_long_edge, duplex_short_edge; example: "default" |
media_width_mm | number | null | tak | Żądana szerokość nośnika lub etykiety w milimetrach. | min: 1; max: 2000; example: 58 |
media_height_mm | number | null | tak | Żądana wysokość nośnika lub etykiety w milimetrach. | min: 1; max: 2000; example: 40 |
dpi | integer | null | tak | Docelowa rozdzielczość druku w punktach na cal; użyj wartości obsługiwanej przez drukarkę. | min: 72; max: 2400; example: 203 |
scale_mode | string | tak | Określa, czy zachować rozmiar dokumentu, czy dopasować go do nośnika. | enum: none, fit; example: "none" |
orientation | string | tak | Orientacja strony; default używa ustawień drukarki. | enum: default, portrait, landscape; example: "default" |
offset_x_mm | number | tak | Poziome przesunięcie druku w milimetrach. | min: -2000; max: 2000; example: 0 |
offset_y_mm | number | tak | Pionowe przesunięcie druku w milimetrach. | min: -2000; max: 2000; example: 0 |
margin_top_mm | number | tak | Dodatkowy margines druku w milimetrach. | min: 0; max: 2000; example: 0 |
margin_right_mm | number | tak | Dodatkowy margines druku w milimetrach. | min: 0; max: 2000; example: 0 |
margin_bottom_mm | number | tak | Dodatkowy margines druku w milimetrach. | min: 0; max: 2000; example: 0 |
margin_left_mm | number | tak | Dodatkowy margines druku w milimetrach. | min: 0; max: 2000; example: 0 |
created_at | string (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
reserved_at | string | null (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
started_at | string | null (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
completed_at | string | null (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
failure_reason | string | null | tak | Maszynowo czytelna lub diagnostyczna przyczyna nieudanego druku. | — |
Przykładowa odpowiedź
json
{
"print_job_id": "11111111-1111-4111-8111-111111111111",
"document_id": "11111111-1111-4111-8111-111111111111",
"document_mime_type": "application/pdf",
"document_format": "pdf",
"document_raw_language": null,
"printer_id": "11111111-1111-4111-8111-111111111111",
"status": "pending",
"copies": 1,
"intent": "shipping_label",
"color_mode": "default",
"duplex_mode": "default",
"media_width_mm": 58,
"media_height_mm": 40,
"dpi": 203,
"scale_mode": "none",
"orientation": "default",
"offset_x_mm": 0,
"offset_y_mm": 0,
"margin_top_mm": 0,
"margin_right_mm": 0,
"margin_bottom_mm": 0,
"margin_left_mm": 0,
"created_at": "2026-08-06T12:00:00Z",
"reserved_at": "2026-08-06T12:00:00Z",
"started_at": "2026-08-06T12:00:00Z",
"completed_at": "2026-08-06T12:00:00Z",
"failure_reason": "string"
}Błędy
| Status HTTP | Opis |
|---|---|
401 | Brak uwierzytelnienia albo jest ono nieprawidłowe. |
403 | Brak uprawnień wymaganych do tej operacji. |
404 | Nie znaleziono żądanego zasobu. |
422 | Pola żądania nie przeszły walidacji. |
429 | Przekroczono limit żądań; zastosuj Retry-After. |
500 | Wewnętrzny błąd CloudPrint. |
Wskazówki integracyjne
- Sprawdzaj stan w rozsądnych odstępach i zakończ po statusie
printed,failedalbocancelled. - Zapisuj
failure_reason,print_job_idiX-Request-Iddla wsparcia. - Nie twórz nowego zadania tylko dlatego, że jedno żądanie statusu przekroczyło limit czasu.
Powiązana dokumentacja
Utwórz zadanie drukuWyślij przesłany dokument CloudPrint na wybraną drukarkę z idempotencją i jawnymi opcjami.Pobierz listę zadań drukuPobierz ostatnie zadania CloudPrint z paginacją kursorową dla ekranów operacyjnych i wsparcia.Diagnostyka agentów, drukarek i zadańZnajdź przyczynę problemu na podstawie identyfikatora żądania, statusu zadania, połączenia agenta, możliwości drukarki i kodu API.