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

    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.

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

    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

GET /v1/Offers 
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Offers?Segment=string \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "imageUrl": "string",
      "offerType": {
        "name": "string"
      },
      "billingType": {
        "name": "string"
      },
      "price": {
        "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",
      "isAddon": true,
      "providerOfferId": "string",
      "isDeleted": true,
      "termOfferPrices": [
        {
          "termDuration": {
            "name": "string"
          },
          "billingFrequencies": [
            {
              "name": "string"
            }
          ],
          "costPrice": {
            "value": 42.0,
            "currency": {
              "name": "string"
            }
          },
          "erpPrice": {
            "value": 42.0,
            "currency": {
              "name": "string"
            }
          }
        }
      ],
      "isDisabled": true
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "imageUrl": "string",
      "offerType": {
        "name": "string"
      },
      "billingType": {
        "name": "string"
      },
      "price": {
        "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",
      "isAddon": true,
      "providerOfferId": "string",
      "isDeleted": true,
      "termOfferPrices": [
        {
          "termDuration": {
            "name": "string"
          },
          "billingFrequencies": [
            {
              "name": "string"
            }
          ],
          "costPrice": {
            "value": 42.0,
            "currency": {
              "name": "string"
            }
          },
          "erpPrice": {
            "value": 42.0,
            "currency": {
              "name": "string"
            }
          }
        }
      ],
      "isDisabled": true
    }
  ],
  "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 (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"
      ]
    }
  ]
}