Product

Get resource forecasted demands

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Path parameters

resourceIdinteger · int32Required

The identifier of the resource

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

The forecasted demands for the resource

application/json

idinteger · int64Required

substationIdinteger · int32Required

resourceIdinteger · int32Required

createdAtstring · date-timeRequired

startstring · date-timeRequired

endstring · date-timeRequired

demandDetectionTypeall ofRequired

integer · enumOptionalPossible values:

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/resource/{resourceId}/forecasted-demands

HTTPcURLJavaScriptPython

GET /api/product/resource/{resourceId}/forecasted-demands?organizationId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "id": 1,
    "substationId": 1,
    "resourceId": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "start": "2026-03-12T02:13:57.694Z",
    "end": "2026-03-12T02:13:57.694Z",
    "demandDetectionType": 0
  }
]

Get flexibility orders

get

Required permissions: Order.Organization.Read Required features: Grid

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

marketZoneIdinteger · int32Required

The identifier of the market zone.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

List of flexibility orders

application/json

idinteger · int64Required

createdByinteger · int32 · nullableRequired

createdAtstring · date-timeRequired

expiresAtstring · date-timeRequired

startstring · date-timeRequired

endstring · date-timeRequired

unitPricenumber · doubleRequired

minQuantityinteger · int64Required

maxQuantityinteger · int64Required

remainingQuantityinteger · int64Required

productTypeall ofRequired

integer · enumOptionalPossible values:

organizationIdinteger · int32Required

resourceIdinteger · int32Required

flexibilityOrderGroupIdinteger · int64 · nullableRequired

availabilityTransactionIdinteger · int64 · nullableRequired

flexibilityScheduleIdinteger · int64 · nullableRequired

availabilityScheduleTransactionIdinteger · int64 · nullableRequired

targetOrganizationIdsinteger · int32[] · nullableRequired

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/order/flexibility

HTTPcURLJavaScriptPython

GET /api/product/order/flexibility?organizationId=1&marketZoneId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "id": 1,
    "createdBy": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "start": "2026-03-12T02:13:57.694Z",
    "end": "2026-03-12T02:13:57.694Z",
    "unitPrice": 1,
    "minQuantity": 1,
    "maxQuantity": 1,
    "remainingQuantity": 1,
    "productType": 0,
    "organizationId": 1,
    "resourceId": 1,
    "flexibilityOrderGroupId": 1,
    "availabilityTransactionId": 1,
    "flexibilityScheduleId": 1,
    "availabilityScheduleTransactionId": 1,
    "targetOrganizationIds": [
      1
    ]
  }
]

Get resource availability orders

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Path parameters

resourceIdinteger · int32Required

The identifier of the resource.

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

List of availability orders

application/json

idinteger · int64Required

createdAtstring · date-timeRequired

expiresAtstring · date-timeRequired

flexibilityOrdersExpireAtstring · date-timeRequired

startstring · date-timeRequired

endstring · date-timeRequired

productTypeall ofRequired

integer · enumOptionalPossible values:

clearingStatusall ofRequired

integer · enumOptionalPossible values:

marketIdinteger · int64Required

organizationIdinteger · int32Required

substationIdinteger · int32Required

resourceIdinteger · int32Required

quantityinteger · int64Required

availabilityPricenumber · doubleRequired

impactnumber · doubleRequired

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/order/availability/resource/{resourceId}

HTTPcURLJavaScriptPython

GET /api/product/order/availability/resource/{resourceId}?organizationId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "id": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "flexibilityOrdersExpireAt": "2026-03-12T02:13:57.694Z",
    "start": "2026-03-12T02:13:57.694Z",
    "end": "2026-03-12T02:13:57.694Z",
    "productType": 0,
    "clearingStatus": 0,
    "marketId": 1,
    "organizationId": 1,
    "substationId": 1,
    "resourceId": 1,
    "quantity": 1,
    "availabilityPrice": 1,
    "impact": 1
  }
]

Get resource availability schedule orders

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Path parameters

resourceIdinteger · int32Required

The identifier of the resource.

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

Responses

200

List of availability schedule orders

application/json

idinteger · int64Required

marketIdinteger · int64Required

organizationIdinteger · int32Required

substationIdinteger · int32Required

resourceIdinteger · int32Required

createdAtstring · date-timeRequired

validFromstring · date-timeRequired

validTostring · date-timeRequired

offersAllowedFromstring · date-timeRequired

expiresAtstring · date-timeRequired

typeall ofRequired

integer · enumOptionalPossible values:

clearingStatusall ofRequired

integer · enumOptionalPossible values:

namestring · nullableRequired

minEnduranceinteger · int32 · nullableRequired

maxEnduranceinteger · int32 · nullableRequired

minCooldowninteger · int32 · nullableRequired

maxCooldowninteger · int32 · nullableRequired

timeZonestring · nullableRequired

quantityinteger · int64Required

totalQuantityinteger · int64Required

availabilityPricenumber · doubleRequired

impactnumber · doubleRequired

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/order/availabilityschedule/resource/{resourceId}

HTTPcURLJavaScriptPython

GET /api/product/order/availabilityschedule/resource/{resourceId}?organizationId=1 HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "id": 1,
    "marketId": 1,
    "organizationId": 1,
    "substationId": 1,
    "resourceId": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "validFrom": "2026-03-12T02:13:57.694Z",
    "validTo": "2026-03-12T02:13:57.694Z",
    "offersAllowedFrom": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "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": "2026-03-12T02:13:57.694Z",
        "end": "2026-03-12T02:13:57.694Z"
      }
    ]
  }
]

Get flexibility transactions

get

Required permissions: Order.Organization.Read Required features: Grid

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

marketZoneIdinteger · int32Required

The identifier of the market zone.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

List of flexibility transactions

application/json

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/transaction/flexibility

HTTPcURLJavaScriptPython

GET /api/product/transaction/flexibility?organizationId=1&marketZoneId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

{
  "flexibilityTransactions": [
    {
      "id": 1,
      "transactionCorrelationId": "123e4567-e89b-12d3-a456-426614174000",
      "availabilityTransactionId": 1,
      "flexibilityScheduleId": 1,
      "availabilityScheduleTransactionId": 1,
      "createdBy": 1,
      "createdAt": "2026-03-12T02:13:57.694Z",
      "organizationId": 1,
      "quantity": 1,
      "marketId": 1,
      "flexibilityOrderId": 1,
      "start": "2026-03-12T02:13:57.694Z",
      "end": "2026-03-12T02:13:57.694Z",
      "resourceId": 1,
      "unitPrice": 1,
      "counterpartOrganizationId": 1,
      "counterpartCreatedBy": 1,
      "productType": 0,
      "deliveryValidationStatus": 0,
      "validatedAt": "2026-03-12T02:13:57.694Z",
      "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": "2026-03-12T02:13:57.694Z",
      "organizationId": 1,
      "quantity": 1,
      "marketId": 1,
      "flexibilityOrderId": 1,
      "start": "2026-03-12T02:13:57.694Z",
      "end": "2026-03-12T02:13:57.694Z",
      "resourceId": 1,
      "unitPrice": 1,
      "counterpartOrganizationId": 1,
      "counterpartCreatedBy": 1,
      "productType": 0,
      "deliveryValidationStatus": 0,
      "validatedAt": "2026-03-12T02:13:57.694Z",
      "deliveryPercentage": 1,
      "deliveredQuantity": 1,
      "referenceAdjustmentQuantity": 1,
      "referenceReadingValue": 1,
      "validationReadingValue": 1,
      "remunerationPercentage": 1
    }
  ]
}

Get flexibility transactions affecting substation

get

Required permissions: Order.Organization.Read Required features: DecisionSupport

Path parameters

substationIdinteger · int32Required

The identifier of the substation.

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

List of flexibility transactions affecting the substation

application/json

flexibilityTransactionIdinteger · int64Optional

startstring · date-timeOptional

endstring · date-timeOptional

quantityinteger · int64Optional

quantityAfterImpactnumber · doubleOptional

impactnumber · doubleOptional

deliveryValidationStatusall ofOptional

integer · enumOptionalPossible values:

deliveryPercentagenumber · double · nullableOptional

deliveredQuantityinteger · int64 · nullableOptional

referenceAdjustmentQuantityinteger · int64 · nullableOptional

referenceReadingValuenumber · double · nullableOptional

validationReadingValuenumber · double · nullableOptional

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/transaction/flexibility/affecting/substation/{substationId}

HTTPcURLJavaScriptPython

GET /api/product/transaction/flexibility/affecting/substation/{substationId}?organizationId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "flexibilityTransactionId": 1,
    "start": "2026-03-12T02:13:57.694Z",
    "end": "2026-03-12T02:13:57.694Z",
    "quantity": 1,
    "quantityAfterImpact": 1,
    "impact": 1,
    "deliveryValidationStatus": 0,
    "deliveryPercentage": 1,
    "deliveredQuantity": 1,
    "referenceAdjustmentQuantity": 1,
    "referenceReadingValue": 1,
    "validationReadingValue": 1
  }
]

Get availability transactions

get

Required permissions: Order.Organization.Read Required features: Grid

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

marketZoneIdinteger · int32Required

The identifier of the market zone.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

List of availability transactions

application/json

idinteger · int64Required

createdAtstring · date-timeRequired

createdByinteger · int32 · nullableRequired

organizationIdinteger · int32Required

resourceIdinteger · int32Required

activationPricenumber · doubleRequired

availabilityPricenumber · doubleRequired

quantityinteger · int64Required

impactValuenumber · doubleRequired

availabilityOrderIdinteger · int64Required

marketIdinteger · int64Required

substationIdinteger · int32Required

counterpartOrganizationIdinteger · int32Required

counterpartCreatedByinteger · int32 · nullableRequired

startstring · date-timeRequired

endstring · date-timeRequired

productTypeall ofRequired

integer · enumOptionalPossible values:

deliveryValidationStatusall ofRequired

integer · enumOptionalPossible values:

validatedAtstring · date-time · nullableRequired

deliveryPercentagenumber · double · nullableRequired

deliveredQuantityinteger · int64 · nullableRequired

expectedDeliveredQuantityinteger · int64 · nullableRequired

remunerationPercentagenumber · double · nullableRequired

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/transaction/availability

HTTPcURLJavaScriptPython

GET /api/product/transaction/availability?organizationId=1&marketZoneId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "id": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "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": "2026-03-12T02:13:57.694Z",
    "end": "2026-03-12T02:13:57.694Z",
    "productType": 0,
    "deliveryValidationStatus": 0,
    "validatedAt": "2026-03-12T02:13:57.694Z",
    "deliveryPercentage": 1,
    "deliveredQuantity": 1,
    "expectedDeliveredQuantity": 1,
    "remunerationPercentage": 1
  }
]

Get availability offers

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Path parameters

resourceIdinteger · int32Required

The identifier of the resource.

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

List of availability offers

application/json

createdByinteger · int32 · nullableRequired

createdAtstring · date-timeRequired

expiresAtstring · date-timeRequired

impactValuenumber · doubleRequired

activationPricenumber · doubleRequired

maxQuantityinteger · int64Required

minQuantityinteger · int64Required

organizationIdinteger · int32Required

resourceIdinteger · int32Required

availabilityOrderIdinteger · int64Required

availabilityTransactionIdinteger · int64 · nullableRequired

clearingStatusall ofRequired

integer · enumOptionalPossible values:

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/offer/availability/resource/{resourceId}

HTTPcURLJavaScriptPython

GET /api/product/offer/availability/resource/{resourceId}?organizationId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "createdBy": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "impactValue": 1,
    "activationPrice": 1,
    "maxQuantity": 1,
    "minQuantity": 1,
    "organizationId": 1,
    "resourceId": 1,
    "availabilityOrderId": 1,
    "availabilityTransactionId": 1,
    "clearingStatus": 0
  }
]

Create availability offers

post

Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement

Path parameters

resourceIdinteger · int32Required

The identifier of the resource.

Body

application/json

Responses

200

List of availability offers

application/json

createdByinteger · int32 · nullableRequired

createdAtstring · date-timeRequired

expiresAtstring · date-timeRequired

impactValuenumber · doubleRequired

activationPricenumber · doubleRequired

maxQuantityinteger · int64Required

minQuantityinteger · int64Required

organizationIdinteger · int32Required

resourceIdinteger · int32Required

availabilityOrderIdinteger · int64Required

availabilityTransactionIdinteger · int64 · nullableRequired

clearingStatusall ofRequired

integer · enumOptionalPossible values:

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

post

/api/product/offer/availability/resource/{resourceId}

HTTPcURLJavaScriptPython

POST /api/product/offer/availability/resource/{resourceId} HTTP/1.1
Host: api.switchmarket.se
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "organizationId": 1,
  "offers": [
    {
      "availabilityOrderId": 1,
      "activationPrice": 1,
      "maxQuantity": 1,
      "minQuantity": 1
    }
  ]
}

[
  {
    "createdBy": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "impactValue": 1,
    "activationPrice": 1,
    "maxQuantity": 1,
    "minQuantity": 1,
    "organizationId": 1,
    "resourceId": 1,
    "availabilityOrderId": 1,
    "availabilityTransactionId": 1,
    "clearingStatus": 0
  }
]

Update availability offers

put

Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement

Path parameters

resourceIdinteger · int32Required

The identifier of the resource.

Body

application/json

Responses

200

List of availability offers

application/json

createdByinteger · int32 · nullableRequired

createdAtstring · date-timeRequired

expiresAtstring · date-timeRequired

impactValuenumber · doubleRequired

activationPricenumber · doubleRequired

maxQuantityinteger · int64Required

minQuantityinteger · int64Required

organizationIdinteger · int32Required

resourceIdinteger · int32Required

availabilityOrderIdinteger · int64Required

availabilityTransactionIdinteger · int64 · nullableRequired

clearingStatusall ofRequired

integer · enumOptionalPossible values:

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

put

/api/product/offer/availability/resource/{resourceId}

HTTPcURLJavaScriptPython

PUT /api/product/offer/availability/resource/{resourceId} HTTP/1.1
Host: api.switchmarket.se
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "organizationId": 1,
  "offers": [
    {
      "availabilityOrderId": 1,
      "activationPrice": 1,
      "maxQuantity": 1,
      "minQuantity": 1
    }
  ]
}

[
  {
    "createdBy": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "impactValue": 1,
    "activationPrice": 1,
    "maxQuantity": 1,
    "minQuantity": 1,
    "organizationId": 1,
    "resourceId": 1,
    "availabilityOrderId": 1,
    "availabilityTransactionId": 1,
    "clearingStatus": 0
  }
]

Delete availability offers

delete

Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement

Path parameters

resourceIdinteger · int32Required

The identifier of the resource.

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

availabilityOrderIdinteger · int64[]Required

The identifiers of the availability orders

Responses

204

The availability offers were deleted

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

delete

/api/product/offer/availability/resource/{resourceId}

HTTPcURLJavaScriptPython

DELETE /api/product/offer/availability/resource/{resourceId}?organizationId=1&availabilityOrderId=1 HTTP/1.1
Host: api.switchmarket.se
Accept: */*

No content

Get cleared availability offers

get

Required permissions: Order.Organization.Read Required features: DecisionSupport

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

List of availability offers

application/json

createdByinteger · int32 · nullableRequired

createdAtstring · date-timeRequired

expiresAtstring · date-timeRequired

impactValuenumber · doubleRequired

activationPricenumber · doubleRequired

maxQuantityinteger · int64Required

minQuantityinteger · int64Required

organizationIdinteger · int32Required

resourceIdinteger · int32Required

availabilityOrderIdinteger · int64Required

availabilityTransactionIdinteger · int64 · nullableRequired

clearingStatusall ofRequired

integer · enumOptionalPossible values:

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/offer/availability/cleared

HTTPcURLJavaScriptPython

GET /api/product/offer/availability/cleared?organizationId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "createdBy": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "impactValue": 1,
    "activationPrice": 1,
    "maxQuantity": 1,
    "minQuantity": 1,
    "organizationId": 1,
    "resourceId": 1,
    "availabilityOrderId": 1,
    "availabilityTransactionId": 1,
    "clearingStatus": 0
  }
]

Get cleared availability schedule offers

get

Required permissions: Order.Organization.Read Required features: DecisionSupport

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

Responses

200

List of availability schedule offers

application/json

resourceIdinteger · int32Required

organizationIdinteger · int32Required

availabilityScheduleOrderIdinteger · int64Required

availabilityScheduleTransactionIdinteger · int64 · nullableRequired

createdByinteger · int32 · nullableRequired

createdAtstring · date-timeRequired

expiresAtstring · date-timeRequired

impactValuenumber · doubleRequired

activationPricenumber · doubleRequired

maxQuantityinteger · int64Required

minQuantityinteger · int64Required

enduranceinteger · int32 · nullableRequired

cooldowninteger · int32 · nullableRequired

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/offer/availabilityschedule/cleared

HTTPcURLJavaScriptPython

GET /api/product/offer/availabilityschedule/cleared?organizationId=1 HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "resourceId": 1,
    "organizationId": 1,
    "availabilityScheduleOrderId": 1,
    "availabilityScheduleTransactionId": 1,
    "createdBy": 1,
    "createdAt": "2026-03-12T02:13:57.694Z",
    "expiresAt": "2026-03-12T02:13:57.694Z",
    "impactValue": 1,
    "activationPrice": 1,
    "maxQuantity": 1,
    "minQuantity": 1,
    "endurance": 1,
    "cooldown": 1
  }
]

Get settlement specification

get

Required permissions: Order.Organization.Read Required features: Settlements

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

startstring · date-timeRequired

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'.

endstring · date-timeRequired

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'.

Responses

200

The settlement specification

application/json

organizationIdinteger · int32Required

startstring · date-timeRequired

endstring · date-timeRequired

isFinalizedPeriodbooleanRequired

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/settlement/specification

HTTPcURLJavaScriptPython

GET /api/product/settlement/specification?organizationId=1&start=2026-03-12T02%3A13%3A57.694Z&end=2026-03-12T02%3A13%3A57.694Z HTTP/1.1
Host: api.switchmarket.se
Accept: */*

{
  "organizationId": 1,
  "start": "2026-03-12T02:13:57.694Z",
  "end": "2026-03-12T02:13:57.694Z",
  "isFinalizedPeriod": true,
  "bought": [
    {
      "resourceId": 1,
      "organizationId": 1,
      "availabilityQuantity": 1,
      "activationQuantity": 1,
      "availabilityRemuneration": 1,
      "activationRemuneration": 1,
      "hasNonValidatedData": true,
      "revalidationPossible": true,
      "transactions": [
        {
          "type": 0,
          "productType": 0,
          "start": "2026-03-12T02:13:57.694Z",
          "end": "2026-03-12T02:13:57.694Z",
          "totalQuantity": 1,
          "unitPrice": 1,
          "deliveryPercentage": 1,
          "remunerationPercentage": 1,
          "remuneration": 1
        }
      ]
    }
  ],
  "sold": [
    {
      "resourceId": 1,
      "organizationId": 1,
      "availabilityQuantity": 1,
      "activationQuantity": 1,
      "availabilityRemuneration": 1,
      "activationRemuneration": 1,
      "hasNonValidatedData": true,
      "revalidationPossible": true,
      "transactions": [
        {
          "type": 0,
          "productType": 0,
          "start": "2026-03-12T02:13:57.694Z",
          "end": "2026-03-12T02:13:57.694Z",
          "totalQuantity": 1,
          "unitPrice": 1,
          "deliveryPercentage": 1,
          "remunerationPercentage": 1,
          "remuneration": 1
        }
      ]
    }
  ]
}

Get settlement specification for schedules

get

Required permissions: Order.Organization.Read Required features: Settlements

Query parameters

organizationIdinteger · int32Required

The identifier of the organization.

Responses

200

The settlement specification for schedules

application/json

organizationIdinteger · int32Required

400

Input data was invalid

application/json

401

Not authorized

application/json

403

Not allowed

application/json

500

Internal server error

get

/api/product/settlement/schedule/specification

HTTPcURLJavaScriptPython

GET /api/product/settlement/schedule/specification?organizationId=1 HTTP/1.1
Host: api.switchmarket.se
Accept: */*

{
  "organizationId": 1,
  "bought": [
    {
      "resourceId": 1,
      "organizationId": 1,
      "start": "2026-03-12T02:13:57.694Z",
      "end": "2026-03-12T02:13:57.694Z",
      "deliveredQuantity": 1,
      "activationCount": 1,
      "validationCount": 1,
      "hasNonValidatedData": true,
      "revalidationPossible": true,
      "remuneration": 1,
      "remunerationPenalty": 1,
      "ordersBelowThreshold": 1
    }
  ],
  "sold": [
    {
      "resourceId": 1,
      "organizationId": 1,
      "start": "2026-03-12T02:13:57.694Z",
      "end": "2026-03-12T02:13:57.694Z",
      "deliveredQuantity": 1,
      "activationCount": 1,
      "validationCount": 1,
      "hasNonValidatedData": true,
      "revalidationPossible": true,
      "remuneration": 1,
      "remunerationPenalty": 1,
      "ordersBelowThreshold": 1
    }
  ]
}