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 GrupoMAS Native Execution API (/api/integration/grupomas-native or /api/v1/integration/grupomas-native) is the real-time bridge between Dragon Guard handhelds and the GrupoMAS ERP. It is only accessible for tenants configured with IntegrationMode = GrupoMasNative. All endpoints authenticate via X-Api-Key. Read endpoints fetch live data from MAS; write (result-posting) endpoints report execution outcomes back to MAS and trigger outbound acknowledgments.
All endpoints on this page require X-Api-Key authentication and the tenant must have IntegrationMode = GrupoMasNative. Requests from non-GrupoMAS tenants receive 409 Conflict. The X-Contract-Version request header is validated; unsupported versions return 400 Bad Request.

​
GET /api/v1/integration/grupomas-native/released-receipts

Returns released receipt documents from GrupoMAS that are available for physical execution in the warehouse. Authentication: X-Api-Key: <api-key> (required).
​
externalDocumentNo
string
Filter by specific receipt document number.
​
locationCode
string
Filter by warehouse location code.
​
pageNumber
integer
Page number. Defaults to 1.
​
pageSize
integer
Page size. Defaults to 100.
​
success
boolean
Whether the GrupoMAS call succeeded.
​
contractVersion
string
API contract version used.
​
companyCode
string
Tenant company code.
​
correlationId
string
Correlation ID for tracing.
​
data
array
List of released receipt documents from MAS.
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/released-receipts?pageSize=50" \
  -H "X-Api-Key: your-api-key-here"

​
GET /api/v1/integration/grupomas-native/released-shipments

Returns released shipment documents from GrupoMAS available for picking and shipping. Authentication: X-Api-Key: <api-key> (required). Accepts the same query parameters as /released-receipts. Lines include sentQuantity and shippedQty for partial shipment tracking. 
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/released-shipments?locationCode=WH-MAIN" \
  -H "X-Api-Key: your-api-key-here"

​
GET /api/v1/integration/grupomas-native/released-counts

Returns released inventory count tasks from GrupoMAS available for physical counting. Authentication: X-Api-Key: <api-key> (required). Accepts the same query parameters as /released-receipts. 
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/released-counts" \
  -H "X-Api-Key: your-api-key-here"

​
GET /api/v1/integration/grupomas-native/released-transfers

Returns released internal transfer tasks from GrupoMAS. Authentication: X-Api-Key: <api-key> (required). Lines include sourceBinCode and targetBinCode for transfer operations. 
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/released-transfers" \
  -H "X-Api-Key: your-api-key-here"

​
GET /api/v1/integration/grupomas-native/items/lookup

Searches the GrupoMAS item catalog. Returns live item data including stock levels per bin. Authentication: X-Api-Key: <api-key> (required).
​
q
string
Free-text search across item number, description, barcode, and alternate code.
​
itemNo
string
Exact or partial item number filter.
​
locationCode
string
Filter results to a specific warehouse location.
​
binCode
string
Filter results to a specific bin.
​
hasStockOnly
boolean
Return only items with available stock.
​
pageNumber
integer
Page. Defaults to 1.
​
pageSize
integer
Page size. Defaults to 20, max 100.
​
totalRecords
integer
Total matching items in MAS.
​
totalQuantity
decimal
Sum of available quantities (zero when no filter is active).
​
items
array
List of item lookup lines with stock per bin.
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/items/lookup?q=widget&hasStockOnly=true" \
  -H "X-Api-Key: your-api-key-here"

​
GET /api/v1/integration/grupomas-native/items//stock

Returns stock detail for a single item across all bins from GrupoMAS. Authentication: X-Api-Key: <api-key> (required).
​
itemNo
string
required
Item number to look up.
​
locationCode
string
Filter by location code.
​
binCode
string
Filter by bin code.
​
hasStockOnly
boolean
Return only bins with stock.
​
itemNo
string
Item number.
​
description
string
Item description.
​
quantityLabel
string
Display label for quantities.
​
lines
array
Per-bin stock lines with binCode, availableQuantity, and uom.
Error codes
StatusMeaning
400itemNo is missing or empty.
404Item not found in GrupoMAS.
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/items/SKU-001/stock?locationCode=WH-MAIN" \
  -H "X-Api-Key: your-api-key-here"

​
GET /api/v1/integration/grupomas-native/bin-stock

Returns bin-level stock for a specific item from GrupoMAS. itemNo is required. Authentication: X-Api-Key: <api-key> (required).
​
itemNo
string
required
Item number.
​
locationCode
string
Filter by location.
​
binCode
string
Filter by bin.
​
hasStockOnly
boolean
Only bins with stock.
Error codes
StatusMeaning
400itemNo is missing or empty.
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/bin-stock?itemNo=SKU-001&locationCode=WH-MAIN" \
  -H "X-Api-Key: your-api-key-here"

​
GET /api/v1/integration/grupomas-native/locations

Returns the list of warehouse locations from GrupoMAS. Authentication: X-Api-Key: <api-key> (required).
​
locations
array
List of location objects with locationCode and locationDescription.
curl -X GET "https://api.example.com/api/v1/integration/grupomas-native/locations" \
  -H "X-Api-Key: your-api-key-here"

​
POST /api/v1/integration/grupomas-native/receipt-results

Posts the physical execution result of a GrupoMAS receipt back to MAS. Dragon Guard logs the result and queues an outbound acknowledgment. Idempotent when the same idempotencyKey is used — subsequent calls with the same key return the previously recorded result. Authentication: X-Api-Key: <api-key> (required).
​
eventId
string
required
Unique event identifier for idempotency tracking.
​
idempotencyKey
string
required
Idempotency key to prevent duplicate postings.
​
correlationId
string
required
Correlation ID linking this result to the original released document event.
​
externalDocumentNo
string
required
MAS document number.
​
operationType
string
required
Must be RECEIPT.
​
status
string
required
Must be POSTED.
​
locationCode
string
required
Warehouse location where the operation occurred.
​
operatorEmail
string
Operator email for audit trail.
​
operatorId
string
Operator identifier from the handheld.
​
deviceId
string
Normalized device key of the scanning device.
​
startedAtUtc
string (ISO 8601)
required
When the operation started.
​
postedAtUtc
string (ISO 8601)
required
When the result was finalized. Must be ≥ startedAtUtc.
​
lines
array
required
Execution result lines. At least one line is required.
​
success
boolean
Whether the result was accepted.
​
accepted
boolean
Whether the result was queued for outbound delivery.
​
contractVersion
string
API contract version.
​
companyCode
string
Tenant company code.
​
correlationId
string
Correlation ID.
​
outboundAcknowledgmentId
string (uuid)
ID of the created outbound acknowledgment.
​
outboundAcknowledgmentStatus
string
Delivery status (QUEUED, NOT_CONFIGURED).
​
result
object
Result summary with externalDocumentNo, status, retryStatus, and attemptCount.
Error codes
StatusMeaning
400Missing required fields, invalid operationType, invalid status, invalid differenceReason, or postedAtUtc is before startedAtUtc.
409Tenant is not configured for GrupoMASNative.
501GrupoMAS adapter not configured for outbound delivery.
502GrupoMAS remote returned an error.
curl -X POST "https://api.example.com/api/v1/integration/grupomas-native/receipt-results" \
  -H "X-Api-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "evt-001",
    "idempotencyKey": "idem-001",
    "correlationId": "corr-001",
    "externalDocumentNo": "RC-MAS-2024-001",
    "operationType": "RECEIPT",
    "status": "POSTED",
    "locationCode": "WH-MAIN",
    "operatorEmail": "[email protected]",
    "startedAtUtc": "2024-08-01T09:00:00Z",
    "postedAtUtc": "2024-08-01T09:45:00Z",
    "lines": [
      {
        "externalLineNo": "1",
        "itemNo": "SKU-001",
        "expectedQuantity": 100,
        "actualQuantity": 98,
        "uom": "EA",
        "binCode": "A-01-001",
        "differenceReason": "SHORT_PICK"
      }
    ]
  }'

​
POST /api/v1/integration/grupomas-native/shipment-results

Posts the physical execution result of a GrupoMAS shipment back to MAS. Same structure as receipt-results with operationType = SHIPMENT. Authentication: X-Api-Key: <api-key> (required). 
curl -X POST "https://api.example.com/api/v1/integration/grupomas-native/shipment-results" \
  -H "X-Api-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "evt-002",
    "idempotencyKey": "idem-002",
    "correlationId": "corr-002",
    "externalDocumentNo": "SHP-MAS-2024-001",
    "operationType": "SHIPMENT",
    "status": "POSTED",
    "locationCode": "WH-MAIN",
    "startedAtUtc": "2024-08-01T11:00:00Z",
    "postedAtUtc": "2024-08-01T11:30:00Z",
    "lines": [
      {"externalLineNo": "1", "itemNo": "SKU-001", "expectedQuantity": 50, "actualQuantity": 50, "uom": "EA"}
    ]
  }'

​
POST /api/v1/integration/grupomas-native/count-results

Posts the physical execution result of an inventory count task back to MAS. Same structure as receipt-results with operationType = INVENTORY_COUNT. Authentication: X-Api-Key: <api-key> (required). 
curl -X POST "https://api.example.com/api/v1/integration/grupomas-native/count-results" \
  -H "X-Api-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "evt-003",
    "idempotencyKey": "idem-003",
    "correlationId": "corr-003",
    "externalDocumentNo": "CNT-MAS-2024-001",
    "operationType": "INVENTORY_COUNT",
    "status": "POSTED",
    "locationCode": "WH-MAIN",
    "startedAtUtc": "2024-08-01T14:00:00Z",
    "postedAtUtc": "2024-08-01T15:30:00Z",
    "lines": [
      {"externalLineNo": "1", "itemNo": "SKU-001", "expectedQuantity": 200, "actualQuantity": 198, "uom": "EA"}
    ]
  }'

​
POST /api/v1/integration/grupomas-native/transfer-results

Posts the execution result of an internal transfer task back to MAS. Same structure as receipt-results with operationType = TRANSFER. Lines may include sourceBinCode and targetBinCode. Authentication: X-Api-Key: <api-key> (required). 
curl -X POST "https://api.example.com/api/v1/integration/grupomas-native/transfer-results" \
  -H "X-Api-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "evt-004",
    "idempotencyKey": "idem-004",
    "correlationId": "corr-004",
    "externalDocumentNo": "TRF-MAS-2024-001",
    "operationType": "TRANSFER",
    "status": "POSTED",
    "locationCode": "WH-MAIN",
    "startedAtUtc": "2024-08-01T16:00:00Z",
    "postedAtUtc": "2024-08-01T16:20:00Z",
    "lines": [
      {
        "externalLineNo": "1",
        "itemNo": "SKU-001",
        "expectedQuantity": 25,
        "actualQuantity": 25,
        "uom": "EA",
        "sourceBinCode": "A-01-001",
        "targetBinCode": "B-02-003"
      }
    ]
  }'

Build docs developers (and LLMs) love

Get started for freeTalk to us