Open Inventory / Docs
EndpointsLabel printingLabel print agentClaim

Claim the next job for a printer

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

POST
/label-print-agent/claim

Windows agent endpoint; use the dedicated iprt_ credential, not an inventory API token. Reuse claimId to recover the same claim. Stale claims become uncertain after five minutes and are never handed out again. History cleanup runs on polling after seven days.

Authorization

printAgent
headerAuthorizationBearer <iprt_ token>

Dedicated printer credential issued once by POST /label-printers. Only valid for agent claim and acknowledgement.

Request Body

application/json
  1. body
claimId*string
Formatuuid

Response Body

Claimed RAW data or null when no job is available.

application/json
  1. response
job*|null
Example Request
curl -X POST 'https://inventory.example.com/api/v1/label-print-agent/claim' \  -H 'Content-Type: application/json' \  -d '{  "claimId": "88057929-7728-4a26-8396-f965dcc8b947"}'
Example Response
{  "job": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "data": "string",    "sha256": "string"  }}

Acknowledge a printer claim POST

Agent only. Report submitted after Windows accepts the RAW job, failed after a definite failure, or uncertain if acceptance is ambiguous. The receipt clears the stored payload. It does not prove physical printing.

Cancel one of your waiting print jobs DELETE

Requires a browser session with labels.read. Only a queued job owned by the caller can be cancelled.