Product
Required permissions: Order.Organization.Read Required features: Grid
The identifier of the organization.
The identifier of the market zone.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
List of flexibility orders
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/order/flexibility?organizationId=1&marketZoneId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": 1,
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"start": "2025-11-03T15:52:32.897Z",
"end": "2025-11-03T15:52:32.897Z",
"unitPrice": 1,
"minQuantity": 1,
"maxQuantity": 1,
"remainingQuantity": 1,
"productType": 0,
"organizationId": 1,
"resourceId": 1,
"flexibilityOrderGroupId": 1,
"availabilityTransactionId": 1,
"flexibilityScheduleId": 1,
"availabilityScheduleTransactionId": 1,
"targetOrganizationIds": [
1
]
}
]Required permissions: Order.Organization.Read Required features: ResourceManagement
The identifier of the resource.
The identifier of the organization.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
List of availability orders
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/order/availability/resource/{resourceId}?organizationId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"flexibilityOrdersExpireAt": "2025-11-03T15:52:32.897Z",
"start": "2025-11-03T15:52:32.897Z",
"end": "2025-11-03T15:52:32.897Z",
"productType": 0,
"clearingStatus": 0,
"marketId": 1,
"organizationId": 1,
"substationId": 1,
"resourceId": 1,
"quantity": 1,
"availabilityPrice": 1,
"impact": 1
}
]Required permissions: Order.Organization.Read Required features: ResourceManagement
The identifier of the resource.
The identifier of the organization.
List of availability schedule orders
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/order/availabilityschedule/resource/{resourceId}?organizationId=1 HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": 1,
"marketId": 1,
"organizationId": 1,
"substationId": 1,
"resourceId": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"validFrom": "2025-11-03T15:52:32.897Z",
"validTo": "2025-11-03T15:52:32.897Z",
"offersAllowedFrom": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"type": 0,
"clearingStatus": 0,
"name": "text",
"minEndurance": 1,
"maxEndurance": 1,
"minCooldown": 1,
"maxCooldown": 1,
"timeZone": "text",
"quantity": 1,
"totalQuantity": 1,
"availabilityPrice": 1,
"impact": 1,
"templates": [
{
"dayOfWeek": 1,
"hour": 1
}
],
"excludedPeriods": [
{
"start": "2025-11-03T15:52:32.897Z",
"end": "2025-11-03T15:52:32.897Z"
}
]
}
]Required permissions: Order.Organization.Read Required features: Grid
The identifier of the organization.
The identifier of the market zone.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
List of flexibility transactions
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/transaction/flexibility?organizationId=1&marketZoneId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"flexibilityTransactions": [
{
"id": 1,
"transactionCorrelationId": "123e4567-e89b-12d3-a456-426614174000",
"availabilityTransactionId": 1,
"flexibilityScheduleId": 1,
"availabilityScheduleTransactionId": 1,
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"organizationId": 1,
"quantity": 1,
"marketId": 1,
"flexibilityOrderId": 1,
"start": "2025-11-03T15:52:32.897Z",
"end": "2025-11-03T15:52:32.897Z",
"resourceId": 1,
"unitPrice": 1,
"counterpartOrganizationId": 1,
"counterpartCreatedBy": 1,
"productType": 0,
"deliveryValidationStatus": 0,
"validatedAt": "2025-11-03T15:52:32.897Z",
"deliveryPercentage": 1,
"deliveredQuantity": 1,
"referenceAdjustmentQuantity": 1,
"referenceReadingValue": 1,
"validationReadingValue": 1,
"remunerationPercentage": 1
}
],
"otherFlexibilityTransactionsWithImpact": [
{
"id": 1,
"transactionCorrelationId": "123e4567-e89b-12d3-a456-426614174000",
"availabilityTransactionId": 1,
"flexibilityScheduleId": 1,
"availabilityScheduleTransactionId": 1,
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"organizationId": 1,
"quantity": 1,
"marketId": 1,
"flexibilityOrderId": 1,
"start": "2025-11-03T15:52:32.897Z",
"end": "2025-11-03T15:52:32.897Z",
"resourceId": 1,
"unitPrice": 1,
"counterpartOrganizationId": 1,
"counterpartCreatedBy": 1,
"productType": 0,
"deliveryValidationStatus": 0,
"validatedAt": "2025-11-03T15:52:32.897Z",
"deliveryPercentage": 1,
"deliveredQuantity": 1,
"referenceAdjustmentQuantity": 1,
"referenceReadingValue": 1,
"validationReadingValue": 1,
"remunerationPercentage": 1
}
]
}Required permissions: Order.Organization.Read Required features: DecisionSupport
The identifier of the substation.
The identifier of the organization.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
List of flexibility transactions affecting the substation
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/transaction/flexibility/affecting/substation/{substationId}?organizationId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"flexibilityTransactionId": 1,
"start": "2025-11-03T15:52:32.897Z",
"end": "2025-11-03T15:52:32.897Z",
"quantity": 1,
"quantityAfterImpact": 1,
"impact": 1,
"deliveryValidationStatus": 0,
"deliveryPercentage": 1,
"deliveredQuantity": 1,
"referenceAdjustmentQuantity": 1,
"referenceReadingValue": 1,
"validationReadingValue": 1
}
]Required permissions: Order.Organization.Read Required features: Grid
The identifier of the organization.
The identifier of the market zone.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
List of availability transactions
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/transaction/availability?organizationId=1&marketZoneId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"createdBy": 1,
"organizationId": 1,
"resourceId": 1,
"activationPrice": 1,
"availabilityPrice": 1,
"quantity": 1,
"impactValue": 1,
"availabilityOrderId": 1,
"marketId": 1,
"substationId": 1,
"counterpartOrganizationId": 1,
"counterpartCreatedBy": 1,
"start": "2025-11-03T15:52:32.897Z",
"end": "2025-11-03T15:52:32.897Z",
"productType": 0,
"deliveryValidationStatus": 0,
"validatedAt": "2025-11-03T15:52:32.897Z",
"deliveryPercentage": 1,
"deliveredQuantity": 1,
"expectedDeliveredQuantity": 1,
"remunerationPercentage": 1
}
]Required permissions: Order.Organization.Read Required features: ResourceManagement
The identifier of the resource.
The identifier of the organization.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
List of availability offers
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/offer/availability/resource/{resourceId}?organizationId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"impactValue": 1,
"activationPrice": 1,
"maxQuantity": 1,
"minQuantity": 1,
"organizationId": 1,
"resourceId": 1,
"availabilityOrderId": 1,
"availabilityTransactionId": 1,
"clearingStatus": 0
}
]Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement
The identifier of the resource.
List of availability offers
Input data was invalid
Not authorized
Not allowed
Internal server error
POST /api/product/offer/availability/resource/{resourceId} HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"organizationId": 1,
"offers": [
{
"availabilityOrderId": 1,
"activationPrice": 1,
"maxQuantity": 1,
"minQuantity": 1
}
]
}[
{
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"impactValue": 1,
"activationPrice": 1,
"maxQuantity": 1,
"minQuantity": 1,
"organizationId": 1,
"resourceId": 1,
"availabilityOrderId": 1,
"availabilityTransactionId": 1,
"clearingStatus": 0
}
]Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement
The identifier of the resource.
List of availability offers
Input data was invalid
Not authorized
Not allowed
Internal server error
PUT /api/product/offer/availability/resource/{resourceId} HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"organizationId": 1,
"offers": [
{
"availabilityOrderId": 1,
"activationPrice": 1,
"maxQuantity": 1,
"minQuantity": 1
}
]
}[
{
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"impactValue": 1,
"activationPrice": 1,
"maxQuantity": 1,
"minQuantity": 1,
"organizationId": 1,
"resourceId": 1,
"availabilityOrderId": 1,
"availabilityTransactionId": 1,
"clearingStatus": 0
}
]Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement
The identifier of the resource.
The identifier of the organization.
The identifiers of the availability orders
The availability offers were deleted
No content
Input data was invalid
Not authorized
Not allowed
Internal server error
DELETE /api/product/offer/availability/resource/{resourceId}?organizationId=1&availabilityOrderId=1 HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Required permissions: Order.Organization.Read Required features: DecisionSupport
The identifier of the organization.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
List of availability offers
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/offer/availability/cleared?organizationId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"impactValue": 1,
"activationPrice": 1,
"maxQuantity": 1,
"minQuantity": 1,
"organizationId": 1,
"resourceId": 1,
"availabilityOrderId": 1,
"availabilityTransactionId": 1,
"clearingStatus": 0
}
]Required permissions: Order.Organization.Read Required features: DecisionSupport
The identifier of the organization.
List of availability schedule offers
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/offer/availabilityschedule/cleared?organizationId=1 HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"resourceId": 1,
"organizationId": 1,
"availabilityScheduleOrderId": 1,
"availabilityScheduleTransactionId": 1,
"createdBy": 1,
"createdAt": "2025-11-03T15:52:32.897Z",
"expiresAt": "2025-11-03T15:52:32.897Z",
"impactValue": 1,
"activationPrice": 1,
"maxQuantity": 1,
"minQuantity": 1,
"endurance": 1,
"cooldown": 1
}
]Required permissions: Order.Organization.Read Required features: Settlements
The identifier of the organization.
The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.
The settlement specification
Input data was invalid
Not authorized
Not allowed
Internal server error
GET /api/product/settlement/specification?organizationId=1&start=2025-11-03T15%3A52%3A32.897Z&end=2025-11-03T15%3A52%3A32.897Z HTTP/1.1
Host: api.switchmarket.se
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"organizationId": 1,
"counterParts": [
{
"organizationId": 1,
"flexibilitySoldSummary": {
"totalRemunerationSum": 1,
"transactions": [
{
"flexibilityTransactionId": 1,
"resourceId": 1,
"deliveryPercentage": 1,
"remunerationPercentage": 1,
"unitPrice": 1,
"totalRemuneration": 1,
"totalQuantity": 1,
"productType": 0,
"deliveryValidationStatus": 0
}
]
},
"flexibilityBoughtSummary": {
"totalRemunerationSum": 1,
"transactions": [
{
"flexibilityTransactionId": 1,
"resourceId": 1,
"deliveryPercentage": 1,
"remunerationPercentage": 1,
"unitPrice": 1,
"totalRemuneration": 1,
"totalQuantity": 1,
"productType": 0,
"deliveryValidationStatus": 0
}
]
},
"availabilitySoldSummary": {
"totalRemunerationSum": 1,
"transactions": [
{
"availabilityTransactionId": 1,
"resourceId": 1,
"substationId": 1,
"deliveryPercentage": 1,
"remunerationPercentage": 1,
"availabilityPrice": 1,
"totalRemuneration": 1,
"totalQuantity": 1,
"productType": 0,
"deliveryValidationStatus": 0
}
]
},
"availabilityBoughtSummary": {
"totalRemunerationSum": 1,
"transactions": [
{
"availabilityTransactionId": 1,
"resourceId": 1,
"substationId": 1,
"deliveryPercentage": 1,
"remunerationPercentage": 1,
"availabilityPrice": 1,
"totalRemuneration": 1,
"totalQuantity": 1,
"productType": 0,
"deliveryValidationStatus": 0
}
]
}
}
],
"remunerationPerResource": [
{
"resourceId": 1,
"bought": {
"totalAvailabilityRemunerationSum": 1,
"totalFlexibilityRemunerationSum": 1
},
"sold": {
"totalAvailabilityRemunerationSum": 1,
"totalFlexibilityRemunerationSum": 1
}
}
]
}Last updated
Was this helpful?