orders/{orderId}/traces

This method gets the history of an order’s status changes and messages.

URL

(GET) /api/orders/{orderId}/traces

PARAMETERS

URL parameters are:

orderId

The numeric order ID. See orders/list to find orders.

integer, Mandatory

RESULTS

The result is a JSON object with these properties:

count	Total events (aka traces).	integer
items	Array of events	object[]
canAdd	Boolean. If true then the connected user has the right to add a new message to the order.	bool

Each element in items is an object with these properties:

date	Event date.	datetime
message	Optional user message, if one was included with the event. Please note that message are sometimes auto-generated by the system and not originating from a client.	string?
status	The order status at the time of the event. See Order status for all options.	integer
statust	Status print title.	string
deadline	The deadline of the order at the time of the event. With this property one can easily identify any changes to the deadline.	datetime?
sender	The originator of the event. This can be the client when the client changes the status or submits a message. Or, it can be a manager who answers a question or amends the deadline. See below for details.	object[]

The sender has these properties:

pid	The user (person) who triggered the event or trace. If an event is triggered by the system, it will impersonate the platform administrator.	integer
pfname	User first name.	string (*)
plname	User last name.	string (*)
cid	User’s company ID.	integer (*)
cname	User’s company name.	string (*)

(*) If the user (pid) has been deleted then all other properties above are null.

EXAMPLE

An example for typical events in an order:

{
    "count": 16,
    "items": [
        {
            "date": "2022-11-11T14:48:36.517Z",
            "message": "Thank you for this information",
            "status": 2,
            "statust": "In progress",
            "deadline": "2022-10-28T11:00:00Z",
            "sender": {
                "pid": 201,
                "pfname": "Marcus",
                "plname": "Leen",
                "cid": 76,
                "cname": "Henderson Inc"
            }
        },
        {
            "date": "2022-11-11T14:31:14.183Z",
            "message": "We will deliver tomorrow, a day earlier :-)",
            "status": 2,
            "statust": "In progress",
            "deadline": "2022-10-28T11:00:00Z",
            "sender": {
                "pid": 562,
                "pfname": "John",
                "plname": "Mann",
                "cid": 537,
                "cname": "Translation Profis"
            }
        }
    ],
    "canAdd": true
}

ACCESS RIGHTS

This method is available to any user (clients, internal users) who has access to the given order online.