Market Status Codes

List of status codes¶

Here you find a list of status codes used in the GLocalFlex Marketplace API.

Data Model¶

{
  "order": {"status": "",},
  // list of contracts is created for each trade
  "contracts": [
              {"status": "",
               "settlement": {"status": ""}, // settlement object for each contract 
               "verification_result": {"status": ""} // verification result
              } 
              ], 

  // only sell orders verification data, baseline and metering data
  "verification": {"status": ""}, 
}

List of status codes¶

Order Status	Description
`pending`	Order received
`awaiting_baseline_data`	Only for sell orders, waiting for user input via REST API
`selected_for_baseline_activation`	Selected for baseline verification (alternative)
`accepted`	Order stored
`matching_active`	Added to matching engine
`filled`	Fully filled
`partial_filled`	Partially filled order (only applies to buy orders)
`cancelled`	Order cancelled by user
`expired`	Order expired by set expiry time at order creation or automatically 15 min before delivery start time

Settlement Status	Description
`awaiting_verification_completion`	Waiting for verification to be completed
`ready_not_initiated`	Ready but not yet initiated
`processing_settlement`	Internal processing settlement service
`initiated`	Process has started
`completed_success`	Successfully completed
`completed_error`	Completed with an error
`completed_failed`	Alternative to `completed_error`

Verification Status	Description
`awaiting_baseline_data`	User needs to baseline forecast
`baseline_received`	Received baseline but not checked if it matches order start and end time
`baseline_accepted`	Condition to add to matching engine fulfilled
`baseline_rejected`	Baseline check failed (alternative)
`awaiting_metering_data`	User needs to submit metering log
`ready_not_initiated`	Baseline and metering received, ready to initiate verification
`processing_verification`	Internal processing verification service
`completed_success`	Verification passed, within a threshold
`completed_error`	Verification calculation succeeded, but delivered flexibility is not within the threshold (alternative)
`completed_failed`	Verification calculation failed (alternative)

Contract Status	Description
`processing_settlement`	Internal processing for settlement
`processing_verification`	Internal processing for verification
`awaiting_metering_data`	Waiting for user input through REST API
`awaiting_flexibility_activation`	Waiting for user flexibility activation
`awaiting_baseline_activation`	Waiting for user to follow its baseline
`ready_for_verification`	Order delivery end passed, ready for verification
`ready_for_settlement`	Verification passed, ready for settlement
`completed_success`	Contract completed successfully
`completed_error`	Contract completed with an error
`delivery_activation_confirmed`	Client confirmed delivery through REST API (not implemented)
`delivery_activation_unconfirmed`	Client did not confirm delivery through REST API (not implemented)
`delivery_failure`	Client informs delivery not possible due to technical reasons (not implemented)

Examples formats for each data model object¶

Order object¶

Complete order object that can be retrieved from /api/v1/order/{order_id} or /api/v1/orders/.

name="__codelineno-1-1"> "order": { "order_id": "string", // UUID format "user_id": "string", // UUID format "last_updated_at": "string", // ISO 8601 date-time format "created_at": "string", // ISO 8601 date-time format "filled_at": "string", // ISO 8601 date-time format "status": "string", // e.g., "filled" "direction": "string", // e.g., "up" or "down" "energy_initial": "integer", // in Ws "energy_remaining": "integer", // in Ws "side": "string", // e.g., "buy" or "sell" "power": "float", // in W "price": "float", // unit price Eur/kWh "delivery_start": "string", // ISO 8601 date-time format "delivery_end": "string", // ISO 8601 date-time format "expiry_time": "string", // ISO 8601 date-time format "location": { "location_id": [ "string" // UUID format ], "country_code": "string" // ISO 3166-1 alpha-2 country code } }

Contract object¶

Complete contract object that can be retrieved from /api/v1/contract/{contract_id} or /api/v1/contracts/.

  "contract": {
    "created_at": "string", // ISO 8601 date-time format
    "last_updated_at": "string", // ISO 8601 date-time format
    "contract_id": "string", // UUID format
    "user_id": "string", // UUID format
    "order_id": "string", // UUID format
    "status": "string", // e.g., "completed_success"
    "verification_completed": "boolean",
    "settlement_completed": "boolean",
    "trade": {
      "trade_id": "string", // UUID format
      "seller_user_id": "string", // UUID format
      "seller_order_id": "string", // UUID format
      "buyer_user_id": "string", // UUID format
      "buyer_order_id": "string", // UUID format
      "closed_at": "string", // ISO 8601 date-time format
      "power": "float", // in W
      "price": "float", // unit price Eur/kWh
      "delivery_start": "string", // ISO 8601 date-time format
      "delivery_end": "string", // ISO 8601 date-time format
      "direction": "string", // e.g., "up" or "down"
      "duration": "integer", // in seconds
      "energy": "integer" // in Ws
    },
    "settlement": {
      "settlement_id": "string", // UUID format
      "status": "string" // e.g., "completed_success"
    },
    "verification": {
      "verification_id": "string", // UUID format
      "status": "string", // e.g., "completed_success"
      "result": {
        "created_at": "string", // ISO 8601 date-time format
        "scheduled": "float", // volume from trade event in kWh
        "delivered": "float", // delivered flexibility in kWh
        "delivered_percentage": "float", // total delivered flexibility in percentage
        "delta_absolut": "float", // calculated flexibility delivered - flexibility scheduled in kWh
        "delta_percentage": "float", // (calculated flexibility delivered - flexibility scheduled) / flexibility scheduled * 100
        "unit": "string", // e.g., "kWh"
        "status": "string", // e.g., "success" or "error"
        "details": {
          "error": "string", // error code or description
          "message": "string" // detailed error message
        }
      }
    }
  }

Verification result object¶

Complete verification object that can be retrieved from /api/v1/verification (GET endpoint not implemented yet).

  "verification": {
    "verification_id": "string", // UUID format
    "status": "string", // e.g., "completed_success"
    "result": {
      "created_at": "string", // ISO 8601 date-time format
      "scheduled": "float", // volume from trade event in kWh
      "delivered": "float", // delivered flexibility in kWh
      "delivered_percentage": "float", // total delivered flexibility in percentage
      "delta_absolut": "float", // calculated flexibility delivered - flexibility scheduled in kWh
      "delta_percentage": "float", // (calculated flexibility delivered - flexibility scheduled) / flexibility scheduled * 100
      "unit": "string", // e.g., "kWh"
      "status": "string", // e.g., "success" or "error"
      "details": {
      "error": "string", // error code or description
      "message": "string" // detailed error message
      }
    }
  }