Create an Order

POST /v2/orders/

API version

v2

Request method

POST

Operation ID

order-create-order

---

Request

Responses

Format

application/json

Description

Schema documentation

• orderIdstring

  required

Example

null

JSON Schema

{
  "properties": {
    "orderId": {
      "type": "string"
    }
  },
  "required": [
    "orderId"
  ]
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"orderData":{"customerId":"string","description":"My first project","diskspaceInGiB":10,"promotionCode":"123456","spec":{"machineType":"prospace.2cpu.4gb"},"useFreeTrial":true},"orderType":"projectHosting"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/orders

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.contract.orderCreateOrder({
  "data": {
    "orderData": {
      "customerId": "string",
      "description": "My first project",
      "diskspaceInGiB": 10,
      "promotionCode": "123456",
      "spec": {
        "machineType": "prospace.2cpu.4gb"
      },
      "useFreeTrial": true
    },
    "orderType": "projectHosting"
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Contract\OrderCreateOrder\OrderCreateOrderRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Contract\OrderCreateOrder\OrderCreateOrderRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// OrderCreateOrderRequestBody to learn how to construct a valid instance
$body = new OrderCreateOrderRequestBody(/* TODO: ... */);

$request = (new OrderCreateOrderRequest(
  body: $body
));
$response = $client->contract()->orderCreateOrder($request);

var_dump($response->getBody();