CloudCockpit API documentation

Create a Order

POST /v1/Orders

Creates a new Order with the provided OrderViewModel.

Headers

X-Tenant string Required

This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.
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
Hide termDuration attribute Show termDuration attribute
- Additional properties are NOT allowed
billingFrequency object Required

The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Hide billingFrequency attribute Show billingFrequency attribute
- Additional properties are NOT allowed
segment object Required

The offer segment. Possible values: Commercial, Education, Government or NonProfit
Hide segment attribute Show segment attribute
- Additional properties are NOT allowed
operation object Required

The order operation type. Possible values: CreateSubscription
Hide operation attribute Show operation attribute
- 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.
Hide subscriptionMargin attributes Show subscriptionMargin attributes
- marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  Hide marginRule attribute Show marginRule attribute
  
  Additional properties are NOT allowed
- 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.
autoRenewEnabled boolean

The flag indicating if we want to create the subscription in this order with auto renew enabled or not.
status object Required

The status of the order. Possible values: Processing, Provisioning, Completed or Failed
Hide status attribute Show status attribute
- 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.
errorMessage string | null

The error message if status is failed.
Additional properties are NOT allowed

Responses

• 200

text/plain

text/plain application/json text/json

Success
• 400

text/plain

text/plain application/json text/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
  
  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.
  
  Hide errors attributes Show errors attributes object
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
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
  
  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.
  
  Hide errors attributes Show errors attributes object
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
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
  
  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.
  
  Hide errors attributes Show errors attributes object
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 401

Unauthorized
• 403

Forbidden
• 500

text/plain

text/plain application/json text/json

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
  
  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.
  
  Hide errors attributes Show errors attributes object
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
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
  
  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.
  
  Hide errors attributes Show errors attributes object
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
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
  
  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.
  
  Hide errors attributes Show errors attributes object
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

POST /v1/Orders

curl \
 -X POST https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Orders \
 -H "Content-Type: application/json" \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string" \
 -d '{"id":"string","offerId":"string","customerId":"string","resellerId":"string","providerInstanceId":"string","subscriptionName":"string","termDuration":{},"billingFrequency":{},"segment":{},"operation":{},"quantity":42,"subscriptionMargin":{"marginRule":{}},"subscriptionInternalId":"string","poNumber":"string","autoRenewEnabled":true,"status":{},"createdDate":"2024-05-04T09:42:00+00:00","providerData":"string","parentSubscriptionId":"string","errorMessage":"string"}'

Request example

# Headers
X-Tenant: string
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",
  "autoRenewEnabled": true,
  "status": {},
  "createdDate": "2024-05-04T09:42:00+00:00",
  "providerData": "string",
  "parentSubscriptionId": "string",
  "errorMessage": "string"
}

Response examples (200)

"string"

Response examples (200)

"string"

Response examples (400)

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

Response examples (400)

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

Response examples (500)

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

Response examples (500)

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