ScanMan Hive Documentation

POSTscanman_hive.api.lookup_item

Find a WMS Item by item code or barcode.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.lookup_item" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"code": "FAB-DIV-CH"}'

POSTscanman_hive.api.lookup_location

Find a WMS Location by location code.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.lookup_location" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"code": "RAW-A01-01"}'

POSTscanman_hive.api.stock_at_location

Return all non-zero stock balances at a location.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.stock_at_location" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"location": "RAW-A01-01"}'

POSTscanman_hive.api.receive_item

Register incoming stock at a receiving location. Writes a WMS Transaction of type Receive and creates or increments a WMS Stock Balance row.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.receive_item" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "item": "FAB-DIV-CH",
    "qty": 120,
    "location": "RCV-01",
    "lot_no": "DYE-2026-058",
    "reference_doctype": "Purchase Receipt",
    "reference_name": "PREC-0042"
  }'

Response: { "ok": true, "transaction": "SMTX-2026-00042", "location": "RCV-01" }

POSTscanman_hive.api.suggest_putaway

Resolve the highest-priority matching putaway rule for an item, then return the first active location in its preferred zone.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.suggest_putaway" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"item": "FAB-DIV-CH"}'

Response: { "ok": true, "rule": "Fast-moving fabric → near Cut bench", "zone": "ACACIA-CPT-RAW", "location": "RAW-A01-01" }

POSTscanman_hive.api.confirm_putaway

Commit the move from receiving to a putaway location. Operator can override the suggestion.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.confirm_putaway" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "item": "FAB-DIV-CH",
    "qty": 120,
    "from_location": "RCV-01",
    "to_location": "RAW-A01-01",
    "lot_no": "DYE-2026-058"
  }'

POSTscanman_hive.api.confirm_kit

Issue a raw material from raw stores to a production bench against a work order. Writes a Kit transaction linked to the work order reference.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.confirm_kit" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "work_order": "WO-2026-0017",
    "item": "FAB-DIV-CH",
    "qty": 8,
    "from_location": "RAW-A01-01",
    "to_location": "WIP-UPH",
    "lot_no": "DYE-2026-058"
  }'

POSTscanman_hive.api.create_pick_list

Create a pick list from a sales or work order reference. Lines are sequenced by zone → aisle → bay → level — a simple deterministic path sort, not TSP-optimised.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.create_pick_list" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "warehouse": "ACACIA-CPT",
    "reference_doctype": "Sales Order",
    "reference_name": "SAL-ORD-2026-0042",
    "items": [
      { "item": "FG-CBOX-STD", "qty": 3 },
      { "item": "FG-DESK-STD", "qty": 6 }
    ]
  }'

POSTscanman_hive.api.confirm_pick

Record a pick against a specific pick list line. Short-picks are accepted and logged as Short.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.confirm_pick" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "pick_list": "SHPL-2026-00007",
    "item": "FG-CBOX-STD",
    "qty": 3,
    "location": "FG-A01-01"
  }'

POSTscanman_hive.api.confirm_pack

Pack-verify every picked line. Requires the pick list to be in Picked status.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.confirm_pack" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"pick_list": "SHPL-2026-00007"}'

POSTscanman_hive.api.confirm_ship

Mark a pick list shipped. Writes one Ship transaction per line.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.confirm_ship" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{"pick_list": "SHPL-2026-00007"}'

POSTscanman_hive.api.confirm_count

Record a cycle count result. Compared to the current balance; a delta triggers an automatic adjustment. Returns previous qty, counted qty, and delta.

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.confirm_count" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "item": "FAB-DIV-CH",
    "location": "RAW-A01-01",
    "counted_qty": 118,
    "lot_no": "DYE-2026-047"
  }'

POSTscanman_hive.api.scan_event

Dispatches to the specific handler based on event.type. The device_type field is preserved on the resulting WMS Transaction row — that's how the audit trail distinguishes human scans from robot scans.

Human on a phone

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.scan_event" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "event": {
      "type": "Count",
      "item": "FAB-DIV-CH",
      "qty": 118,
      "to_location": "RAW-A01-01",
      "lot_no": "DYE-2026-047",
      "device_type": "Phone"
    }
  }'

Aerial drone — same endpoint, same schema

curl -X POST "$SCANMAN_URL/api/method/scanman_hive.api.scan_event" \
  -H "Authorization: $SCANMAN_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "event": {
      "type": "Count",
      "item": "FAB-DIV-CH",
      "qty": 118,
      "to_location": "RAW-A01-01",
      "lot_no": "DYE-2026-047",
      "device_type": "Aerial Robot"
    }
  }'