[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Get Offers

Description

Retrieves details about the pricing and discounting of a specified product offering.

Request

Request

URL

URL


post
https://console.navigator.vmware.com/cphub/api/catalog/v1/orgs/{orgId}/offers
Copy

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


Query Parameters

Query Parameters

integer
pageLimit Optional

Max number of records in single page response, default is 50

pageLimit example
50

integer
pageStart Optional

Page start number for pagination, default is 0. This represents the start index from which the results fetched from DB should be displayed.

pageStart example
0

Request Body

Request Body

OffersRequest of mimetype application/json Optional
{
	"productFamily": "VSPHERE-SAAS"
}
string
productFamily Required

Defines the Family code for product.


billingFrequency Optional

Billing frequency, for ONDEMAND is always MONTHLY in arrears. All values are only applicable for OfferType : COMMIT.

Possible values are: PREPAIDMONTHLYANNUAL


integer
billingTerm Optional

Offer term, applicable only for COMMIT


string
country Optional

Country of availability for product.


string
currency Optional

Currency for billing of product.


string
customerSegment Optional

Type of license for product.


offerCategory Optional

The category of the offer.\n eg. PRIMARY, ADDON, ONETIME

Possible values are: PRIMARYADDONONETIMEONDEMAND


offerType Optional

Defines the values of the offer type attribute

Possible values are: ONDEMANDCOMMIT


string
billingTermUom Optional

Unit of Measure used for billing cycle term. Applicable only for COMMIT

Possible values are: MONTHS


string
region Optional

Region of availability for product.


string
sku Optional

Defines the proliferated ID for product.


string
supportLevel Optional

Level of Support provided for product.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns OffersResponse of type application/json

OK - The server successfully received and processed the request

{
	"_links": {
		"next": {
			"href": "/cphub/api/catalog/v1/orgs/0bd47570-8366-457b-90ea-ce85e6b5750a/offers?pageStart=11&pageLimit=10"
		},
		"self": {
			"href": "/cphub/api/catalog/v1/orgs/0bd47570-8366-457b-90ea-ce85e6b5750a/offers?pageStart=1&pageLimit=10"
		}
	},
	"data": [
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "12",
			"currency": "USD",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "105.54"
				},
				"netPrices": [
					{
						"amount": "89.71",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "15.83",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-12MPVSNACS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "12",
			"currency": "GBP",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "78.0"
				},
				"netPrices": [
					{
						"amount": "66.3",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "11.7",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-12MPVSNACS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "USD",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "327.75"
				},
				"netPrices": [
					{
						"amount": "278.59",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "49.16",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPCS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "GBP",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "242.25"
				},
				"netPrices": [
					{
						"amount": "205.91",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "36.34",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPCS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "EUR",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "285.0"
				},
				"netPrices": [
					{
						"amount": "242.25",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "42.75",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPCS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "GBP",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "219.3"
				},
				"netPrices": [
					{
						"amount": "186.4",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "32.9",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPVNSACS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "EUR",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "258.0"
				},
				"netPrices": [
					{
						"amount": "219.3",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "38.7",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPVNSACS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "USD",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "296.7"
				},
				"netPrices": [
					{
						"amount": "252.19",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "44.51",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPVNSACS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "GBP",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "205.91"
				},
				"netPrices": [
					{
						"amount": "175.02",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "30.89",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPVSNACS"
		},
		{
			"baseSku": "VSAVADV_TS",
			"billingFrequency": "PREPAID",
			"billingTerm": "36",
			"currency": "USD",
			"customerSegment": "COMMERCIAL",
			"eoaDate": "4712-12-31T00:00:00Z",
			"gaDate": "2022-12-12T00:00:00Z",
			"name": "VMware vSAN+ ADV - Per Core",
			"price": {
				"listPrice": {
					"amount": "278.58"
				},
				"netPrices": [
					{
						"amount": "236.79",
						"discounts": [
							{
								"effectiveDate": "2022-11-28T00:00:00Z",
								"percentage": "15.0",
								"savings": "41.79",
								"type": "CHANNEL"
							}
						],
						"netPriceType": "CHANNEL"
					}
				]
			},
			"productFamily": "VSPHERE-SAAS",
			"region": "EMEA",
			"sku": "VSAVADV-TSPC-36MPVSNACS"
		}
	],
	"totalSize": 150
}
object
_links Optional

Links details to pagenated result responses


array of Offer
data Optional

Response Model for List of Offers


integer
totalSize Optional

Total size of results found in list of offers.

Errors

Errors

ErrorResponse
400

Bad Request - The request is either incomplete or incorrect


ErrorResponse
401

Unauthorized - The request requires user authentication


ErrorResponse
403

Forbidden - User does not have permission for this operation


ErrorResponse
404

Not Found - The requested resource does not exist


ErrorResponse
500

Internal Server Error - Please contact support

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"baseSku":"VSAVSN_TS","billingFrequency":"PREPAID","billingTerm":12,"billingTermUom":"MONTHS","country":"GB","currency":"EUR","customerSegment":"ACADEMIC","offerCategory":"PRIMARY","offerType":"COMMIT","productFamily":"VSPHERE-SAAS","region":"EMEA","sku":"VSAVADV-TSPC-12MP00CS","supportLevel":"PRODUCTIONSUPPORT"}' https://console.navigator.vmware.com/cphub/api/catalog/v1/orgs/{orgId}/offers
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-internal: false


[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Feedback

Was this page helpful?