Audits

More Audit-API information can be found here: REST API documentation - Audits

The audit logs in the fulfillmenttools platform are to ensure transparency and security. Those logs can be used to understand who and when operations are taken on the platform to modify entities. Certain entities such as pick jobs, handover jobs, facilities, parcels, stow jobs, and many more have already implemented this function. This is being expanded further and further.

Audits are anonymized by default to be GDPR-conforming. This could be changed with the GDPR API. Here, the parameter actorAnonymization must be set to false. Changes to this value may take up to an hour to take effect.

Get audits

With the following endpoint, the audits can be retrieved:

GET https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/audits

With some filter parameters, the response can be restricted; please look at the API documentation. The response of the API call is a list of audit entries like the following one:

{
    "id": "67a1bf95bdcc1ede1ea1447d",
    "entityRef": "e4de35b3-6662-46b9-a9ad-e17ccc0f0168",
    "entityType": "PACK_JOB",
    "entityVersion": 1,
    "entityCreated": "2025-02-04T07:19:35.329Z",
    "eventId": "32566960-aa0f-4942-90af-b1ffe0d02f37",
    "anonymizationDate": "2025-03-06T07:19:35.329Z",
    "deletionDate": "2025-09-02T07:19:35.329Z",
    "isAnonymized": false,
    "version": 1,
    "trace": "1fb1eee25abf25660fd24a49aa27cebf",
    "actor": {
        "id": "NtwfRbu82fMPQspHkOdvv5UeLK83",
        "details": {
            "username": "[email protected]"
        }
    },
    "globalActor": {
        "id": "NtwfRbu82rrrQspHkOdYR5UeLK83",
        "details": {
            "username": "[email protected]"
        }
    },
    "operation": {
        "name": "POST /api/packjobs/",
        "start": "2025-02-04T07:19:35.153Z"
    },
    "client": {
        "api": "http",
        "rawInfo": "PostmanRuntime/7.43.0"
    },
    "lastModified": "2025-02-04T07:19:49.794Z",
    "created": "2025-02-04T07:19:49.794Z"
}

Actor

Two types of actors are available: the globalActor and the actor. An interaction usually results in several audit entries. So, a routing plan and pick job can be created if an order is created. The globalActor is always the user of the API who creates the order, the initiator of the interaction.

The actor is the direct initiator of the interaction; this could also be a fulfillmenttools technical user like order-created_event-v1 in the case of the routing plan created audit entry.