Skip to content

Create Basket Order

Request

Creates new basket order. When creating a new basket order, you must select the Execution Type

  • "NONE": All orders in the order list are executed individually.
  • "VALID": All orders must be valid orders. If 1 order is invalid, none of the orders are executed.
  • "LINKED": All orders in the order list must be matched immediately. If 1 order does not match immediately, all orders in the order list are canceled.
Security
api-key
Query
callbackurlstring

Callback to return the Id of the order to after initial processing by our system. The callback url will receive a GET request with a parameter named 'id' containing the order Id. Due to the order being created asynchronously, the status cannot be returned by the current http request. After receive of the Id the order can be traced using the Server Sent Event.

Bodyapplication/jsonrequired
basketExecutionTypestringrequired

Basket execution type

Enum:"NONE""VALID""LINKED"
Example:"NONE / VALID / LINKED"
orderListArray of objects(XbidOrderRequest)required

List of order requests

allowedForLocalMarketboolean

When this field is true the full basket order is allowed to go to the local market, regardless of the allowedForLocalMarket field in the individual ordersIf this field is false the basket order will be rejected and will not be sent to the local market if XBID is down.

Example:false
POST
/public-api/1.0/xbid/electricity/orders/basket
curl -i -X POST \
  'https://acc-trading.etpa.nl/public-api/1.0/xbid/electricity/orders/basket?callbackurl=string' \
  -H 'Content-Type: application/json' \
  -H 'api_key: YOUR_API_KEY_HERE' \
  -d '{
    "basketExecutionType": "NONE / VALID / LINKED",
    "orderList": [
      {
        "orderType": "BUY / SELL",
        "xbidOrderType": "REGULAR / ICEBERG",
        "participantId": "292c3db8-3ee1-4999-bbed-d579225d1596",
        "capacity": 2,
        "deliveryStartTime": 1465596000000,
        "deliveryEndTime": 1465682400000,
        "unitPrice": 35,
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "customExpirationTime": 1465682400000,
        "orderDeliveryArea": "NL / NL - TTN / 10YNL----------L",
        "orderStatus": "ACTIVE / HIBERNATE",
        "orderExecution": "NON / FOK / IOC ",
        "allowedForLocalMarket": false,
        "orderVersion": {
          "revisionNo": 0,
          "xbidOrderId": 0
        },
        "showCapacity": 2,
        "pricePerDelta": 2
      }
    ],
    "allowedForLocalMarket": false
  }'

Responses

OK

Bodyapplication/json
successstringrequired
invalidOrdersArray of objects(InvalidOrderRequest)required
validOrdersArray of objects(ValidOrderRequest)required
Response
{
  "link": {
    "href": "string",
    "hreflang": "string",
    "title": "string",
    "type": "string",
    "deprecation": "string",
    "profile": "string",
    "name": "string",
    "templated": true
  },
  "success": "string",
  "invalidOrders": [
    { … }
  ],
  "validOrders": [
    { … }
  ]
}