Retrieve an offer

GET /v1/Offers/{id}

Retrieves an offer with the specified GUID identifier.

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.

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

GET /v1/Offers/{id} 
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Offers/{id}?providerInstanceId=string&segment=string \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "description": "string",
  "imageUrl": "string",
  "offerType": {
    "name": "string"
  },
  "billingType": {
    "name": "string"
  },
  "prices": [
    {
      "termDuration": {
        "name": "string"
      },
      "segment": {
        "name": "string"
      },
      "region": {
        "value": "string"
      },
      "billingFrequencies": [
        {
          "name": "string"
        }
      ],
      "costPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "revenuePrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "erpPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      }
    }
  ],
  "providerName": "string",
  "providerInstanceId": "string",
  "isAddon": true,
  "minQuantity": 42,
  "maxQuantity": 42,
  "hasPreRequisites": true,
  "preRequisites": [
    "string"
  ],
  "isTrial": true,
  "providerOfferId": "string",
  "isDeleted": true
}
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "description": "string",
  "imageUrl": "string",
  "offerType": {
    "name": "string"
  },
  "billingType": {
    "name": "string"
  },
  "prices": [
    {
      "termDuration": {
        "name": "string"
      },
      "segment": {
        "name": "string"
      },
      "region": {
        "value": "string"
      },
      "billingFrequencies": [
        {
          "name": "string"
        }
      ],
      "costPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "revenuePrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      },
      "erpPrice": {
        "value": 42.0,
        "currency": {
          "name": "string"
        }
      }
    }
  ],
  "providerName": "string",
  "providerInstanceId": "string",
  "isAddon": true,
  "minQuantity": 42,
  "maxQuantity": 42,
  "hasPreRequisites": true,
  "preRequisites": [
    "string"
  ],
  "isTrial": true,
  "providerOfferId": "string",
  "isDeleted": true
}
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 (404) 
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (404) 
{
  "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"
      ]
    }
  ]
}