API referenceOrder
POST /api/Order/Post
This endpoint will create a new Order if the ID is null or zero, or update an existing Order if a valid ID is provided. For creation, do not include an ID or set the ID to zero in the request body. For updating, include the existing Order ID and the updated data in the request body.
POST
/api/Order/Postcurl -X POST "/api/Order/Post" \
-H "Authorization: $ATLAS_ETRM_API_DOCUMENTATION_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"data": [
{
"id": 0,
"orderKind": 2,
"status": {
"id": 1,
"name": "Draft",
"description": "Draft order by ETRM",
"order": 1,
"statusCategory": 1,
"statusCategoryName": "Draft",
"color": "#007BFF"
},
"startCompensation": null,
"endCompensation": null,
"companyId": null,
"counterPartyId": null,
"orderTypeId": null,
"externalId": null,
"totalQuantityMwh": 0,
"description": null,
"registrationDate": "2026-10-23T11:41:54.9765705+03:00",
"dueDate": "0001-01-01T00:00:00",
"totalAmount": 0,
"commodityId": null,
"documentDate": "0001-01-01T00:00:00",
"erpCode": null,
"contractCode": null
}
]
}'Authorization
AuthorizationstringheaderrequiredJWT Authorization header using the Bearer scheme. Enter your token including the 'Bearer ' prefix (e.g. 'Bearer eyJ...').
Body
application/json
dataEtrmApiGateway.DTOs.BackOffice.OrderCreationDto[] | null
Response
application/json
A list of Orders.
successbooleanrecordCountinteger<int32>dataEtrmApiGateway.DTOs.BackOffice.OrderCreationDto[] | null
{
"success": true,
"recordCount": 0,
"data": [
{
"id": 0,
"orderKind": 1,
"status": {
"id": 0,
"name": "string",
"description": "string",
"order": 0,
"statusCategory": 1,
"statusCategoryName": "string",
"color": "string"
},
"startCompensation": "2026-01-15T09:30:00Z",
"endCompensation": "2026-01-15T09:30:00Z",
"companyId": 0,
"counterPartyId": 0,
"orderTypeId": 0,
"externalId": "string",
"totalQuantityMwh": 0,
"description": "string",
"registrationDate": "2026-01-15T09:30:00Z",
"dueDate": "2026-01-15T09:30:00Z",
"totalAmount": 0,
"commodityId": 0,
"documentDate": "2026-01-15T09:30:00Z",
"erpCode": "string",
"contractCode": "string"
}
]
}