Open Inventory / Docs
EndpointsLabel printingLabel print agentAck

Acknowledge a printer claim

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/ack

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.

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
id*string
Formatuuid
claimId*string
Formatuuid
status*string
Value in"submitted""failed""uncertain"
spoolJobId?|
Defaultnull

Response Body

Receipt recorded.

application/json
  1. response
ok*boolean
Example Request
curl -X POST 'https://inventory.example.com/api/v1/label-print-agent/ack' \  -H 'Content-Type: application/json' \  -d '{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "claimId": "88057929-7728-4a26-8396-f965dcc8b947",  "status": "submitted"}'
Example Response
{  "ok": true}

Create or pin a manual relationship POST

One endpoint must match the resource id in the path. Containment relationships reject invalid parents, self-reference, and direct or indirect cycles. Creating an existing spatial relationship converts it to a manual relationship.

Claim the next job for a printer POST

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.