Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CodexaCP/DG_BACK/llms.txt

Use this file to discover all available pages before exploring further.

The RFID Operations API provides pre-flight validation for RFID-gated warehouse operations. Before committing a receipt, shipment, or transfer action, handheld devices call these endpoints to verify that the scanned EPC set is correct against the document’s expected set, enforcing the tenant’s configured RFID policy.

​
POST /api/rfid/validate-operation

Performs a pre-flight validation of a single RFID scan against a warehouse operation. Checks whether the EPC resolves to a known tag, whether it belongs to the expected document, and whether any mismatch should block the operation based on the tenant’s RFID policy. Authentication: Authorization: Bearer <token> (required).
​
rawEpc
string
Raw EPC string from the hardware reader.
​
normalizedEpc
string
Pre-normalized EPC. Used instead of rawEpc if provided.
​
module
string
required
WMS module context (e.g., RECEIVING, SHIPMENT, INVENTORY_COUNT, TRANSFER).
​
operationType
string
Specific operation type within the module (e.g., SCAN_IN, SCAN_OUT).
​
documentType
string
Document type being processed (e.g., RECEIPT, SHIPMENT).
​
documentNo
string
Document number to validate the EPC against.
​
locationCode
string
Current warehouse location code.
​
binCode
string
Current bin code.
​
success
boolean
Whether the validation call itself completed without errors.
​
isResolved
boolean
Whether the EPC was found in the tag registry.
​
isValid
boolean
Whether the EPC passes the document validation rules.
​
shouldBlock
boolean
Whether the RFID policy requires blocking the operation on this result. When true, the handheld must not allow the user to proceed without manual override.
​
module
string
Module as echoed from the request.
​
message
string
Human-readable validation outcome message.
​
tag
object
Resolved RfidTagDto if the EPC was found in the registry.
​
policyResult
object
Active policy settings applied during validation.
Error codes
StatusMeaning
400Invalid request payload or business rule violation.
curl -X POST "https://api.example.com/api/rfid/validate-operation" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "rawEpc": "AA:BB:CC:DD:EE:FF:00:01",
    "module": "RECEIVING",
    "operationType": "SCAN_IN",
    "documentType": "RECEIPT",
    "documentNo": "RCP-0000001",
    "locationCode": "WH-MAIN",
    "binCode": "A-01-001"
  }'

​
POST /api/rfid/validate-batch

Validates up to 100 EPCs in a single request. Each item in the batch is validated independently using the same operation context. Returns an aggregated summary plus per-EPC results. Authentication: Authorization: Bearer <token> (required).
The batch size is capped at 100 items per request. Requests with more than 100 items return 400 Bad Request.
​
items
array
required
Array of validation request objects (same schema as POST /api/rfid/validate-operation). Minimum 1 item, maximum 100 items.
​
totalCount
integer
Total number of EPCs in the batch.
​
validCount
integer
Number of EPCs that passed validation.
​
invalidCount
integer
Number of EPCs that failed validation.
​
blockedCount
integer
Number of EPCs where shouldBlock is true.
​
anyBlocked
boolean
Convenience flag — true if at least one EPC is blocking.
​
results
array
Per-EPC validation results.
Error codes
StatusMeaning
400Empty items array, or batch size exceeds 100.
curl -X POST "https://api.example.com/api/rfid/validate-batch" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "rawEpc": "AA:BB:CC:DD:EE:FF:00:01",
        "module": "SHIPMENT",
        "documentType": "SHIPMENT",
        "documentNo": "SHP-000005"
      },
      {
        "rawEpc": "AA:BB:CC:DD:EE:FF:00:02",
        "module": "SHIPMENT",
        "documentType": "SHIPMENT",
        "documentNo": "SHP-000005"
      }
    ]
  }'

Build docs developers (and LLMs) love

Get started for freeTalk to us