Skip to content

Get History of the Order Status

Request

Get history of the order status by orderId

Security
api-key
Path
orderIdanyrequired
GET
/public-api/1.0/electricity/orders/status/{orderId}
curl -i -X GET \
  'https://acc-trading.etpa.nl/public-api/1.0/electricity/orders/status/{orderId}' \
  -H 'api_key: YOUR_API_KEY_HERE'

Responses

Order status response

Bodyapplication/json
orderIdstringrequired

The orderId is the created by Order api as a response from put/post order request.

basketIdobject(BasketId)

The id of the Basket order.

individualIdstringrequired

Identifier of the individual that created the order.

participantIdstringrequired

The participant identifier of the participant to which the order belongs.

currentStatusobject(OrderStatusItem)required

The last situation of order.

historyArray of objects(OrderStatusItem)required

The whole processes of order.

Response
{
  "orderId": "string",
  "basketId": {
    "identifier": "string"
  },
  "individualId": "string",
  "participantId": "string",
  "currentStatus": {
    "status": "CREATED / UPDATED / COMPLETED / CANCELLED / FAILED",
    "reason": "string",
    "createdTime": 1576663249398
  },
  "history": [
    { … }
  ]
}