API Endpoint Reference / Print Jobs

Request Stop for one exact active print attempt

POST https://api.printhiv3d.com/v1/print-jobs/{id}/stop

Operation ID stopPrintJob. Requires the dangerous API key scope.

Parameters

NameInTypeRequiredDescription
idpathintegerYes

Request body

Content type application/json.

FieldTypeRequiredDescription
receiptIduuidYes
startAttemptIduuidYes

Responses

StatusDescription
200Default Response
403Default Response
404Default Response
409Default Response
503Default Response

200 response fields

FieldTypeRequiredDescription
iduuidYes
job_idintegerYes
printer_iduuidYes
start_attempt_iduuidYes
claim_generationuuidYes
expected_device_task_idstringYes
command_outcome"unknown" | "acknowledged" | "rejected" | "not_delivered"Yes
confirmation"pending" | "confirmed" | "unconfirmed" | "rejected" | "already_ended" | "unsupported"Yes
requested_atdate-timeYes
deadline_atdate-timeYes
confirmed_atdate-time | nullYes
abort_acknowledgedbooleanNo
reason"printer_family_unsupported" | "job_already_ended"Yes
printerFamilystring | nullYes
jobStatusstringYes
messagestring | nullYes

403 response fields

FieldTypeRequiredDescription
errorstringYes
codestringNo
messagestringNo
requestIdstringNo

404 response fields

FieldTypeRequiredDescription
error"print_job_not_found" | "print_job_terminal" | "queued_cancel_conflict" | "queued_cancel_unavailable" | "stop_attempt_conflict" | "stop_identity_conflict" | "stop_job_terminal" | "stop_not_delivered" | "stop_not_ready" | "stop_receipt_not_found" | "stop_transport_unknown" | "stop_unavailable" | "stop_unsupported"Yes
reasonstringYes
messagestringYes
jobStatusstring | nullNo
printerFamilystring | nullNo

409 response fields

FieldTypeRequiredDescription
error"print_job_not_found" | "print_job_terminal" | "queued_cancel_conflict" | "queued_cancel_unavailable" | "stop_attempt_conflict" | "stop_identity_conflict" | "stop_job_terminal" | "stop_not_delivered" | "stop_not_ready" | "stop_receipt_not_found" | "stop_transport_unknown" | "stop_unavailable" | "stop_unsupported"Yes
reasonstringYes
messagestringYes
jobStatusstring | nullNo
printerFamilystring | nullNo

503 response fields

FieldTypeRequiredDescription
error"print_job_not_found" | "print_job_terminal" | "queued_cancel_conflict" | "queued_cancel_unavailable" | "stop_attempt_conflict" | "stop_identity_conflict" | "stop_job_terminal" | "stop_not_delivered" | "stop_not_ready" | "stop_receipt_not_found" | "stop_transport_unknown" | "stop_unavailable" | "stop_unsupported"Yes
reasonstringYes
messagestringYes
jobStatusstring | nullNo
printerFamilystring | nullNo

Example 200 response

{
  "id": "c7e2a4f9-3b1d-4e86-9a5c-0f8d2b6e4a13",
  "job_id": 48213,
  "printer_id": "7d3f1c2a-5b8e-4f6a-9c1d-2e4b6a8c0f13",
  "start_attempt_id": "8b4d1f6a-2c9e-4a37-b5e0-7d3c9a1f2e64",
  "claim_generation": "4e9a2c7d-6f1b-4d58-a3e0-1b7c5d9f8a26",
  "expected_device_task_id": "912345678",
  "command_outcome": "acknowledged",
  "confirmation": "pending",
  "requested_at": "2026-11-04T18:00:00.000Z",
  "deadline_at": "2026-11-04T18:02:00.000Z",
  "confirmed_at": null,
  "abort_acknowledged": true,
  "reason": null,
  "printerFamily": "P1",
  "jobStatus": "PRINTING",
  "message": null
}