ADM-TRANSACTION-551 - List transaction events.

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 the 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
string

Commercial transaction identifier.

string

Logistic order identifier.

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
float

Minimum event amount (inclusive).
Invalid values are ignored.

float

Maximum event amount (inclusive).
Invalid values are ignored.

string

Supported fields: amount, status, orderReference, createdAt.
Default sort: createdAt:asc.
Invalid sorts are silently ignored.

integer

Page number.

integer

Page size.

Headers
string
enum
required

Must be set to OPERATOR or SUPPLIER for this administration route.

Allowed:
string
required

API key for authentication.

string

Optional store context.

string

Optional store view context.

Responses

401

Unauthorized (invalid or missing API key)

403

Forbidden (insufficient permissions or visibility scope)

404

Not found (unknown reference)

500

Internal server error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json