Skip to main content

Documentation Index

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

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

The Audit API provides full operational change history across both web and handheld operations for every tenant in the system. Administrators can browse log entries filtered by table, action, actor, or origin channel, while Supreme operators gain cross-tenant visibility. The Outbound Acknowledgments API complements this by exposing the status of ERP callback notifications — giving administrators the ability to inspect payloads, diagnose failures, and trigger retries without re-processing successfully acknowledged records.

​
Audit Endpoints

​
GET /api/audit/logs

Retrieves paginated audit log entries. Tenant users see only their own company’s records; the backend re-resolves tenant context from the authenticated session. Supreme operators may additionally filter across tenants using the advanced filter parameters below. 
GET /api/audit/logs

​
Query Parameters

​
companyId
string
required
Tenant company identifier. Required to establish tenant context. Passed automatically by WmsService for tenant sessions; supplied explicitly by Supreme operators when browsing a specific company.
​
tenant
string
(Supreme only) Filter by tenant identifier. Ignored for non-Supreme sessions.
​
table
string
Name of the auditable table to filter on. Use GET /api/audit/tables to retrieve valid values.
​
action
string
Audit action type. Common values: INSERT, UPDATE, DELETE.
​
actor
string
Username or system identifier that performed the action.
​
origin
string
Channel that originated the change. Accepted values: Web, Handheld, API, System.
​
search
string
Free-text search applied across log entry fields.
​
page
integer
Page number for pagination (1-based).
​
pageSize
integer
Number of records per page.

​
Response

Returns a paginated list of audit log entries.
​
data
array
​
total
integer
Total number of matching records across all pages.
​
page
integer
Current page number.
​
pageSize
integer
Number of records returned per page.

​
Error Responses

StatusDescription
400Missing or invalid query parameters.
401Unauthenticated request or expired session.
500Internal server error.

​
GET /api/audit/tables

Returns the list of table names that are tracked by the audit system. The frontend uses this response to populate the Table filter dropdown on the audit log screen. 
GET /api/audit/tables

​
Response

​
tables
array of strings
Ordered list of auditable table names registered in the system.
Example response: 
{
  "tables": [
    "Products",
    "Warehouses",
    "InventoryMovements",
    "Shipments",
    "Receipts",
    "Users"
  ]
}

​
Error Responses

StatusDescription
401Unauthenticated request or expired session.
500Internal server error.

​
Outbound Acknowledgment Endpoints

Outbound acknowledgments represent ERP callback notifications dispatched after key warehouse events (e.g., a receipt or shipment being posted). These endpoints allow administrators to monitor delivery status, inspect full payloads, and retry failed or skipped notifications.

​
GET /api/outbound-acknowledgments

Retrieves a paginated list of outbound acknowledgment records. Payload bodies are intentionally omitted from this list response for pagination efficiency — use GET /api/outbound-acknowledgments/{id} to retrieve the full payload for a specific record. 
GET /api/outbound-acknowledgments

​
Query Parameters

​
status
string
Filter by delivery status. Accepted values: PENDING, SENT, FAILED, SKIPPED.
​
eventType
string
Filter by event type. Accepted values: RECEIPT_POSTED, SHIPMENT_POSTED.
​
search
string
Free-text search across acknowledgment fields (e.g., document number, callback URL).
​
page
integer
Page number for pagination (1-based).
​
pageSize
integer
Number of records per page.

​
Response

​
data
array
​
total
integer
Total number of matching records across all pages.

​
Error Responses

StatusDescription
400Invalid filter parameter values.
401Unauthenticated request or expired session.
500Internal server error.

​
GET /api/outbound-acknowledgments/

Returns the full acknowledgment record for a single entry, including the complete payload JSON and the ERP’s last response body. Use this endpoint when diagnosing a delivery failure. 
GET /api/outbound-acknowledgments/{id}

​
Path Parameters

​
id
string
required
Unique identifier of the outbound acknowledgment record.

​
Response

​
id
string
Unique identifier for the acknowledgment record.
​
eventType
string
Type of warehouse event: RECEIPT_POSTED or SHIPMENT_POSTED.
​
status
string
Current delivery status: PENDING, SENT, FAILED, or SKIPPED.
​
sourceDocument
string
Reference to the originating warehouse document.
​
postedDocument
string
Reference to the ERP document that was posted.
​
callbackUrl
string
The ERP endpoint URL targeted by this notification.
​
attemptCount
integer
Total number of delivery attempts made.
​
lastHttpResponseCode
integer
HTTP status code from the ERP on the most recent attempt.
​
lastError
string
Error message from the most recent failed attempt, if any.
​
payload
object
Full JSON payload that was (or will be) dispatched to the ERP callback URL. Structure varies by event type.
​
lastResponseBody
string
Raw response body returned by the ERP endpoint on the most recent attempt. Useful for diagnosing ERP-side rejections.
​
createdAt
string (ISO 8601)
Timestamp when the acknowledgment record was created.
​
updatedAt
string (ISO 8601)
Timestamp of the most recent status update.

​
Error Responses

StatusDescription
400Malformed or missing id.
401Unauthenticated request or expired session.
500Internal server error.

​
POST /api/outbound-acknowledgments//retry

Triggers a re-delivery attempt for an outbound acknowledgment. Only records in PENDING, FAILED, or SKIPPED status are eligible for retry. The backend is the authoritative source for retry eligibility — the frontend should disable the retry action for SENT records, but final validation always occurs server-side. 
POST /api/outbound-acknowledgments/{id}/retry
SENT records cannot be retried. Retrying a successfully acknowledged notification would cause the ERP to process the same document a second time, resulting in duplicate entries. The backend enforces this restriction and returns 400 if a retry is attempted on a SENT record.

​
Path Parameters

​
id
string
required
Unique identifier of the outbound acknowledgment record to retry.

​
Retry Eligibility

StatusRetry Allowed
PENDING✅ Yes
FAILED✅ Yes
SKIPPED✅ Yes
SENT❌ No

​
Response

Returns the updated acknowledgment record after the retry attempt is queued or executed. Response shape mirrors GET /api/outbound-acknowledgments/{id}.

​
Error Responses

StatusDescription
400Record is in SENT status and cannot be retried, or malformed request.
401Unauthenticated request or expired session.
500Internal server error.

Build docs developers (and LLMs) love

Get started for freeTalk to us