為客戶建立多方私人供應專案
ISV(發起者)和共同作業夥伴(賣方)應該使用相同的 API 呼叫集來為客戶建立私人供應專案。 以下是預期的流程。
- ISV 會建立供應專案,並提交以銷售合作夥伴可見度
- ISV 通知銷售合作夥伴(透過電子郵件或其他方法)供應項目現在可供銷售合作夥伴編輯
- 銷售合作夥伴檢閱並完成設定私人供應專案,並提交以取得最終客戶可見度
以下是用來建立供應專案的方法。
Request
POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-07-01
要求標頭
標題 | 類型 | 描述 |
---|---|---|
授權 | String | 必要。 表單中的 Bearer <token> Microsoft Entra 存取令牌。 |
選擇性:clientID
要求參數
$version - 必要。 這是要求中使用的架構版本。
要求本文
下列選項會反映為客戶建立多方私人供應專案時,合作夥伴中心的選項。 這些選項是由下列 offerPricingType 值所定義:
offerPricingType 值 | 合作夥伴中心私人供應專案建立選項對等 |
---|---|
editExistingOfferPricingOnly | 自定義現有公用供應專案和方案的定價 - 使用此選項來為所有可交易的供應項目類型建立私人供應專案:SaaS、Azure 虛擬機器 和 Azure 應用程式。 您可以透過絕對定價或百分比折扣來自定義合作夥伴定價。 |
saasNewCustomizedPlans | 自定義 SaaS 供應 項目的定價、計量數量和使用者限制 - 使用此選項,藉由自定義您的絕對合作夥伴價格、計量維度數量和使用者限制,為 SaaS 方案建立私人供應專案。 |
vmSoftwareReservations | 自定義 VM 軟體保留供應 項目的定價和特定數量 - 使用此選項來建立多方私人供應專案來銷售 VM 軟體保留(1 年或 3 年),並自定義絕對合作夥伴價格、vCPU 大小、數量、持續時間和付款排程。 |
針對上述三種定價類型選項,方案特定的資源需求可能會有所不同。 如需詳細資訊,請參閱下表:
資源名稱 | editExistingOfferPricingOnly | saasNewCustomizedPlans | vmSoftwareReservations |
---|---|---|---|
定價。計劃 | 將此設定為要求主體中要設定之公用計劃的計劃標識碼 | 不適用 | 不適用 |
pricing.basePlan | 不適用 | 將此設定為要求主體中要設定之公用計劃的計劃標識碼 | 將此設定為要求主體中要設定之公用計劃的計劃標識碼 |
pricing.newPlanDetails.name | 不適用 | 將此設定為將在要求本文中向客戶顯示的新方案名稱 | 不適用於要求本文,系統會在完成時產生並可在作業的回應中取得。 |
pricing.newPlanDetails.description | 不適用 | 將此設定為要求本文中新方案要向客戶顯示的描述 | 不適用於要求本文,系統會在完成時產生並可在作業的回應中取得。 |
customerContractRenewal 值 | 描述 |
---|---|
true | 私人供應項目是現有客戶合約的續約。 50% 折扣的代理程式費用適用於您的私人供應專案以進行客戶續約 |
false | 私人供應專案 不是 現有客戶合約的續約。 您的標準代理程式費用適用。 |
要求本文會根據呼叫端角色而有所不同。 使用 privateOfferType 來區分 ISV 來電者與銷售合作夥伴來電者。
呼叫端角色 | privateOfferType 值 |
---|---|
ISV (發源者) | multipartyPromotionOriginator |
銷售合作夥伴 (賣方) | multipartyPromotionChannelPartner |
要求本文範例
ISV 提供的範例要求本文,以使用折扣定價來建立供應專案,僅自定義現有公用方案的定價
ISV(發源者)必須提供供應專案的所有基本詳細數據。 這必須包含名稱。
{
"$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01",
"resources": [
{
"$schema": "https://schema.mp.microsoft.com/schema/private-offer/2024-09-30",
"resourceName": "privateOffer",
"name": "privateOffercustomer1705",
"state": "live",
"privateOfferType": "multipartyPromotionOriginator",
"offerPricingType": "editExistingOfferPricingOnly",
"customerContractRenewal": false,
"variableStartDate": true,
"end": "2022-01-31",
"acceptBy": "2022-02-28",
"termsAndConditionsDocs": [
{
"sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
"fileName": "Test1.pdf",
"customerFacingDocumentName": "Test1 T&C"
} ],
"notificationContacts": [ "amy@contoso.com" ],
"beneficiaries": [
{ "id": "xxxxxx-2163-5eea-ae4e-d6e88627c26b:6ea018a9-da9d-4eae-8610-22b51ebe260b_2019-05-31", "description": "Top First Customer"}
],
"partners": [
{
"id": "12345678",
"partnerName": "Market Place Test",
"location": "United States"
}
],
"pricing": [
{ "product": "product/34771906-9711-4196-9f60-4af380fd5042", "plan":"plan/123456","discountType": "percentage", "discountPercentage": 5 }
],
"notes": "ISV 123"
}
]
}
僅使用絕對定價自定義現有公用方案定價的範例要求本文
如果您使用絕對定價而不是以百分比為基礎的折扣,您可以在定義絕對定價的多方私人供應項目資源上方建立新的資源,然後在設定架構的資源清單中,將新建立的資源納入為另一個物件。
使用此方法可取得現有公用方案的定價資源、編輯價格,然後使用您供應專案的編輯資源。
GET https://graph.microsoft.com/rp/product-ingestion/price-and-availability-private-offer-plan/{productId}?plan={planId}&$version=2023-07-15
範例絕對定價資源
{
"$schema": "https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2023-07-15",
"resourceName": "newSimpleAbsolutePricing",
"product": "product/7ba807c8-386a-4efe-80f1-b97bf8a554f8",
"plan": "plan/987654",
"offerPricingType": "editExistingOfferPricingOnly",
"pricing": {
"recurrentPrice": {
"priceInputOption": "usd",
"prices": [
{
"pricePerPaymentInUsd": 1,
"billingTerm": {
"type": "month",
"value": 1
}
},
{
"pricePerPaymentInUsd": 2,
"paymentOption": {
"type": "month",
"value": 1
},
"billingTerm": {
"type": "year",
"value": 1
}
}
]
},
"customMeters": {
"priceInputOption": "usd",
"meters": {
"meter1": {
"pricePerPaymentInUsd": 1
}
}
}
}
}
在定價模組中包含該資源作為物件
[
{
"product": "product/34771906-9711-4196-9f60-4af380fd5042",
"plan": "plan/123456",
"discountType": "percentage",
"discountPercentage": 5
},
{
"product": "product/7ba807c8-386a-4efe-80f1-b97bf8a554f8",
"plan": "plan/987654",
"discountType": "absolute",
"priceDetails": {
"resourceName": "newSimpleAbsolutePricing"
}
}
]
使用絕對定價來自定義 SaaS 供應項目的定價、計量數量和使用者限制的範例要求主體
使用下列方法來建立私人供應項目的絕對價格和可用性資源。
GET https://graph.microsoft.com/rp/product-ingestion/price-and-availability-private-offer-plan/{productId}?plan={planId}&$version=2023-07-15
自訂價格和計量數量之一般費率 SaaS 供應專案的範例絕對定價資源
{
"$schema": "https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2023-07-15",
"product": "product/7ba807c8-386a-4efe-80f1-b97bf8a554f8",
"resourceName": "newSaaSPlanAbsolutePricing",
"plan": "plan/123456",
"offerPricingType": "saasNewCustomizedPlans",
"pricing": {
"recurrentPrice": {
"recurrentPriceMode": "flatRate",
"priceInputOption": "usd",
"prices": [
{
"billingTerm": {
"type": "month",
"value": 1
},
"paymentOption": {
"type": "month",
"value": 1
},
"pricePerPaymentInUsd": 0.1
},
{
"billingTerm": {
"type": "year",
"value": 1
},
"paymentOption": {
"type": "month",
"value": 1
},
"pricePerPaymentInUsd": 0.12
}
]
},
"customMeters": {
"priceInputOption": "usd",
"meters": {
"meter1": {
"includedQuantities": [
{
"billingTerm": {
"type": "month",
"value": 1
},
"quantity": 10.0,
"isInfinite": false
},
{
"billingTerm": {
"type": "year",
"value": 1
},
"quantity": 15.0,
"isInfinite": false
}
]
},
"meter2": {
"includedQuantities": [
{
"billingTerm": {
"type": "month",
"value": 1
},
"isInfinite": true
},
{
"billingTerm": {
"type": "year",
"value": 1
},
"isInfinite": true
}
]
}
}
}
}
}
每個使用者 SaaS 供應項目的絕對定價資源範例,可自定義價格和使用者限制
{
"$schema": "https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2023-07-15",
"resourceName": "newSaaSPlanAbsolutePricing",
"product": "product/7ba807c8-386a-4efe-80f1-b97bf8a554f8",
"plan": "plan/123456",
"offerPricingType": "saasNewCustomizedPlans",
"pricing": {
"recurrentPrice": {
"recurrentPriceMode": "perUser",
"priceInputOption": "usd",
"userLimits": {
"min": 20,
"max": 100
},
"prices": [
{
"billingTerm": {
"type": "month",
"value": 1
},
"paymentOption": {
"type": "month",
"value": 1
},
"pricePerPaymentInUsd": 0.01
},
{
"billingTerm": {
"type": "year",
"value": 1
},
"paymentOption": {
"type": "year",
"value": 1
},
"pricePerPaymentInUsd": 0.02
}
]
}
}
}
在定價模組中包含該資源作為物件
{
"$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01",
"resources": [
{
"$schema": "https://schema.mp.microsoft.com/schema/private-offer/2024-09-30",
"name": "privateOffercustomer1705",
"state": "live",
"privateOfferType": "multipartyPromotionOriginator",
"offerPricingType": "newSimpleAbsolutePricing",
"customerContractRenewal": false,
"variableStartDate": true,
"end": "2022-01-31",
"acceptBy": "2022-02-28",
"partners": [
{
"id": "12345678",
"partnerName": "Market Place Test",
"location": "United States"
}
],
"termsAndConditionsDocs": [
{
"sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
"fileName": "Test1.pdf",
"customerFacingDocumentName": "Test1 T&C"
} ],
"notificationContacts": [ "amy@contoso.com" ],
"beneficiaries": [
{ "id": "xxxxxx-2163-5eea-ae4e-d6e88627c26b:6ea018a9-da9d-4eae-8610-22b51ebe260b_2019-05-31", "description": "Top First Customer"}
],
"pricing": [
{
"product": "product/7ba807c8-386a-4efe-80f1-b97bf8a554f8",
"discountType": "absolute",
"priceDetails": {
"resourceName": "newSaaSPlanAbsolutePricing"
}
"basePlan": "plan/123456",
"newPlanDetails": {
"name": "newPlanName",
"description": "newPlanDescription"
}
],
"notes": "ISV 123"
}
]
}
使用絕對定價來自定義 VM 軟體保留供應項目的定價和特定數量的範例要求主體
使用下列方法來建立供應項目的絕對價格和可用性資源。
GET https://graph.microsoft.com/rp/product-ingestion/price-and-availability-private-offer-plan/{productId}?plan={planId}&$version=2023-07-15
自訂價格和數量之 VM 供應專案的範例絕對定價資源
{
"$schema": "https://schema.mp.microsoft.com/schema/price-and-availability-private-offer-plan/2023-07-15",
"resourceName": "newVMSRAbsolutePricing",
"product": "product/7ba807c8-386a-4efe-80f1-b97bf8a554f8",
"offerPricingType": "vmSoftwareReservations",
"plan": "plan/987654",
"softwareReservation": {
"reservationDuration": {
"type": "year",
"value": 1
},
"paymentSchedule": {
"type": "year",
"value": 1
},
"vmPrices": {
"36Core": {
"quantity": 4.0,
"unitPricePerPaymentPeriodInUsd": 0.04
}
}
}
}
在定價模組中包含該資源作為物件
{
"$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01",
"resources": [
{
"$schema": "https://schema.mp.microsoft.com/schema/private-offer/2024-09-30",
"name": "privateOffercustomer1705",
"state": "live",
"privateOfferType": "multipartyPromotionOriginator",
"offerPricingType": "vmSoftwareReservations",
"customerContractRenewal": false,
"variableStartDate": true,
"end": "2022-01-31",
"acceptBy": "2022-02-28",
"partners": [
{
"id": "12345678",
"partnerName": "Market Place Test",
"location": "United States"
}
],
"termsAndConditionsDocs": [
{
"sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
"fileName": "Test1.pdf",
"customerFacingDocumentName": "Test1 T&C"
} ],
"notificationContacts": [ "amy@contoso.com" ],
"beneficiaries": [
{ "id": "xxxxxx-2163-5eea-ae4e-d6e88627c26b:6ea018a9-da9d-4eae-8610-22b51ebe260b_2019-05-31", "description": "Top First Customer"}
],
"pricing": [
{
"product": "product/7ba807c8-386a-4efe-80f1-b97bf8a554f8",
"discountType": "absolute",
"priceDetails": {
"resourceName": "newVMSRAbsolutePricing"
}
"basePlan": "plan/987654"
],
"notes": "ISV 123"
}
]
}
合作夥伴完成供應專案建立的範例要求
銷售合作夥伴應使用ISV所提供的多方私人供應專案標識碼來設定客戶調整 % (標記)、銷售合作夥伴自定義合約、由準備及銷售合作夥伴聯繫人。
下列範例是以使用供應項目標識符擷取供應專案詳細數據時傳回的回應本文為基礎。
{
"$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01",
"resources": [
{
"$schema": "https://schema.mp.microsoft.com/schema/private-offer/2024-09-30",
"resourceName": "privateOffer",
"name": "privateOffercustomer1705",
"state": "live",
"privateOfferType": "multipartyPromotionChannelPartner",
"offerPricingType": "editExistingOfferPricingOnly",
"variableStartDate": true,
"end": "2022-01-31",
"acceptBy": "2022-02-28",
"preparedBy": "tester@microsoft.com",
"originatorTermsAndConditionsDocs": [
{
"sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
"fileName": "Test1.pdf",
"customerFacingDocumentName": "Test1 T&C"
} ],
"termsAndConditionsDocs": [
{
"sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
"fileName": "Test1.pdf",
"customerFacingDocumentName": "Test1 T&C"
} ],
"notificationContacts": [ "amy@contoso.com" ],
"beneficiaries": [
{ "id": "xxxxxx-2163-5eea-ae4e-d6e88627c26b:6ea018a9-da9d-4eae-8610-22b51ebe260b_2019-05-31", "description": "Top First Customer"}
],
"partners": [
{
"id": "12345678",
"partnerName": "Market Place Test",
"location": "United States"
}
],
"originatorPricing": [
{
"product": "product/34771906-9711-4196-9f60-4af380fd5042",
"plan":"plan/123456",
"discountType": "percentage",
"discountPercentage": 5
"markupPercentage": 1.0
}
],
"lastModified": "2023-01-19",
"eTag": "\"7f020249-0000-0800-0000-63c9b4ca0000\"",
}
]
}
上一個範例中的按鍵註標
- 銷售合作夥伴必須提供 preparedBy 屬性。
- ISV 自定義條款和條件是可檢視的,但無法由銷售合作夥伴編輯,它們會擷取在資源 原始程式TermsAndConditionsDocs 中。
- 銷售合作夥伴可以在字詞AndConditionsDocs 資源中上傳自己的自定義字詞和條件。
- 銷售合作夥伴可以新增自己的聯繫人,以在 notificationContacts 資源中收到供應專案的通知。
- 受益者和合作夥伴屬性是可檢視的,但無法由銷售夥伴編輯。
- 定價資源會顯示為原始程式Pricing、markupPercentage 是必要的,而且必須在提交時由銷售夥伴提供,定價資源中的所有其他屬性都是只讀的。
回應
回應包含您稍後可用來輪詢狀態的 jobId :
{
"$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
"jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
"jobStatus": "notStarted",
"jobResult": "pending",
"jobStart": "2021-12-21T21:29:54.9702903Z",
"jobEnd": "0001-01-01",
"errors": []
}
錯誤碼
HTTP 狀態碼 | 描述 |
---|---|
401 | 驗證錯誤:請確定您使用有效的Microsoft Entra 存取令牌。 |
400 | 架構驗證。 請確定您的要求本文遵循正確的架構,並包含所有必要的欄位。 |