List all active Orders

GET /v1/Orders/customers/{customerId}

Returns a list of this customers active orders. This includes all orders that do not have the status Completed. The orders are returned sorted by the specified created date, with the most recent orders appearing first.

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.

Path parameters

customerId string(uuid) Required

The GUID identifier for the customer.

Query parameters

pageNumber integer(int32)

A cursor for pagination across multiple pages of results. The default value is 1.
pageSize integer(int32)

The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.
sortPropertyName string

The name of the property to sort the orders by. Currently no possible values.
ascendingOrder boolean

if set to true [ascending order].
resellerId string(uuid)

The GUID identifier for the reseller.

Responses

200

text/plain

text/plain application/json text/json

OK
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Hide items attributes Show items attributes object
  
  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.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object Required
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  operation object Required
  
  The order operation type. Possible values: CreateSubscription
  
  Additional properties are NOT allowed.
  
  Hide operation attribute Show operation attribute object
  
  name string | null
  
  The name of the enumeration.
  
  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 attributes Show subscriptionMargin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  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.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Hide items attributes Show items attributes object
  
  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.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object Required
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  operation object Required
  
  The order operation type. Possible values: CreateSubscription
  
  Additional properties are NOT allowed.
  
  Hide operation attribute Show operation attribute object
  
  name string | null
  
  The name of the enumeration.
  
  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 attributes Show subscriptionMargin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  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.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Hide items attributes Show items attributes object
  
  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.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object Required
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  operation object Required
  
  The order operation type. Possible values: CreateSubscription
  
  Additional properties are NOT allowed.
  
  Hide operation attribute Show operation attribute object
  
  name string | null
  
  The name of the enumeration.
  
  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 attributes Show subscriptionMargin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  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.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
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
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  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.
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
  
  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.
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
  
  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
500

text/plain

text/plain application/json text/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
  
  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.
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
  
  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.
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
  
  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.

GET /v1/Orders/customers/{customerId}

curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Orders/customers/{customerId} \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "offerId": "string",
      "customerId": "string",
      "resellerId": "string",
      "providerInstanceId": "string",
      "subscriptionName": "string",
      "termDuration": {
        "name": "string"
      },
      "billingFrequency": {
        "name": "string"
      },
      "segment": {
        "name": "string"
      },
      "operation": {
        "name": "string"
      },
      "quantity": 42,
      "subscriptionMargin": {
        "marginRule": {
          "name": "string"
        },
        "value": 8
      },
      "subscriptionInternalId": "string",
      "poNumber": "string",
      "autoRenewEnabled": true,
      "status": {
        "name": "string"
      },
      "createdDate": "2024-05-04T09:42:00+00:00",
      "providerData": "string",
      "parentSubscriptionId": "string",
      "errorMessage": "string"
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "offerId": "string",
      "customerId": "string",
      "resellerId": "string",
      "providerInstanceId": "string",
      "subscriptionName": "string",
      "termDuration": {
        "name": "string"
      },
      "billingFrequency": {
        "name": "string"
      },
      "segment": {
        "name": "string"
      },
      "operation": {
        "name": "string"
      },
      "quantity": 42,
      "subscriptionMargin": {
        "marginRule": {
          "name": "string"
        },
        "value": 8
      },
      "subscriptionInternalId": "string",
      "poNumber": "string",
      "autoRenewEnabled": true,
      "status": {
        "name": "string"
      },
      "createdDate": "2024-05-04T09:42:00+00:00",
      "providerData": "string",
      "parentSubscriptionId": "string",
      "errorMessage": "string"
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "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"
      ]
    }
  ]
}