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 Outbound Acknowledgments API manages the outbound delivery queue — the records Dragon Guard creates when it needs to notify an external ERP system (e.g., GrupoMAS) that a warehouse operation has been completed and posted. Each acknowledgment tracks delivery status, attempt count, and retry schedule. Operators and admins can inspect failed deliveries and trigger manual retries.

​
GET /api/outbound-acknowledgments

Returns a paginated list of outbound acknowledgment records for the authenticated company. Supports filtering by status, event type, and free-text search. Authentication: Authorization: Bearer <token> (required).
​
companyId
string (uuid)
Tenant company ID. Resolved from JWT if omitted.
​
status
string
Filter by delivery status. Valid values:
ValueMeaning
QUEUEDPending first delivery attempt.
RETRY_REQUIREDPrevious attempt failed; scheduled for retry.
SENTSuccessfully delivered to the ERP.
DEAD_LETTERMax retries exhausted; requires manual intervention.
NOT_CONFIGUREDNo outbound callback URL was configured at time of creation.
​
eventType
string
Filter by event type code (e.g., RECEIPT_POSTED, SHIPMENT_POSTED).
​
search
string
Free-text search against source document number, posted document number, and event type.
​
pageNumber
integer
1-based page. Defaults to 1.
​
pageSize
integer
Page size. Defaults to 20, max 100.
​
data
array
​
pageNumber
integer
Current page.
​
pageSize
integer
Page size.
​
totalRecords
integer
Total acknowledgment records matching the filter.
​
totalPages
integer
Total pages.
curl -X GET "https://api.example.com/api/outbound-acknowledgments?status=RETRY_REQUIRED&pageSize=50" \
  -H "Authorization: Bearer <token>"

​
GET /api/outbound-acknowledgments/

Returns full detail for a single outbound acknowledgment including the serialized payload JSON that was (or will be) delivered to the ERP. Authentication: Authorization: Bearer <token> (required).
​
id
string (uuid)
required
Acknowledgment record ID.
​
companyId
string (uuid)
Tenant company ID.
Returns the full OutboundAcknowledgmentDto (same fields as the list response) plus:
​
payloadJson
string
The JSON payload string that was sent (or will be sent) to the ERP callback URL.
Error codes
StatusMeaning
404Acknowledgment not found for the given ID and company.
curl -X GET "https://api.example.com/api/outbound-acknowledgments/8a3c0000-0000-0000-0000-000000000005?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer <token>"

​
POST /api/outbound-acknowledgments//retry

Manually triggers an immediate delivery attempt for an acknowledgment that has failed or been dead-lettered. Cannot be called on records that have already been successfully sent (status = SENT). Authentication: Authorization: Bearer <token> (required).
​
id
string (uuid)
required
Acknowledgment record ID to retry.
​
companyId
string (uuid)
Tenant company ID.
Returns the updated OutboundAcknowledgmentDto reflecting the new attempt. Error codes
StatusMeaning
404Acknowledgment not found.
409integration.outboundAcknowledgmentAlreadySent — Record was already successfully delivered.
After retrying a dead-lettered record, monitor the status field in the response. If it remains DEAD_LETTER after the retry, inspect lastError and lastResponseBody for the root cause before attempting again.
curl -X POST "https://api.example.com/api/outbound-acknowledgments/8a3c0000-0000-0000-0000-000000000005/retry?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer <token>"

Build docs developers (and LLMs) love

Get started for freeTalk to us