Magidoc

SellOrderDataPortalResult
Object

Sell Order Result with the same flatten structure as in DataPortal without additional information

Fields

#

basketID

Non-null

The ID for the Basket bid in the auction (generated by EAC).

reasonRejected

Code of the reason of rejections. Or null if the order is fully accepted.

basketActualSurplus

Non-null

Sum of the actual surpluses of all orders in a basket.

orderVirtualSurplus

Non-null

The money that would have been made by the order if it was fully accepted without impacting the clearing prices. This surplus is computed by multiplying the total quantity of the order (positive for sell orders, negative for buy orders) by the difference between the clearing price and the order price. For parent/child sell orders, this surplus is the sum of the surplus generated for each product (service).

basketFamilyVirtualSurplus

Non-null

Sum of the virtual surpluses of all baskets in a family.

registeredAuctionParticipant

Non-null

Participant who submitted the bid.

auctionProduct

Non-null

The service associated to this result in its 3 letters code, for example "DCL". It is consistent with the service type.

basketFamilyActualSurplus

Non-null

Sum of the actual surpluses of all baskets in a family.

productID

Non-null

Linked Id to group the sell orders with different services but belonging to the same parent, child or substitutable child order. This id is a number from 1 to 21 which with the basket id identifies uniquely a parent, child or substitutable child order.

quantity

Non-null

The total volume [MW] of the bid. The value is a positive integer or zero.

status

Non-null

Result status of an order after a successful auction run.

executedQuantity

Non-null

The quantity of the order which is executed.

orderID

Non-null

The ID for the submitted bid in the auction.

acceptanceRatio

Non-null

A number between 0 and 1 with up to 8 decimals, indicating the proportion of an offered quantity which has been matched by the auction algorithm.

orderEntryUser

Non-null

The user who submitted the order.

deliveryStart

Non-null

The time at which the delivery of the auction product will commence.

orderType

Non-null

Type of order, "P" for Parent, "C" for Child or "SC" for Substitutable Child.

clearingPrice

Non-null

Market clearing price [pounds] of the auction product.

priceLimit

Non-null

The price [pounds] for the provision of the service.

auctionUnit

Non-null

The unit the order is associated to. An auction unit is a collection of one or more eligible assets registered at the relevant time as described in the registration and pre-qualification procedure.

deliveryEnd

Non-null

The time from which delivery of the Auction Product will end

basketVirtualSurplus

Non-null

The money that would have been made by the basket if its parent and its profitable children (only the most profitable for substitutable children) were fully accepted without impacting the clearing prices. The basket surplus is the sum of the parent virtual surplus and the virtual surplus transferred from its children.

orderActualSurplus

Non-null

Product of the executed quantity (positive for sell orders, negative for buy orders) and the difference between the clearing price and the order price limit. This surplus is zero for rejected orders. For parent/child sell orders, this surplus is the sum of the surplus generated for each product.

loopedBasketID

Identifier of a family of looped baskets. This field is non-null only for parent orders of looped baskets.

serviceType

Non-null

The service type associated to this result, for example "Response". It is consistent with the service.

orderEntryTime

The time at which the bid was submitted.

auctionID

Non-null

Unique auction identifier. All products auctioned in the same market.

Usages

#

References

#