API referenceOrder
POST /api/Order/GetByIds
An array of ids should be passed in the request body, and the API returns a list of Orders that match the ids. In order to get all Orders, pass an empty array.
POST
/api/Order/GetByIdscurl -X POST "/api/Order/GetByIds" \
-H "Authorization: $ATLAS_ETRM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"data": [
1,
2,
3
]
}'Authorization
AuthorizationstringheaderrequiredJWT Authorization header using the Bearer scheme. Enter your token including the 'Bearer ' prefix (e.g. 'Bearer eyJ...').
Body
application/json
datainteger[] | null
Response
application/json
A list of Orders.
successbooleanrecordCountinteger<int32>dataEtrmApiGateway.DTOs.BackOffice.OrderDto[] | null
{
"success": true,
"recordCount": 0,
"data": [
{
"id": 0,
"name": "string",
"orderKind": 1,
"orderKindName": "string",
"status": {
"id": 0,
"name": "string",
"description": "string",
"order": 0,
"statusCategory": 1,
"statusCategoryName": "string",
"color": "string"
},
"orderTypeId": 0,
"orderTypeName": "string",
"externalId": "string",
"description": "string",
"registrationDate": "2026-01-15T09:30:00Z",
"dueDate": "2026-01-15T09:30:00Z",
"totalAmount": 0,
"startCompensation": "2026-01-15T09:30:00Z",
"endCompensation": "2026-01-15T09:30:00Z",
"totalQuantityMwh": 0,
"commodityId": 0,
"commodityName": "string",
"counterPartyName": "string",
"counterPartyId": 0,
"companyName": "string",
"companyId": 0,
"documentDate": "2026-01-15T09:30:00Z",
"erpCode": "string",
"contractCode": "string"
}
]
}