取得促銷

發行項
01/10/2024

適用於

合作夥伴中心

適當的角色

全域管理員
系統管理代理人

注意

授權型服務的新商務體驗包含許多新功能，且適用於所有雲端解決方案提供者（CSP）。如需詳細資訊，請參閱新的商務體驗概觀。

合作夥伴可以取得特定市場（國家/地區）和區段的有效新商務促銷清單。此方法會根據可用的促銷開始和結束日期，傳回可用的目前促銷。

必要條件

認證，如合作夥伴中心驗證所述。此案例支援使用獨立應用程式和 App+使用者認證進行驗證。
區段代表已啟用促銷的客戶類型。目前僅支援商業。
國家/地區代表客戶國家/地區促銷可供使用。國家/地區是以兩個字元的國家/地區代碼表示。

REST 要求

[GET] /v1/productpromotions？country={country-code}&segment={segment}

要求語法

方法	要求 URI
GET	{baseURL}/v1/productpromotions？country={country-code}&segment={segment} HTTP/1.1

URI 參數

使用下列查詢參數可傳回可用的促銷。

名稱	類型	必要	描述
段	string	Y	字串，決定指定區段可用的促銷。
country	string	Y	兩個字母國家/地區代碼，決定哪些客戶國家/地區促銷可供使用。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

無

要求範例

GET https://api.partnercenter.microsoft.com/v1/productpromotions?country=US&segment=commercial HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
X-Locale: en-US

REST 回應

如果成功，這個方法會傳回促銷清單。

回應成功和錯誤碼

每個回應都有一個 HTTP 狀態代碼，指出成功或失敗，以及更多偵錯資訊。使用網路追蹤工具來讀取此程式代碼、錯誤類型等等參數。如需完整清單，請參閱錯誤碼。

回應範例

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT


{
    "totalCount": 2,
    "items": [
        {
            "id": "39NFJQT1PJQB:0001:39NFJQT1Q5KN",
            "name": "Visio Plan 1",
            "description": "Visio Plan 1",
            "startDate": "2021-09-23T00:00:00+00:00",
            "endDate": "2021-10-14T23:59:59+00:00",
            "properties": {
                "isAutoApplicable": true
            },
            "requiredProducts": [
                {
                    "productId": "CFQ7TTC0HD33",
                    "skuId": "0003",
                    "term": {
                        "duration": "P1Y",
                        "billingCycle": "Annual"
                    },
                    "pricingPolicies": [
                        {
                            "policyType": "PercentDiscount",
                            "value": "0.05"
                        }
                    ]
                }
            ]
        },
        {
            "id": "39NFJQT1PJQC:0001:39NFJQT1Q5KM",
            "name": "Vision Plan 1",
            "description": "Vision Plan 1",
            "startDate": "2021-09-23T00:00:00+00:00",
            "endDate": "2021-10-14T23:59:59+00:00",
            "properties": {
                "isAutoApplicable": true
            },
            "requiredProducts": [
                {
                    "productId": "CFQ7TTC0HD33",
                    "skuId": "0003",
                    "term": {
                        "duration": "P1Y",
                        "billingCycle": "Monthly"
                    },
                    "pricingPolicies": [
                        {
                            "policyType": "PercentDiscount",
                            "value": "0.167"
                        }
                    ]
                }
            ]
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

共用方式為