Hold or release a package
Create a notice on a package to hold or release it.
Send `action: "hold"` to hold the package at the warehouse, or `action: "release"` to release it for delivery.
Internally, `hold` is recorded as a warning notice and `release` is recorded as an info notice.
Each call records a Notice for audit trail and updates the package's hold instruction accordingly.
The response returns only the notice action result, not the full package payload.
Authentication
X-Api-Keystring
API Key authentication via header
Path parameters
id
Parcel token
Request
This endpoint expects an object.
action
hold maps to a warning notice; release maps to an info notice
body
Optional description of the notice
Response
Created
parcel_id
Package token affected by the notice action.
action
Action applied to the package.
hold_instruction
Current hold state after the action.
hold_released_at
Set when the package has been released.
notice
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error