ADM-TRANSACTION-551 - List transaction events with search, filters and sorting

Returns the chronological list of events attached to a transaction.

User scoping

  • OPERATOR and SUPPLIER clients only for this route.

Visibility

  • OPERATOR can access events for any transaction across all suppliers.
  • SUPPLIER can access events only for transactions linked to the authenticated supplier.
  • If the transaction is outside the caller visibility scope, return 403.

Search

  • OPERATOR : optional text search applied on the order references, the supplier (name, externalId), and eventId.

  • SUPPLIER : optional text search applied on the order references and eventId.

Filters

  • AND between different keys; OR between values of the same key. Unknown values are ignored; empty lists mean no filter.
  • Supported filters: status, amountMin, amountMax, transactionId, logisticOrderReference.
  • transactionId and logisticOrderReference follow a precedence rule when both are provided:
    • OPERATOR: logisticOrderReference is ignored.
    • SUPPLIER: transactionId is ignored.

  • When both filters are missing or do not match any existing resource, they are ignored:
    • OPERATOR: all events within th e commercial transaction scope are returned.
    • SUPPLIER: all events across all logistic orders belonging to the supplier scope are returned.

Sorting

  • Sorting expression following the format: <field>:<direction>.
  • Supported fields: amount, status, orderReference, createdAt.
  • Default sort: createdAt:asc.
  • Invalid sorts are silently ignored.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
transactionIds
array of strings

Commercial transaction identifier.

transactionIds
logisticOrderReferences
array of strings

Logistic order identifiers.

logisticOrderReferences
string

Optional text search applied on: logistic order reference, supplier and event id.

status
array of strings

Multi-valued filter on event status.
Unknown values are ignored.

status
number

Minimum event amount with taxes (inclusive).

number

Maximum event amount with taxes (inclusive).

int32
Defaults to 0

Page number.

int32
Defaults to 20

Page size.

sort
array of strings

Supported fields: amount, status, orderReference, createdAt.

Default sort: createdAt:asc.
Invalid sorts are silently ignored.

Format: property:direction (recommended) or property,direction (kept for backward compatibility).

sort
Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

Responses

401

Unauthorized (invalid or missing API key).

403

Forbidden (insufficient permissions).

404

Not found (unknown reference).

500

Internal server error.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*