List all offers

GET /v1/Offers

Returns a list the offers in the tenant. The offers are returned sorted by SortPropertyName. If a customer is not provided in the query params the offer prices will not be scoped to one market. To view the offer prices for a certain customer/market provide the desired customer.

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.

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 customers by. Possible values: Name

  • AscendingOrder boolean

    The value indicating whether to sort in ascending order. If set to true [ascending order].

  • OfferTypes string Required

    A string containing the OfferTypes to filter by. This string is a list separated by |. ex: License|AzurePlan

  • ProviderInstanceId string(uuid)

    The GUID identifier for the provider instance.

  • SearchValue string

    The search query string.

  • SearchField string

    The field to search in. Possible values: Name or ProviderOfferId

  • Segment string Required

    The string indicating which segment to get the offers from. Possible values: Commercial, Education, Government or NonProfit

  • CustomerId string(uuid)

    GUID Unique identifier for the customer. If none is set the offers prices will no be scoped to one market, for normal use set this property. When the user is a customer this property will be auto-populated.

  • ResellerId string(uuid)

    GUID Unique identifier for the reseller. When this property is set the offer prices will have the corresponding margins applied. Only usable for CSPs.

  • IncludeDeleted boolean

    The value indicating whether to include deleted offers in the offers list. Deprecated offers will also appear as deleted in the list.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • items array[object] | null

      The items for this page.

      View model that represents an offer item for listing purposes.

      Hide items attributes Show items attributes object
      • id string(uuid)

        GUID Unique identifier for the offer.

      • name string | null

        The name of the offer.

      • description string | null

        The offer description.

      • imageUrl string | null

        The offer image URL.

      • offerType object

        The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

        Additional properties are NOT allowed.

        Hide offerType attribute Show offerType attribute object
        • name string | null

          The name of the enumeration.

      • billingType object

        The billing type for the offer. Possible values: License, Usage or None

        Additional properties are NOT allowed.

        Hide billingType attribute Show billingType attribute object
        • name string | null

          The name of the enumeration.

      • price object

        View model that represents an offer price.

        Additional properties are NOT allowed.

        Hide price attributes Show price attributes object
        • termDuration object

          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.

        • segment object

          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.

        • region object

          Additional properties are NOT allowed.

          Hide region attribute Show region attribute object
          • value string | null

            The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

        • billingFrequencies array[object] | null

          The offer price Billing Frequencies.

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

          Hide billingFrequencies attribute Show billingFrequencies attribute object
          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

            Hide currency attribute Show currency attribute object
            • name string | null

              The name of the currency.

        • revenuePrice object

          Additional properties are NOT allowed.

          Hide revenuePrice attributes Show revenuePrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

            Hide currency attribute Show currency attribute object
            • name string | null

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

            Hide currency attribute Show currency attribute object
            • name string | null

              The name of the currency.

      • providerName string | null

        The name of the provider this offer belongs to.

      • isAddon boolean

        The value indicating whether this offer is an addon.

      • providerOfferId string | null

        The provider's offer identifier.

      • isDeleted boolean

        A Value indicating whether this offer is deleted and cannot be provisioned.

      • termOfferPrices array[object] | null

        The offer prices for each term

        Hide termOfferPrices attributes Show termOfferPrices attributes object
        • termDuration object

          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.

        • billingFrequencies array[object] | null

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

          Hide billingFrequencies attribute Show billingFrequencies attribute object
          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

            Hide currency attribute Show currency attribute object
            • name string | null

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

            Hide currency attribute Show currency attribute object
            • name string | null

              The name of the currency.

      • isDisabled boolean

        A Value indicating whether this offer is disabled and cannot be provisioned.

    • 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

    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.

      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.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

    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.

      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.
  • 500

    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.

      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.
GET /v1/Offers 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Offers?OfferTypes=string&Segment=string' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"