Create an Order

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://developer.cloudcockpit.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "CloudCockpit MCP server": {
    "url": "https://developer.cloudcockpit.com/mcp"
  }
}

POST /v1/Orders

Bearer auth

Creates a new Order with the provided OrderViewModel and returns a model with the created order id. The order is created asynchronously. If the provider does not answer in time, the order moves to the PendingConfirmation status while the system checks whether the provider created it. Do not create the same order again until it leaves that status. When the tenant has the similar order warning enabled and an equivalent order (same customer, provider instance, offer, billing frequency, term and quantity) may already exist on the provider, the request is answered with 409 and a body with the code "similar_request_unconfirmed" and the equivalent orders. Send the order again with "confirmSimilarOrder": true to create it anyway.

Headers

X-Tenant string Required

The domain used to access the portal.
Authorization string Required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Default value is Bearer eyJ0eXAiO....
X-Correlation-Id string(uuid)

This header is optional and by setting it you can correlate the audit logs made by this request.

application/json

Body

The order info to create the order.

id string(uuid)

The GUID identifier for the order.
offerId string(uuid) Required

The GUID identifier for the offer.
customerId string(uuid) Required

The GUID identifier for the customer.
resellerId string(uuid) | null

The GUID identifier for the reseller.
providerInstanceId string(uuid) Required

The GUID identifier for the provider instance.
subscriptionName string | null Required

The name to set in the subscription created by this order. This may be up to 255 characters.
termDuration object Required

The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears

Additional properties are NOT allowed.
billingFrequency object Required

The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None

Additional properties are NOT allowed.
segment object Required

The offer segment. Possible values: Commercial, Education, Government or NonProfit

Additional properties are NOT allowed.
operation object Required

The order operation type. Possible values: CreateSubscription

Additional properties are NOT allowed.
quantity integer(int32) Required

The quantity of licenses to provision for this order.
subscriptionMargin object

This value object contains the price margin for this entity.

Additional properties are NOT allowed.
Hide subscriptionMargin attribute Show subscriptionMargin attribute object
- marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
subscriptionInternalId string | null

The internal identifier to set in the subscription created by this order. This may be up to 255 characters.
poNumber string | null

The po number to set in the subscription created by this order. This may be up to 255 characters.
autoRenew object

Represents the action to take when a subscription reaches its end of term.

Additional properties are NOT allowed.
status object Required

The status of the order. Possible values: Processing, Provisioning, Provisioned, Completed, Failed, PendingPOUpload, POUploadComplete, Suspended or PendingConfirmation

Additional properties are NOT allowed.
createdDate string(date-time)

The date in which this order was created.
providerData string | null

The provider specific data for this order. For generic provider subscriptions, this should not be set.
parentSubscriptionId string(uuid) | null

The GUID identifier for the parent subscription of this order.
confirmSimilarOrder boolean

Set to true to create the order even though an equivalent order was sent to the provider and is not confirmed yet. When false, such an order is answered with a 409 listing the equivalent orders.
errorMessage string | null

The error message if status is failed.
providerOfferId string | null

The provider's offer identifier.
orderedByEmail string | null

The email of the user who placed the order.

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- orderId string(uuid)
  
  The id of the order that was created on CloudCockpit.
400 application/json

Bad Request
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
401

Unauthorized
403

Forbidden
409 application/json

Conflict
Hide response attributes Show response attributes object
- code string | null
  
  Identifies the kind of conflict. Always Application.Common.Models.SimilarRequestUnconfirmedViewModel.ConflictCode.
- requests array[object] | null
  
  The unconfirmed requests that are equivalent to the one being sent.
  
  Hide requests attributes Show requests attributes object
  
  An unconfirmed request that is equivalent to the one being sent.
  
  id string(uuid)
  
  The id of the order or subscription of the earlier request.
  
  kind string | null
  
  The kind of request: order or upgrade.
  
  createdDate string(date-time)
  
  When the earlier request was created (UTC).
  
  status string | null
  
  The status name of the earlier request, for example pending_confirmation.
  
  quantity integer(int32) | null
  
  The quantity of the earlier request.
  
  offerName string | null
  
  The name of the offer of the earlier request.
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.

POST /v1/Orders

curl \
 --request POST 'https://api.cloudcockpit.com/v1/Orders' \
 --header "Content-Type: application/json" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string" \
 --data '{
  "id": "string",
  "offerId": "string",
  "customerId": "string",
  "resellerId": "string",
  "providerInstanceId": "string",
  "subscriptionName": "string",
  "termDuration": {},
  "billingFrequency": {},
  "segment": {},
  "operation": {},
  "quantity": 42,
  "subscriptionMargin": {
    "marginRule": {}
  },
  "subscriptionInternalId": "string",
  "poNumber": "string",
  "autoRenew": {},
  "status": {},
  "createdDate": "2026-05-04T09:42:00Z",
  "providerData": "string",
  "parentSubscriptionId": "string",
  "confirmSimilarOrder": true,
  "errorMessage": "string",
  "providerOfferId": "string",
  "orderedByEmail": "string"
}'

Request examples

# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "id": "string",
  "offerId": "string",
  "customerId": "string",
  "resellerId": "string",
  "providerInstanceId": "string",
  "subscriptionName": "string",
  "termDuration": {},
  "billingFrequency": {},
  "segment": {},
  "operation": {},
  "quantity": 42,
  "subscriptionMargin": {
    "marginRule": {}
  },
  "subscriptionInternalId": "string",
  "poNumber": "string",
  "autoRenew": {},
  "status": {},
  "createdDate": "2026-05-04T09:42:00Z",
  "providerData": "string",
  "parentSubscriptionId": "string",
  "confirmSimilarOrder": true,
  "errorMessage": "string",
  "providerOfferId": "string",
  "orderedByEmail": "string"
}

Response examples (200)

{
  "orderId": "573b2955-f31f-4edd-9a52-0226e0b0111f"
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (409)

{
  "code": "string",
  "requests": [
    {
      "id": "string",
      "kind": "string",
      "createdDate": "2026-05-04T09:42:00Z",
      "status": "string",
      "quantity": 42,
      "offerName": "string"
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}