Skip to main content
POST
/
api
/
storage_units
/
{id}
/
pick_label
Print a pick label for a storage unit
curl --request POST \
  --url https://clarus-api.com/api/storage_units/{id}/pick_label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "storage_units",
    "attributes": {
      "cloud_print": true,
      "printer_id": 1,
      "quantity": 2,
      "task_id": 789
    }
  }
}
'
{
  "data": {
    "id": 1,
    "type": "documents",
    "attributes": {
      "status": "processing"
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "storage_units",
    "attributes": {
      "cloud_print": true,
      "printer_id": 1,
      "quantity": 2,
      "task_id": 789
    }
  }
}

​
Key Fields

FieldRequiredDescription
cloud_printNoWhen true, sends to printer via PrintNode instead of returning PDF
printer_idNoPrintNode printer ID (required when cloud_print is true)
quantityNoNumber of copies to print
task_idNoAssociated task ID for context on the label

​
Response Behavior

  • With cloud_print: true: Returns JSON acknowledgement that the print job was sent
  • Without cloud_print: Returns a PDF binary stream (application/pdf)

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the storage unit

Body

application/json
​
data
object

Response

Label print job created successfully (when cloud_print is true) or PDF binary stream (when cloud_print is false)

​
data
object