Skip to content

List orders

Request

Returns a Spring Page JSON with order records under the 'content' field.

How to use: provide a time window using epoch-millis for dateFrom/dateTo. Choose which date field to filter on via dateFilter. Limit the product scope with productFilter. Optionally filter by participantId. Paginate with page (0-based) and size. The allowed maximum date range is configured by the service and validated on request.

Path
productstringrequired

Product scope. "XBID" covers XBID and Intraday; "EXPOST", "GOPACS" and "INTRADAY" each cover only themselves; ALL covers every product.

Enum:"XBID""REGULAR""EXPOST""GOPACS""INTRADAY""ALL"
Query
participantIdstring

Restricts the result to a single participant.

dateFilterstring

Selects which timestamp the dateFrom/dateTo window applies to, and which field the results are ordered by. ORDER_CREATION_DATE is when the order was created, TRANSACTION_DATE when it was executed (traded), and DELIVERY_DATE the start of its delivery period. Note: this is only available in ACC at the moment; it is not yet in production.

Default:"ORDER_CREATION_DATE"
Enum:"ORDER_CREATION_DATE""TRANSACTION_DATE""DELIVERY_DATE"
dateFrominteger, (int64)required

Start of the window, inclusive, as epoch milliseconds. Applies to the field named by dateFilter. May not be more than two years before the start of the current day.

dateTointeger, (int64)required

End of the window, inclusive, as epoch milliseconds. Applies to the field named by dateFilter. The window may not exceed the maximum range configured for the service. Certain values (I.e. ORDER_CREATION_DATE/TRANSACTION_DATE) may not be in the future

sortDirectionstring

Direction the results are ordered in. The field ordered on is the one named by dateFilter.

Default:"DESC"
Enum:"ASC""DESC"
pageinteger, >= 0

Zero-based page index (0..N)

Default:0
sizeinteger, >= 1

The size of the page to be returned

Default:20
sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

GET
/public-api/4.0/electricity/reporting/{product}/orders
curl -i -X GET \
  'https://acc-trading.etpa.nl/public-api/4.0/electricity/reporting/{product}/orders?participantId=string&dateFilter=ORDER_CREATION_DATE&dateFrom=0&dateTo=0&sortDirection=ASC&page=0&size=20&sort=string'

Responses

Success. Paginated list of orders. Each element of 'content' is either an Intraday/Ex-post order (RegularOrderDto), a Gopacs order (GopacsOrderDto) or an XBID order (XbidOrderDto).

Bodyapplication/json
contentArray of any
pageableobject(PageableInfo)

Pagination request metadata that produced this page.

sortobject(SortInfo)

Sorting information for the page.

totalElementsinteger, (int64)

Total number of orders across all pages.

totalPagesinteger, (int32)

Total number of pages available.

sizeinteger, (int32)

Page size.

numberinteger, (int32)

Zero-based index of this page.

numberOfElementsinteger, (int32)

Number of elements on this page.

firstboolean

Whether this is the first page.

lastboolean

Whether this is the last page.

emptyboolean

Whether this page has no elements.

Response
{
  "content": [
    { … }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": { … },
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "number": 0,
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}