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

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

Close
POST /v1/Orders

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.

  • promotionId string(uuid) | null

    The catalog promotion to check/apply for this order, if any.

  • confirmedDiscountedPrice number(double) | null

    The line item price Partner Center confirmed on the cart, once it resolved the promotion. Only set on the cart checkout path; null otherwise, including for orders placed before this field existed.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • orderId string(uuid)

      The id of the order that was created on CloudCockpit.

    • promotionResult object

      Outcome of checking a single requested promotion for a purchase/upgrade/renewal. Always returned to the caller (never swallowed) so the UI can show why a promotion wasn't applied.

      Additional properties are NOT allowed.

      Hide promotionResult attributes Show promotionResult attributes object
      • isVerified boolean

        False only when Partner Center couldn't be reached or failed (429/timeout/error) — distinct from a verified ineligibility. Callers must not apply/promise a promotion in either case.

      • appliedPromotion object

        An owned, immutable snapshot of the promotion terms in effect when an order/subscription was created.

        Additional properties are NOT allowed.

        Hide appliedPromotion attributes Show appliedPromotion attributes object
        • providerPromotionId string | null

          The microsoft promotion id.

        • name string | null

          The promotion display name.

        • discountType string | null

          The pricing policy type of the promotion. (Ex.: "PercentageDiscount", etc.)

        • discountValue number(double) | null

          The discount value of the promotion. (Ex.: 0.05, etc.) Null until resolved against the catalog.

        • startDate string(date-time) | null

          The start of the promotion's benefit period for the subscription it was applied to (the start of the subscription term). Null when it could not be determined.

        • endDate string(date-time) | null

          The end of the promotion's benefit period for the subscription it was applied to (the start of the subscription term plus the term duration). Null when it could not be determined or the term has no end.

      • reasons array[object] | null

        Populated when a promotion was requested but not applied. Empty when applied or when no promotion was requested at all.

        Hide reasons attributes Show reasons attributes object
        • type integer(int32)

          Values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, or 10.

        • description string | null
        • minimumRequiredSeats integer(int32) | null

          Populated only when Application.Promotions.Results.PromotionIneligibilityReason.Type is Application.Promotions.Results.PromotionIneligibilityReasonType.SeatCount.

        • maximumRequiredSeats integer(int32) | null

          Populated only when Application.Promotions.Results.PromotionIneligibilityReason.Type is Application.Promotions.Results.PromotionIneligibilityReasonType.SeatCount.

        • availableSeats integer(int32) | null

          Populated only when Application.Promotions.Results.PromotionIneligibilityReason.Type is Application.Promotions.Results.PromotionIneligibilityReasonType.SeatCount.

        • excludedProductsTerms array[object] | null

          Populated only when Application.Promotions.Results.PromotionIneligibilityReason.Type is Application.Promotions.Results.PromotionIneligibilityReasonType.OffersPurchasedPreviously.

          Hide excludedProductsTerms attributes Show excludedProductsTerms attributes object
          • bigId string | null
          • termDuration string | null
      • availablePromotions array[object] | null

        Populated only in "discovery mode" (no specific promotion was requested): the promotions this customer/offer is currently eligible for AND that Microsoft auto-applies without a partner having to request them. This is informational only — nothing here is applied by us or sent to Microsoft; Microsoft applies it on its own once the eligibility requirements are met. Always empty when a specific promotion was requested (see Application.Promotions.Results.PromotionEligibilityCheckOutcome.AppliedPromotion/Application.Promotions.Results.PromotionEligibilityCheckOutcome.Reasons instead).

        Hide availablePromotions attributes Show availablePromotions attributes object

        An owned, immutable snapshot of the promotion terms in effect when an order/subscription was created.

        • providerPromotionId string | null

          The microsoft promotion id.

        • name string | null

          The promotion display name.

        • discountType string | null

          The pricing policy type of the promotion. (Ex.: "PercentageDiscount", etc.)

        • discountValue number(double) | null

          The discount value of the promotion. (Ex.: 0.05, etc.) Null until resolved against the catalog.

        • startDate string(date-time) | null

          The start of the promotion's benefit period for the subscription it was applied to (the start of the subscription term). Null when it could not be determined.

        • endDate string(date-time) | null

          The end of the promotion's benefit period for the subscription it was applied to (the start of the subscription term plus the term duration). Null when it could not be determined or the term has no end.

  • 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",
  "promotionId": "string",
  "confirmedDiscountedPrice": 42.0
}'
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",
  "promotionId": "string",
  "confirmedDiscountedPrice": 42.0
}
Response examples (200)
{
  "orderId": "573b2955-f31f-4edd-9a52-0226e0b0111f",
  "promotionResult": {
    "isVerified": true,
    "appliedPromotion": {
      "providerPromotionId": "string",
      "name": "string",
      "discountType": "string",
      "discountValue": 42.0,
      "startDate": "2026-05-04T09:42:00Z",
      "endDate": "2026-05-04T09:42:00Z"
    },
    "reasons": [
      {
        "type": 0,
        "description": "string",
        "minimumRequiredSeats": 42,
        "maximumRequiredSeats": 42,
        "availableSeats": 42,
        "excludedProductsTerms": [
          {
            "bigId": "string",
            "termDuration": "string"
          }
        ]
      }
    ],
    "availablePromotions": [
      {
        "providerPromotionId": "string",
        "name": "string",
        "discountType": "string",
        "discountValue": 42.0,
        "startDate": "2026-05-04T09:42:00Z",
        "endDate": "2026-05-04T09:42:00Z"
      }
    ]
  }
}
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"
      ]
    }
  ]
}