Retrieve an offer

GET /v1/Offers/{id}

Retrieves an offer with the specified GUID identifier.

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

  • id string(uuid) Required

    GUID Unique identifier for the offer.

Query parameters

  • providerInstanceId string(uuid) Required

    GUID Unique identifier for the provider instance.

  • customerId string(uuid)

    GUID Unique identifier for the customer.

  • resellerId string(uuid)

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

  • segment string Required

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

Responses

  • 200

    OK

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

      The id of 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.

    • prices array[object] | null

      The offer prices.

      View model that represents an offer price.

      Hide prices attributes Show prices 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 offer provider name.

    • providerInstanceId string(uuid) | null

      The provider's instance identifier.

    • isAddon boolean

      The value indicating whether this offer is addon.

    • minQuantity integer(int32)

      The minimum quantity for this offer.

    • maxQuantity integer(int32)

      The maximum quantity for this offer.

    • hasPreRequisites boolean

      The value indicating whether this offer has pre requisite offers.

    • preRequisites array[string] | null

      The list of pre requisite offers ids.

    • isTrial boolean

      The value indicating whether this offer is a trial.

    • providerOfferId string | null

      The provider's offer identifier.

    • isDeleted boolean

      A Value indicating whether this offer is deleted and cannot be provisioned.
  • 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/{id} 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Offers/{id}?providerInstanceId=string&segment=string' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"