Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Link sold devices to your customers
devices:inventory
Use these endpoints from your own app when a customer claims a device you sold. A device must be marked for sale in the dashboard before it can be bound.
GET /api/v1/workspaces/{workspace_id}/device-inventory/by-code/{claim_code}
{
"data": {
"device_id": "8f0c...",
"name": "Unit-042",
"claim_code": "K7Q2-9XMA",
"sale_state": "in_stock",
"bound": false
}
}
sale_state is unlisted, in_stock, bound, or scrapped.
POST /api/v1/devices/{device_id}/hardware-bind
Content-Type: application/json
{
"name": "Budi Santoso",
"email": "budi@example.com",
"phone": "+628123456789",
"ref": "customer-1029",
"note": "Online order #5521"
}
ref for your own customer ID.
{
"message": "Device bound to owner",
"device": { "id": "8f0c...", "sale_state": "in_stock", "bound": true },
"binding": {
"id": "b51e...",
"bound_name": "Budi Santoso",
"bound_ref": "customer-1029",
"bound_at": "2026-10-28T03:15:00Z",
"status": "active"
}
}
POST /api/v1/devices/{device_id}/hardware-transfer
reason. Closes the current owner and binds the new one in one step.
POST /api/v1/devices/{device_id}/hardware-unbind
Content-Type: application/json
{ "reason": "Refund" }
| Status | Error | When |
|---|---|---|
404 | RESOURCE_NOT_FOUND | Device not found in this workspace. |
409 | DEVICE_NOT_IN_STOCK | The device is not for sale. |
409 | DEVICE_ALREADY_BOUND | Bind called on a device that already has an owner. |
409 | DEVICE_NOT_BOUND | Unbind or transfer called on a device with no owner. |
409 | DEVICE_UNAVAILABLE | The device is disabled or archived. |