Get Deal Using GET
Get the information of a deal identified by the deal id.
Pre-authorized roles: Deal Administrator, Read Only
Request
URI
GET
https://{api_host}//vcp.vmware.com/api/aggregator/v1/deals/{dealId}
COPY
Path Parameters
string
dealId
Required
Deal Id.
dealId example
630c2f68-xxxx-xxxx-xxxx-61f8245eaca2
Responses
200
OK
Returns Deal of type(s) application/json
{
"contract": {
"contractNumber": 111111,
"contractReferenceNumber": "AMER1111RENTAL",
"currency": "USD"
},
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca2",
"dealNumber": 20001,
"productSKU": "VMW-VSANV2-STD-C",
"productCategory": "Cloud Infrastructure and Management",
"projectedDealValue": 10000,
"status": "CLOSED_WON",
"extendStatus": "NOT_EXTENDED",
"creationDate": "2022-08-03",
"expirationDate": "2023-01-30",
"expectedCloseDate": "2022-10-23",
"closeDate": "2022-11-01",
"fiscalQuarter": "Q3FY2022",
"serviceProviderContact": "jamessmith@spcorp.com",
"aggregatorSalesContactLead": "bobjohnson@aggcorp.com",
"aggregatorManager": "mariawilliams@vmware.com",
"promotionEvent": "SALES_CAMPAIGN"
}string
id
Optional
id
string
dealNumber
Optional
Deal number
string
productSKU
Optional
productSKU
string
productCategory
Optional
Product category
number
projectedDealValue
Optional
Projected deal value
string
status
Optional
Enum: [DRAFT, PENDING_APPROVE, PENDING_REVISION, OPPORTUNITY, CLOSED_WON, CLOSED_LOST, CLOSED_EXPIRED, CLOSED_DENIED, CLOSED_ABANDONED, CLOSED_CONTRACT_TERMINATED, CLOSED_AGGREGATOR_SWAPPED, CLOSED_AS_LOST_PRODUCT_ACCESS]
string
extendStatus
Optional
Extend status
Possible values are : NOT_EXTENDED, PENDING_EXTENSION, EXTENSION_DENIED, EXTENDED,
string As date As date
creationDate
Optional
creation date
string As date As date
expirationDate
Optional
Expiration date
string As date As date
expectedCloseDate
Optional
Expected close date
string As date As date
closeDate
Optional
Close date
string
fiscalQuarter
Optional
The fiscal quarter of VMware
string
serviceProviderContact
Optional
Cloud services provider contact
string
aggregatorSalesContactLead
Optional
Aggregator sales contact lead
string
aggregatorManager
Optional
Aggregator manager
string
promotionEvent
Optional
Promotion event. Enums: [Sales Campaign, Webinar, Training, Partner Meeting, Other]
400
Bad Request
Operation doesn't return any data structure
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Deal not found
Operation doesn't return any data structure